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). API clients need to provide appropriate parameter values when making an API call.

Example:

Here you can see a very basic example of a path and a path parameter.

/user/{id}

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.

Note:

Operations consist of at least one path, one 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.

Create a path

You can crate a path by using the Create path capability. A path must begin with a slash, but trailing slashes are not allowed. path parameters are wrapped around curly brackets { } and the name contained within in them defines the name of the parameter. Query parameters are not represented in the path, but they are modelled separately in each operation.

Edit a path

You can edit a path by using the inline Edit capability.

Delete a path

You can delete the path by using the inline Delete capability. You will need to confirm the action before the selected path is permanently deleted.

Warning:

Please be aware that all operations associated to the path will also be deleted with this action.