generieke descriptions generiek aanpassen

[melsk-r]

Originally created by CathyDingemanse (kadaster/BRK-bevragen#641):

...zodat deze in alle HC reps identiek zijn.

Denk aan de descriptions van de fields parameter:

Hiermee kun je de inhoud van de resource naar eigen behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven. Als je een niet-bestaande property opgeeft krijg je een 400 Bad Request terug. Als je geen fields parameter opgeeft, krijg je alle properties met een waarde terug.

Acceptatiecriteria

• [ ]
• [ ]

Definition of done

• functionele specificatie
• Open API specificatie
• gegenereerde code
• testgevallen
• referentie-implementatie

[melsk-r]

This comment originally might have been created by someone else.

Fields definiëren we denk ik overal vanuit een $ref naar de Haal-Centraal-Common common.yaml, dus de description daarbij zou overal gelijk moeten zijn. Is het probleem hier dat de description niet in alle HC API's gelijk zijn, of dat de description niet goed is?

[melsk-r]

This comment originally might have been created by someone else.

OK, dan zullen de aanpassingen van mijn review van jouw PR overal doorwerken. Probleem opgelost.

[melsk-r]

This comment originally might have been created by someone else.

In de BRK API wordt nog de description van common.yaml versie 1.0.0 gebruikt. Alle gebruik van common.yaml componenten verwijst nog naar versie 1.0.0.
In versie 1.1.0 is de description vanuit issue #400 gewijzigd in: "Hiermee kun je de inhoud van de resource naar behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven. Bij opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. Wanneer de fields parameter niet is opgegeven, worden alle properties met een waarde teruggegeven. Zie functionele specificaties"

We kunnen gaan verwijzen naar versie 1.1.0, maar dat zou ik dan het liefst voor alle parameters en properties doen die we uit common.yaml gebruiken. Daarvoor moeten we dan wel eerst checken dat dit geen breaking changes oplevert.