Skip to content

Commit e2dd759

Browse files
committed
docs: uncomment the optional-key examples in endpoint templates
A commented-out "# key: value" line reads as disabled sample code, not as a real optional field -- confusing for the actual key readers are meant to add. Keep the explanatory prose above each as comments, but show the key:value line itself live: datagouv_uid, sync_with_datagouv (entreprise template only, no equivalent doc block in the particulier one) and datagouv_summary in both templates. Claude-Session: https://claude.ai/code/session_01FraV2QQbbbGpUQnUiL8etP
1 parent c22b03c commit e2dd759

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

commons/endpoints/template.entreprise.yml.example

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,18 @@ fiche:
33
# L'UID sert à identifier cette entrée de manière unique, et est utilisé pour l'URL de la fiche métier
44
- uid: 'provider/resource'
55
# Optionnel. Id de la fiche dataservice correspondante sur data.gouv.fr.
6-
# datagouv_uid: '...'
6+
datagouv_uid: '...'
77
# Optionnel. À renseigner uniquement quand plusieurs fiches (couple dépréciée/actuelle,
88
# regroupements INSEE Sirene/DJEPVA...) partagent le même datagouv_uid : une seule fiche
99
# doit piloter le sync vers data.gouv.fr (site/app/services/datagouv/), les autres passent
1010
# sync_with_datagouv: false pour ne pas se marcher dessus (create/update/delete concurrents
1111
# sur la même fiche distante).
12-
# sync_with_datagouv: false
12+
sync_with_datagouv: false
1313
# Optionnel. Résumé en une phrase de ce que permet d'obtenir cette API, utilisé
1414
# tel quel dans la description de la fiche data.gouv.fr (site/app/services/datagouv/).
1515
# À défaut, ce résumé est dérivé automatiquement (et plus grossièrement) de la
1616
# description du endpoint dans le swagger.
17-
# datagouv_summary: "Liste des bénéficiaires effectifs d'une unité légale."
17+
datagouv_summary: "Liste des bénéficiaires effectifs d'une unité légale."
1818
# Optionnel. À renseigner uniquement si cette API fait partie du Socle de base DLNUF.
1919
# Omettre la clé si l'API n'en fait pas partie.
2020
socle_de_base:

commons/endpoints/template.particulier.yml.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ fiche:
88
# tel quel dans la description de la fiche data.gouv.fr (site/app/services/datagouv/).
99
# À défaut, ce résumé est dérivé automatiquement (et plus grossièrement) de la
1010
# description du endpoint dans le swagger.
11-
# datagouv_summary: "Situation d'un individu vis-à-vis de France Travail."
11+
datagouv_summary: "Situation d'un individu vis-à-vis de France Travail."
1212
# Ne peut être que public ou protected
1313
opening: public
1414
# Le(s) paramètre(s) utilisé pour appeller l'endpoint

0 commit comments

Comments
 (0)