Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Definineer regel voor base URL slash die compatibel is met OData en OpenAPI specification #164

Open
TimvdLippe opened this issue Feb 11, 2025 · 0 comments · May be fixed by #165
Open

Definineer regel voor base URL slash die compatibel is met OData en OpenAPI specification #164

TimvdLippe opened this issue Feb 11, 2025 · 0 comments · May be fixed by #165
Assignees
Milestone

Comments

@TimvdLippe
Copy link
Contributor

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.

@TimvdLippe TimvdLippe self-assigned this Feb 11, 2025
@TimvdLippe TimvdLippe added this to the ADR 2.1 milestone Feb 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant