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

Definieer nieuwe regel voor publiceren van landing page #165

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

TimvdLippe
Copy link
Contributor

@TimvdLippe TimvdLippe commented Feb 11, 2025

Deze nieuwe regel zorgt ervoor dat consumers de API kunnen vinden en informatie
over de API kunnen lezen. Als deze root resource niet gedefinieerd is (en dus in
bijvoorbeeld een 404 resulteren), kunnen consumers onbewust concluderen dat de
API niet bestaat, terwijl dat wel het geval is.

Tevens lossen we hiermee de ambiguiteit met de OData specificatie op, die aangeeft
dat de service root URL in een slash moet eindigen (en dus beschikbaar moet zijn).
Voor OData APIs moet op deze root resource het OpenAPI specification document
gepubliceerd zijn.

Fixes Geonovum/KP-APIs#514
Fixes Geonovum/KP-APIs#530
Fixes Geonovum/KP-APIs#604
Fixes Geonovum/KP-APIs#624

Closes #164

@TimvdLippe TimvdLippe requested a review from sanderke February 11, 2025 10:01
@TimvdLippe TimvdLippe added Scope: Klein Kleine wijzigingen met beperkte scope Status: In bewerking Het voorstel is in bewerking bij de beheerorganisatie. Type: Wijziging Inhoudelijke wijziging op een standaard Overleg: TO-API Te agenderen voor het Technisch Overleg API labels Feb 11, 2025
@TimvdLippe TimvdLippe added this to the ADR 2.1 milestone Feb 26, 2025
@Logius-standaarden Logius-standaarden deleted a comment from github-actions bot Mar 3, 2025
Copy link

github-actions bot commented Mar 3, 2025

@TimvdLippe TimvdLippe added Status: Ter goedkeuring Het voorstel is uitgewerkt en wordt ter goedkeuring aangeboden. and removed Status: In bewerking Het voorstel is in bewerking bij de beheerorganisatie. labels Mar 3, 2025
Deze nieuwe regel zorgt ervoor dat consumers de API kunnen vinden en informatie
over de API kunnen lezen. Als deze root resource niet gedefinieerd is (en dus in
bijvoorbeeld een 404 resulteren), kunnen consumers onbewust concluderen dat de
API niet bestaat, terwijl dat wel het geval is.

Tevens lossen we hiermee de ambiguiteit met de OData specificatie op, die aangeeft
dat de service root URL in een slash moet eindigen (en dus beschikbaar moet zijn).
Voor OData APIs moet op deze root resource het OpenAPI specification document
gepubliceerd zijn.

Fixes Geonovum/KP-APIs#514
Fixes Geonovum/KP-APIs#530
Fixes Geonovum/KP-APIs#604
Fixes Geonovum/KP-APIs#624
@TimvdLippe TimvdLippe force-pushed the pr-timvdlippe-landing-page branch from a4e66ae to ae74c4f Compare March 7, 2025 13:16
@TimvdLippe TimvdLippe force-pushed the pr-timvdlippe-landing-page branch from ae74c4f to 90d8e45 Compare March 7, 2025 13:18
@TimvdLippe
Copy link
Contributor Author

@sanderke Nu met linter configuratie (2 nieuwe regels en wat andere regels moeten updaten) en ook wat testcases.

@TimvdLippe TimvdLippe requested a review from sanderke March 7, 2025 13:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Overleg: TO-API Te agenderen voor het Technisch Overleg API Scope: Klein Kleine wijzigingen met beperkte scope Status: Ter goedkeuring Het voorstel is uitgewerkt en wordt ter goedkeuring aangeboden. Type: Wijziging Inhoudelijke wijziging op een standaard
Projects
None yet
2 participants