API Paths

A path describes the endpoint of an API for which several operations can be defined. Paths are relative to the base URL of the API, thus they will be placed directly after the server URL and may be followed by path parameters.

Paths always start with a slash /. Curly brackets { } mark parts of the URL as path parameters (see “Parameters” below). API clients need to provide appropriate parameter values when making an API call.

Each path can have up to four different operations: POST, GET, PUT, and DELETE. The combination of path and operation is unique within the API. Every operation type can only be created once for a specific path, i.e. one single path can be used for multiple operations, but it is not possible to create two operations of the same type for one and the same path.

Operations consist of at least one path, an operation id, and one response for successful execution. Additionally, they can contain tags, a summary, a description, parameters, additional responses, and, in the case of POST or PUT operations, a request body.