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.