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.

Sign up for GitHub

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

Jump to bottom

In ADR 2.0 is uitzondering voor toestaan trailing / op landing page verdwenen #624

Open
fterpstra opened this issue Aug 2, 2024 · 1 comment · May be fixed by Logius-standaarden/API-Design-Rules#165
Open

In ADR 2.0 is uitzondering voor toestaan trailing / op landing page verdwenen #624

fterpstra opened this issue Aug 2, 2024 · 1 comment · May be fixed by Logius-standaarden/API-Design-Rules#165
Assignees
@sanderke

Comments

@fterpstra
Copy link
Collaborator

We hadden tijdens het opstellen van de 2.0 versie bedacht dat er een uitzondering zou moeten komen op de "no trailing slash" regel daar waar er geen resources worden gepubliceerd bijvoorbeeld op de root of landingspage van een API. Dit lijkt in de finale versie verdwenen.
@sanderke
Copy link
Collaborator

sanderke commented Aug 5, 2024

Aangenomen in Technisch Overleg ADR van 25 april 2024.

@sanderke sanderke mentioned this issue Jan 22, 2025
Merged
@TimvdLippe TimvdLippe mentioned this issue Feb 11, 2025
Open
TimvdLippe added a commit to Logius-standaarden/API-Design-Rules that referenced this issue Feb 11, 2025
@TimvdLippe
Definieer nieuwe regel voor publiceren van landing page
0e294e7 
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 linked a pull request Feb 11, 2025 that will close this issue
Open
TimvdLippe added a commit to Logius-standaarden/API-Design-Rules that referenced this issue Mar 7, 2025
@TimvdLippe
Definieer nieuwe regel voor publiceren van landing page
79b5742 
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sanderke sanderke

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Definieer nieuwe regel voor publiceren van landing page Logius-standaarden/API-Design-Rules
2 participants
@fterpstra @sanderke