Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better documentation in endpoint template files #1796

Merged
merged 1 commit into from
Feb 11, 2025
Merged

Better documentation in endpoint template files #1796

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions config/endpoints/template.entreprise.yml.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
10 changes: 8 additions & 2 deletions config/endpoints/template.particulier.yml.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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')
Expand Down