API documentation for NVA.
We provide standardized C4 diagrams — for those who may be interested — in the system directory. To generate the diagrams, use the C4-Structurizr or your favourite tool. At the present time, C4 diagrams are available for the System context only as this is relevant to most users. If a Container context is required, create an issue in this repository.
Please note, at the present time, there is no intention to make Component or Code context diagrams available as it is possible to generate sufficient diagrams from code (SAM-IaC and the code itself).
- Test: https://api.test.nva.aws.unit.no
- Production: https://api.nva.unit.no
- Test: https://swagger-ui.test.nva.aws.unit.no/#/
- Production: https://swagger-ui.nva.unit.no/#/
We have a few principles when it comes to versioning that all users of the API need to be aware of:
- We will never change or delete existing fields.
- We can add new fields without bumping the version.
- Clients must make sure they can handle "unknown" fields from the server responses.
- If we need to make changes that are not backward compatible, we will introduce a version property, e.g.
application/json; version=2023-05-26that clients that are aware can ask for. - Clients sending no
Accept-header or the generic "application/json" will get the original version. - If the original version is rarely used in the future, we might officially deprecate it and eventually remove it.
- Generally, we try to adhere to Postel's Law / The Robustness Principle, which we suggest you do too ;)