Home

Introduction

Based on JSON:API this specification aims at describing how client should request resources and how a server should respond to those requests.

The goal is to harmonise the way we create APIs in our company by collaboratively improving this specification to ensure a consistent API that meets our and our customers needs.

Conventions

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 [RFC2119].

Contributing

This documentation is meant to evolve, feel free to contribute and create a PR on this repository.

Be sure to link the PR in the #tech-api channel on slack.