Skip to content

Commit 59333a9

Browse files
committed
docs: uncomment the datagouv_summary example key in endpoint templates
A commented-out "# datagouv_summary: ..." 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 lines above it as comments, but show the key:value line itself live. Claude-Session: https://claude.ai/code/session_01FraV2QQbbbGpUQnUiL8etP
1 parent c22b03c commit 59333a9

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

commons/endpoints/template.entreprise.yml.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ fiche:
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)