https://gitdocumentatie.logius.nl/publicatie/api/adr/
rule | applicable | description |
---|---|---|
/core/http-safety | ✔️ | All operations are idempotent |
/core/stateless | ✔️ | No session state is maintained |
/core/interface-language | ✔️ | The API is in English, because the domain and terminology used is also in English. |
/core/naming-resources | ✔️ | /transformation and /transform |
/core/nested-child | ❕ | Non applicable |
/core/resource-operations | ❕ | Non applicable |
/core/doc-language | ❕ | Like mentioned regarding /core/interface-language, the domain and terminolgy used is English |
/core/deprecation-schedule | ❕ | Applicable, but implementation of the processes facilitating this will probably not be based primarily on email. Given the nature of the fact that this API will not be behind a registration. |
/core/transition-period | ✔️ | Applicable, we will move from /v1 to a /v2 |
/core/hide-implementation | ✔️ | Applicable |
/core/naming-collections | ✔️ | No collections available, singular resource like /transformation are standalone |
/core/changelog | ✔️ | Applicable, through open sourcing of the code on https://github.com/GeodetischeInfrastructuur |
rule | applicable | description |
---|---|---|
/core/http-methods | ✔️ | Applicable, only GET and POST operations are supported |
/core/doc-openapi | ✔️ | The API has a OAS 3.0.3 document |
/core/uri-version | ✔️ | The API will have a /v2 in the URI |
/core/no-trailing-slash | ✔️ | Applicable |
/core/publish-openapi | ✔️ | The OAS 3.0.3 document is available on /openapi.json endpoint |
/core/semver | ✔️ | Applicable |
/core/version-header | ✔️ | Applicable |