search

VNG-Realisatie / API-Kennisbank

Afspraken, werkinstructies, tutorials, enz. voor de co-creatie en het beheer van API standaarden
https://vng-realisatie.github.io/API-Kennisbank/
6 stars 8 forks source link

Namen van parameters die geen onderdeel zijn van de op te vragen resource wijken af #79

Open melsk-r opened 3 years ago

melsk-r commented 3 years ago

Indien een parameter een element betreft dat geen onderdeel van de op te vragen resource is, maar onderdeel van een gerelateerde resource, een subresource of een gegevensgroep, dan wordt de elementnaam voorafgegaan door de betreffende resourcenaam of gegevensgroepnaam en vervolgens twee underscores.

Bijvoorbeeld:

melsk-r commented 3 years ago

JBo: Overnemen HK: Discussie RM: Overnemen MV: Bespreken/toelichten GJ: Bespreken JBi: Toelichting gewenst

RM: Ik zie in in de openapi.yaml van de Zaken API ook properties als 'archiefnominatiein' en 'startdatumgte'. Hier worden ook 2 underscores achter elkaar gebruikt terwijl het volgens mij geen geval van een property uit een andere resource betreft. JBi: Vanwaar de dubbele underscore. Is dat echt nodig, wordt het breder op die manier gedaan? (RM: zie ook #80 ) MV: Ik vraag me ook af of die dubbele underscore nodig is? Is dat bij ZGW niet een gevolg van tooling waarmee de yaml gegenereerd is?