From 84f3700bc96b8c8e676da7dcca59d513c2bfe111 Mon Sep 17 00:00:00 2001 From: Samuelfaure Date: Tue, 11 Feb 2025 09:43:42 +0100 Subject: [PATCH] Better documentation in endpoint template files --- config/endpoints/template.entreprise.yml.example | 8 ++++++-- config/endpoints/template.particulier.yml.example | 10 ++++++++-- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/config/endpoints/template.entreprise.yml.example b/config/endpoints/template.entreprise.yml.example index e2735df8c..863173764 100644 --- a/config/endpoints/template.entreprise.yml.example +++ b/config/endpoints/template.entreprise.yml.example @@ -1,9 +1,13 @@ --- # L'UID sert à identifier cette entrée de manière unique, et est utilisé pour l'URL de la fiche métier - uid: 'provider/resource' - # Ce chemin doit correspondre au path dans le fichier swagger - path: '/v3/provider/resource/{siren}' + # Path: doit correspondre au path dans le swagger + # Exemple pour Attestation de vigilance + # Voir le swagger ici https://github.com/etalab/siade/blob/272aa40577802afe59ebc5f3cded39d2c25107ae/swagger/openapi-entreprise.yaml#L85 + # Le path est '/v3/urssaf/unites_legales/{siren}/attestation_vigilance' (copier ligne 85) + path: '/v3/urssaf/unites_legales/{siren}/attestation_vigilance' # Position au sein de l'index + # Ce chiffre détermine l'ordre d'affichage dans le catalogue : La fiche avec position 1 sera avant la fiche 2 position: 501 # la clef alert est optionnelle alert: diff --git a/config/endpoints/template.particulier.yml.example b/config/endpoints/template.particulier.yml.example index 865f2cdcc..c100f2a89 100644 --- a/config/endpoints/template.particulier.yml.example +++ b/config/endpoints/template.particulier.yml.example @@ -12,9 +12,15 @@ # Paramètres d'appel, habituellement 'Identité pivot', 'FranceConnect' parameters: - Identité pivot - # Doit correspondre au path dans le swagger - path: '/api/v2/situations-pole-emploi' + # Path: doit correspondre au path dans le swagger + # Exemple pour Paiements Pole Emploi en v2 + # Voir le swagger ici : https://github.com/etalab/siade/blob/272aa40577802afe59ebc5f3cded39d2c25107ae/swagger/openapi-particulierv2.yaml#L2272 + # Le path est '/api/v2/paiements-pole-emploi' (copier ligne 2272) + # Swagger Particulier v2 ici : https://github.com/etalab/siade/blob/develop/swagger/openapi-particulierv2.yaml + # Swagger Particulier v3 ici : https://github.com/etalab/siade/blob/develop/swagger/openapi-particulier.yaml + path: '/api/v2/paiements-pole-emploi' # Position au sein de l'index + # Ce chiffre détermine l'ordre d'affichage dans le catalogue : La fiche avec position 1 sera avant la fiche 2 position: 200 # Facultatif: dans le cas où une nouvelle version est disponible; # L'ancienne version doit avoir la clef 'old_endpoint_uids' avec la valeur de l'UID actuel (ici, 'pole_emploi/situation')