You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Om ervoor te zorgen dat we zowel de OData specificatie kunnen supporten (deze staat op dit moment niet op de PTOLU-lijst) en compatibel zijn met de OpenAPI specification, willen we een special-case definieren voor de "root resource". Deze "root resource" is een resource die een empty path heeft: in het geval van https://spec.openapis.org/oas/v3.0.3.html#patterned-fields is het stukje {path} dus een empty string. (Zie ook Geonovum/KP-APIs#632 (comment))
Hiervoor kunnen we definieren dat in het geval een OData API de openapi.{json,yaml} specificatie wordt gereturned. Als alternatief moet er een 200 OK landingspagina zijn met wat informatie. Dit is vrij in te vullen wat die documentatie mag zijn, zou bijvoorbeeld ook enkel kunnen doorlinken naar de canonical link voor documentatie omtrent de API.
The text was updated successfully, but these errors were encountered:
Uit het kennisplatform zijn er enkele vergelijkbare requests om een base URL te definieren voor een service:
Geonovum/KP-APIs#514
Geonovum/KP-APIs#530
Geonovum/KP-APIs#604
Geonovum/KP-APIs#624
Om ervoor te zorgen dat we zowel de OData specificatie kunnen supporten (deze staat op dit moment niet op de PTOLU-lijst) en compatibel zijn met de OpenAPI specification, willen we een special-case definieren voor de "root resource". Deze "root resource" is een resource die een empty path heeft: in het geval van https://spec.openapis.org/oas/v3.0.3.html#patterned-fields is het stukje
{path}
dus een empty string. (Zie ook Geonovum/KP-APIs#632 (comment))Hiervoor kunnen we definieren dat in het geval een OData API de
openapi.{json,yaml}
specificatie wordt gereturned. Als alternatief moet er een 200 OK landingspagina zijn met wat informatie. Dit is vrij in te vullen wat die documentatie mag zijn, zou bijvoorbeeld ook enkel kunnen doorlinken naar de canonical link voor documentatie omtrent de API.The text was updated successfully, but these errors were encountered: