Skip to content
This repository was archived by the owner on Nov 25, 2020. It is now read-only.

Commit fe868d3

Browse files
author
Dimitri van Hees
committed
Added README
1 parent 7a6e1c6 commit fe868d3

File tree

6 files changed

+26
-0
lines changed

6 files changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# API Guidelines
2+
3+
This repository contains the API design guidelines for Dutch government APIs. The `components` folder contains compliant reusable OpenAPI components which can be included in OpenAPI Specifications (OAS).
4+
5+
## Referring to components
6+
7+
We recommend to use [jsDelivr](https://www.jsdelivr.com/network/infographic) when referring to the resuable OAS components in this repository. For example, if you want to refer to the `Content-Crs` header in `parameters.yaml`, you should use the following URL:
8+
9+
`https://cdn.jsdelivr.net/gh/geonovum/kp-api-guidelines@1.0.0/components/parameters.yaml#/contentCrs`
10+
11+
Example OAS syntax:
12+
13+
```yaml
14+
paths:
15+
/addresses:
16+
get:
17+
parameters:
18+
- $ref: 'https://cdn.jsdelivr.net/gh/geonovum/kp-api-guidelines@1.0.0/components/parameters.yaml#/contentCrs'
19+
```
20+
21+
## Versioning
22+
23+
Please note that `1.0.0` points to the specific `1.0.0` release of the API Guidelines. Version ranges are also supported, but not recommended:
24+
25+
- `/kp-api-guidelines@1.0/`: latest patch release in the `1.0.x` range, e.g. `1.0.3`
26+
- `/kp-api-guidelines@1/`: latest minor release in the `1.x.x` range, e.g. `1.2.1`.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)