Lister les vues disponibles
Lister les vues disponibles
La commande views list permet de récupérer et d’afficher les vues disponibles depuis l’API.
Elle permet d’identifier les vues existantes pouvant être consultées, installées ou réutilisées dans un projet OIP.
Utilisation
Objectif de la commande
Cette commande interroge l’API afin de retourner la liste des vues disponibles.
Elle est utile pour :
- consulter les vues disponibles dans le registre ;
- identifier les vues installables dans un projet ;
- vérifier l’existence d’une vue avant son installation ;
- obtenir une première vision du catalogue de vues accessible.
Résultat de la commande
La commande affiche la liste des vues disponibles.
Selon les informations exposées par l’API, le résultat peut notamment contenir :
- l’identifiant de la vue ;
- son nom ;
- sa description ;
- ses tags ;
- ses versions disponibles ;
- les informations utiles à son installation.
Exemple
Remarques
La commande nécessite un accès réseau à l’OIP API.
Les variables d’environnement nécessaires à l’authentification doivent être correctement renseignées, notamment OIP_TOOLS_CLIENT_SECRET.
Si aucune vue n’est retournée, vérifiez l’accès à l’API ainsi que la configuration d’authentification.
Rechercher une vue
La commande views search permet de rechercher des vues selon différents critères, comme le nom ou les tags.
Elle est utile pour filtrer le catalogue des vues disponibles et identifier rapidement une vue correspondant à un besoin fonctionnel ou technique.
Utilisation
Options
Option | Description |
|---|---|
--name <nom> | Filtre les vues selon leur nom. |
--tag <tag...> | Filtre les vues selon un ou plusieurs tags. |
Modes de recherche
La commande permet de rechercher une vue :
- par nom ;
- par tag ;
- par combinaison d’un nom et d’un ou plusieurs tags.
Exemples
Rechercher une vue par nom :
Rechercher une vue par tag :
Rechercher une vue par nom et par tag :
Résultat de la commande
La commande retourne les vues correspondant aux critères de recherche.
Selon les informations disponibles, le résultat peut notamment contenir :
- l’identifiant de la vue ;
- son nom ;
- sa description ;
- ses tags ;
- ses versions disponibles.
Remarques
La commande nécessite un accès réseau à l’OIP API.
Si aucun résultat n’est retourné, vérifiez les critères utilisés ou consultez la liste complète des vues avec la commande suivante :
Uploader une vue
La commande views up permet d’uploader une vue de manière interactive.
Elle est destinée aux équipes qui souhaitent publier ou mettre à jour une vue afin de la rendre disponible dans le registre des vues OIP.
Utilisation
Fonctionnement général
La commande fonctionne en mode interactif.
Elle guide l’utilisateur à travers plusieurs prompts afin de collecter les informations nécessaires à la publication de la vue.
Les informations demandées peuvent notamment concerner :
- le nom de la vue ;
- l’identifiant de la vue ;
- la description ;
- les tags associés ;
- le nom alternatif du module oip-core, si nécessaire.
Traitements réalisés
Lors de l’upload, la commande analyse la vue et prépare les éléments nécessaires à sa publication.
Elle peut notamment :
- analyser les imports utilisés par la vue ;
- détecter les dépendances locales et externes ;
- identifier les entités utilisées ;
- identifier les propriétés utilisées ;
- identifier les enums utilisées ;
- identifier les features utilisées ;
- générer un fichier manifest.yml ;
- assembler une archive ;
- soumettre la vue à l’API.
Prérequis projet
Avant d’exécuter la commande, le projet doit contenir les éléments nécessaires à l’analyse et à la publication de la vue.
Les éléments attendus sont notamment :
Résultat de la commande
Une fois le traitement terminé, la commande soumet la vue à l’API.
Selon le fonctionnement du registre, elle peut retourner une information de confirmation, une URL ou une référence permettant de suivre la publication.
Exemple
La commande démarre alors le processus interactif d’upload de la vue.
Remarques
La commande nécessite un accès réseau à l’OIP API.
Les variables d’environnement nécessaires à l’authentification doivent être correctement renseignées, notamment OIP_TOOLS_CLIENT_SECRET.
Avant d’uploader une vue, il est recommandé de vérifier :
- la cohérence de la configuration de la vue ;
- la présence des fichiers nécessaires ;
- les dépendances déclarées dans le projet ;
- les features utilisées par la vue ;
- les entités et propriétés réellement exploitées.