The API reference page
The Norway Data API navbar link opens /api-reference, an interactive API reference rendered by Scalar. The API itself, its OpenAPI spec, its tests, and its docs live in their own repo, cedar-ave/norway-data-api, and deploy to their own Netlify site at api.marlasowards.com. This page covers only how this site connects to it.
The tutorial and guides
The Norway Data API's tutorial and how-to guides live in this repo, in the /samples section, not in the API repo. The API reference explains how the API works, and the guides explain how to get things done with it. This page covers how the guides connect to the API, and what to check when the API changes.
How the API was built
The Norway Data API started as a quick API documentation sample and went through four expert-perspective reviews: an API developer's, an API technical writer's, a principal API developer's production-readiness review, and an API security review. This page records each step, what each review found, and what changed, so the reasons behind the current design aren't lost.
Security
How the Norway Data API and its reference page are protected, and the settings that have to be made by hand. The full threat model and every control are in API security controls, mirrored from the API repo. This page summarizes it and covers this site's side.
The Netlify Functions
Mirrored from docs/function.md in the norway-data-api repo, which is the source of truth. When one changes, update the other.
The OpenAPI spec
Mirrored from docs/spec.md in the norway-data-api repo, which is the source of truth. When one changes, update the other.
The contract test
Mirrored from docs/contract-test.md in the norway-data-api repo, which is the source of truth. When one changes, update the other.
Maintaining the API
Mirrored from docs/maintenance.md in the norway-data-api repo, which is the source of truth. When one changes, update the other.
API security controls
Mirrored from docs/security.md in the norway-data-api repo, which is the source of truth. When one changes, update the other.
Design decisions
Mirrored from docs/design-decisions.md in the norway-data-api repo, which is the source of truth. When one changes, update the other.