nva-api-documentation

API documentation for NVA.

API Servers

Test: https://api.test.nva.aws.unit.no
Production: https://api.nva.unit.no

API documentation

Test: https://swagger-ui.test.nva.aws.unit.no/#/
Production: https://swagger-ui.nva.unit.no/#/

Versioning

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-26 that 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 ;)

Scenarios