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

ADR 2.0.0 has non permalinks (e.g. to sub modules) #637

Open
bwbroersma opened this issue Nov 14, 2024 · 2 comments · May be fixed by Logius-standaarden/API-Design-Rules#152
Open

ADR 2.0.0 has non permalinks (e.g. to sub modules) #637

bwbroersma opened this issue Nov 14, 2024 · 2 comments · May be fixed by Logius-standaarden/API-Design-Rules#152
Assignees
Labels
Prio: 1 klaar om op te pakken, hoogste prioriteit om op te lossen STD: ADR Standaard: API Design Rules WG: API design rules (extensies) issues regarding API design rules extension(s) WG: Normatieve rules issues regarding the normative part of the API design rules
Milestone

Comments

@bwbroersma
Copy link

There are some links without or with wrong versioning in API Design Rules 2.0.0 (https://gitdocumentatie.logius.nl/publicatie/api/adr/2.0.0). Of course 'latest' can be a version less link, but others should preferabele be permalinks.

@mrtn78 mrtn78 added WG: API design rules (extensies) issues regarding API design rules extension(s) WG: Normatieve rules issues regarding the normative part of the API design rules Prio: 1 klaar om op te pakken, hoogste prioriteit om op te lossen STD: ADR Standaard: API Design Rules labels Nov 19, 2024
@mrtn78 mrtn78 added this to the ADR v2.0.1 milestone Nov 19, 2024
@mrtn78 mrtn78 self-assigned this Nov 26, 2024
@mrtn78
Copy link
Collaborator

mrtn78 commented Nov 26, 2024

Link naar de ADR Validator ook bijwerken. Dit was https://gitlab.com/commonground/don/adr-validator/-/tree/v0.5.0/pkg/rulesets en moet verwijzen naar developer.overheid.nl
Zie ook:
https://logius-standaarden.github.io/API-Design-Rules/#bib-adr-validator

@mrtn78
Copy link
Collaborator

mrtn78 commented Nov 28, 2024

changes:

The 1.0 reported 15-10-2019 cannot link to the new 1.0, at that time it looked more like https://docs.geostandaarden.nl/api/vv-st-API-Designrules-20200117/ (different layout than https://gitdocumentatie.logius.nl/publicatie/api/adr/1.0), maybe then also change 1.0 on one of these.

"'comply of explain' standard (mandatory open standard)" links to the latest version (https://gitdocumentatie.logius.nl/publicatie/api/adr/) while comply or explain (mind the typo) always has a version, maybe remove the link entirely?

  • fixed the typo
  • removed the link in the official status colum

ADR 2.0.0 (version 2024-03-07) has two sub modules:
"Transport Security module" in § 1.4 links to https://geonovum.github.io/KP-APIs/API-strategie-modules/transport-security/ (which is outdated and links to a version less page) and in § 3.8 links to https://gitdocumentatie.logius.nl/publicatie/api/mod-ts/ (version 1.0.2 from 2024-06-06), this is of a later date then ADR 2.0.0, so it's ambiguous which version is meant, maybe version 1.0.1 from 2024-03-07?

   "GEO module" in [§ 1.4](https://gitdocumentatie.logius.nl/publicatie/api/adr/2.0.0/#reading-guide) and [§ 3.9](https://gitdocumentatie.logius.nl/publicatie/api/adr/2.0.0/#geospatial) links to https://docs.geostandaarden.nl/api/API-Strategie-mod-geo/ (version 2023-05-23), this is of a later date then ADR 2.0.0, so it's ambiguous which version is meant, maybe the latest GEO module version at 2024-03-07?

"Open API Specification (OAS)" shouldn't link to https://forumstandaardisatie.nl/open-standaarden/openapi-specification, since the Netherlands Standardisation Forum doesn't define the standard.

@mrtn78 mrtn78 linked a pull request Nov 28, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Prio: 1 klaar om op te pakken, hoogste prioriteit om op te lossen STD: ADR Standaard: API Design Rules WG: API design rules (extensies) issues regarding API design rules extension(s) WG: Normatieve rules issues regarding the normative part of the API design rules
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants