OpenProject Relations API
Work packages may be related to each other in different ways. ``` +--------------+ +--------------+ | | 1 1 | | | Work package +-------------+--------------+ Work package | | | from | to | | +--------------+ | +--------------+ +------+-------+ | Relation | +--------------+ | type | | reverseType | | description | | lag | +--------------+ ``` ## Actions | Link | Description | Condition | |:-------------------:| -------------------------------------------------------------------- | --------------------------------------------- | | update | Updates the relation between two work packages via a form | **Permission**: manage work package relations | | updateImmediately | Updates the relation between two work packages | **Permission**: manage work package relations | | delete | Destroys the relation between the two work packages | **Permission**: manage work package relations | ## Linked Properties | Link | Description | Type | Constraints | Supported operations | Condition | |:-------------:|-------------------------------------- | ------------- | ----------- | -------------------- | --------------------------------------------- | | self | This relation | Relation | not null | READ | **Permission**: view work packages | | schema | The schema of this relation | Schema | not null | READ | | | from | The emanating work package | WorkPackage | not null | READ | **Permission**: view work packages | | to | The work package the relation ends in | WorkPackage | not null | READ | **Permission**: view work packages | ## Local Properties | Property | Description | Type | Constraints | Supported operations | | :---------------:| ------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------- | -------------------- | | id | Relation ID | Integer | x > 0 | READ | | name | The internationalized name of this kind of relation | String | | READ | type | Which kind of relation (blocks, precedes, etc.) | String | in: relates, duplicates, duplicated, blocks, blocked, precedes, follows, includes, partof, requires, required | READ / WRITE | | reverseType | The kind of relation from the other WP's perspective | String | in: relates, duplicates, duplicated, blocks, blocked, precedes, follows, includes, partof, requires, required | READ | | description | Short text further describing the relation | String | | READ / WRITE | | lag* | The number of days between closing of `from` and start of `to`| Integer | x >= 0 | READ / WRITE | \* Only applicable for some relation types such as "follows". You can check using the relation by schema endpoint at `/api/v3/relations/schema/{type}`.
Documentation
Specifications
Other Resources
openapi: 3.1.2
info:
description: "You're looking at the current **stable** documentation of the OpenProject APIv3. If you're interested in the current\ndevelopment version, please go to [github.com/opf](https://github.com/opf/openproject/tree/dev/docs/api/apiv3).\n\n## Introduction\n\nThe documentation for the APIv3 is written according to the [OpenAPI 3.1 Specification](https://swagger.io/specification/).\nYou can either view the static version of this documentation on the [website](https://www.openproject.org/docs/api/introduction/)\nor the interactive version, rendered with [OpenAPI Explorer](https://github.com/Rhosys/openapi-explorer/blob/main/README.md),\nin your OpenProject installation under `/api/docs`.\nIn the latter you can try out the various API endpoints directly interacting with our OpenProject data.\nMoreover you can access the specification source itself under `/api/v3/spec.json` and `/api/v3/spec.yml`\n(e.g. [here](https://community.openproject.org/api/v3/spec.yml)).\n\nThe APIv3 is a hypermedia REST API, a shorthand for \"Hypermedia As The Engine Of Application State\" (HATEOAS).\nThis means that each endpoint of this API will have links to other resources or actions defined in the resulting body.\n\nThese related resources and actions for any given resource will be context sensitive. For example, only actions that the\nauthenticated user can take are being rendered. This can be used to dynamically identify actions that the user might take for any\ngiven response.\n\nAs an example, if you fetch a work package through the [Work Package endpoint](https://www.openproject.org/docs/api/endpoints/work-packages/), the `update` link will only\nbe present when the user you authenticated has been granted a permission to update the work package in the assigned project.\n\n## HAL+JSON\n\nHAL is a simple format that gives a consistent and easy way to hyperlink between resources in your API.\nRead more in the following specification: [https://tools.ietf.org/html/draft-kelly-json-hal-08](https://tools.ietf.org/html/draft-kelly-json-hal-08)\n\n**OpenProject API implementation of HAL+JSON format** enriches JSON and introduces a few meta properties:\n\n- `_type` - specifies the type of the resource (e.g.: WorkPackage, Project)\n- `_links` - contains all related resource and action links available for the resource\n- `_embedded` - contains all embedded objects\n\nHAL does not guarantee that embedded resources are embedded in their full representation, they might as well be\npartially represented (e.g. some properties can be left out).\nHowever in this API you have the guarantee that whenever a resource is **embedded**, it is embedded in its **full representation**.\n\n## API response structure\n\nAll API responses contain a single HAL+JSON object, even collections of objects are technically represented by\na single HAL+JSON object that itself contains its members. More details on collections can be found\nin the [Collections Section](https://www.openproject.org/docs/api/collections/).\n\n## Authentication\n\nThe API supports the following authentication schemes:\n\n* Session-based authentication\n* API tokens\n * passed as Bearer token\n * passed via Basic auth\n* OAuth 2.0\n * using built-in authorization server\n * using an external authorization server (RFC 9068)\n\nDepending on the settings of the OpenProject instance many resources can be accessed without being authenticated.\nIn case the instance requires authentication on all requests the client will receive an **HTTP 401** status code\nin response to any request.\n\nOtherwise unauthenticated clients have all the permissions of the anonymous user.\n\n### Session-based authentication\n\nThis means you have to login to OpenProject via the Web-Interface to be authenticated in the API.\nThis method is well-suited for clients acting within the browser, like the Angular-Client built into OpenProject.\n\nIn this case, you always need to pass the HTTP header `X-Requested-With \"XMLHttpRequest\"` for authentication.\n\n### API token as bearer token\n\nUsers can authenticate towards the API v3 using an API token as a bearer token.\n\nFor example:\n\n```shell\nAPI_KEY=opapi-2519132cdf62dcf5a66fd96394672079f9e9cad1\ncurl -H \"Authorization: Bearer $API_KEY\" https://community.openproject.org/api/v3/users/42\n```\n\nUsers can generate API tokens on their account page.\n\n### API token through Basic Auth\n\nAPI tokens can also be used with basic auth, using the user name `apikey` (NOT your login) and the API token as the password.\n\nFor example:\n\n```shell\nAPI_KEY=opapi-2519132cdf62dcf5a66fd96394672079f9e9cad1\ncurl -u apikey:$API_KEY https://community.openproject.org/api/v3/users/42\n```\n\n### OAuth 2.0 authentication\n\nOpenProject allows authentication and authorization with OAuth2 with *Authorization code flow*, as well as *Client credentials* operation modes.\n\nTo get started, you first need to register an application in the OpenProject OAuth administration section of your installation.\nThis will save an entry for your application with a client unique identifier (`client_id`) and an accompanying secret key (`client_secret`).\n\nYou can then use one the following guides to perform the supported OAuth 2.0 flows:\n\n- [Authorization code flow](https://oauth.net/2/grant-types/authorization-code)\n\n- [Authorization code flow with PKCE](https://doorkeeper.gitbook.io/guides/ruby-on-rails/pkce-flow), recommended for clients unable to keep the client_secret confidential\n\n- [Client credentials](https://oauth.net/2/grant-types/client-credentials/) - Requires an application to be bound to an impersonating user for non-public access\n\n### OAuth 2.0 using an external authorization server\n\nThere is a possibility to use JSON Web Tokens (JWT) generated by an OIDC provider configured in OpenProject as a bearer token to do authenticated requests against the API.\nThe following requirements must be met:\n\n- OIDC provider must be configured in OpenProject with **jwks_uri**\n- JWT must be signed using RSA algorithm\n- JWT **iss** claim must be equal to OIDC provider **issuer**\n- JWT **aud** claim must contain the OpenProject **client ID** used at the OIDC provider\n- JWT **scope** claim must include a valid scope to access the desired API (e.g. `api_v3` for APIv3)\n- JWT must be actual (neither expired or too early to be used)\n- JWT must be passed in Authorization header like: `Authorization: Bearer {jwt}`\n- User from **sub** claim must be linked to OpenProject before (e.g. by logging in), otherwise it will be not authenticated\n\nIn more general terms, OpenProject should be compliant to [RFC 9068](https://www.rfc-editor.org/rfc/rfc9068) when validating access tokens.\n\n### Why not username and password?\n\nThe simplest way to do basic auth would be to use a user's username and password naturally.\nHowever, OpenProject already has supported API keys in the past for the API v2, though not through basic auth.\n\nUsing **username and password** directly would have some advantages:\n\n* It is intuitive for the user who then just has to provide those just as they would when logging into OpenProject.\n\n* No extra logic for token management necessary.\n\nOn the other hand using **API keys** has some advantages too, which is why we went for that:\n\n* If compromised while saved on an insecure client the user only has to regenerate the API key instead of changing their password, too.\n\n* They are naturally long and random which makes them invulnerable to dictionary attacks and harder to crack in general.\n\nMost importantly users may not actually have a password to begin with. Specifically when they have registered\nthrough an OpenID Connect provider.\n\n## Cross-Origin Resource Sharing (CORS)\n\nBy default, the OpenProject API is _not_ responding with any CORS headers.\nIf you want to allow cross-domain AJAX calls against your OpenProject instance, you need to enable CORS headers being returned.\n\nPlease see [our API settings documentation](https://www.openproject.org/docs/system-admin-guide/api-and-webhooks/) on\nhow to selectively enable CORS.\n\n## Allowed HTTP methods\n\n- `GET` - Get a single resource or collection of resources\n\n- `POST` - Create a new resource or perform\n\n- `PATCH` - Update a resource\n\n- `DELETE` - Delete a resource\n\n## Compression\n\nResponses are compressed if requested by the client. Currently [gzip](https://www.gzip.org/) and [deflate](https://tools.ietf.org/html/rfc1951)\nare supported. The client signals the desired compression by setting the [`Accept-Encoding` header](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3).\nIf no `Accept-Encoding` header is send, `Accept-Encoding: identity` is assumed which will result in the API responding uncompressed."
title: OpenProject API V3 (Stable) Actions & Capabilities Relations API
version: '3'
servers:
- url: https://qa.openproject-edge.com
description: Edge QA instance
- url: https://qa.openproject-stage.com
description: Staging instance
- url: https://community.openproject.org
description: Community instance
security:
- BasicAuth: []
tags:
- description: "Work packages may be related to each other in different ways.\n\n```\n+--------------+ +--------------+\n| | 1 1 | |\n| Work package +-------------+--------------+ Work package |\n| | from | to | |\n+--------------+ | +--------------+\n +------+-------+\n | Relation |\n +--------------+\n | type |\n | reverseType |\n | description |\n | lag |\n +--------------+\n```\n\n## Actions\n\n| Link | Description | Condition |\n|:-------------------:| -------------------------------------------------------------------- | --------------------------------------------- |\n| update | Updates the relation between two work packages via a form | **Permission**: manage work package relations |\n| updateImmediately | Updates the relation between two work packages | **Permission**: manage work package relations |\n| delete | Destroys the relation between the two work packages | **Permission**: manage work package relations |\n\n## Linked Properties\n\n| Link | Description | Type | Constraints | Supported operations | Condition |\n|:-------------:|-------------------------------------- | ------------- | ----------- | -------------------- | --------------------------------------------- |\n| self | This relation | Relation | not null | READ | **Permission**: view work packages |\n| schema | The schema of this relation | Schema | not null | READ | |\n| from | The emanating work package | WorkPackage | not null | READ | **Permission**: view work packages |\n| to | The work package the relation ends in | WorkPackage | not null | READ | **Permission**: view work packages |\n\n## Local Properties\n\n| Property | Description | Type | Constraints | Supported operations |\n| :---------------:| ------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------- | -------------------- |\n| id | Relation ID | Integer | x > 0 | READ |\n| name | The internationalized name of this kind of relation | String | | READ\n| type | Which kind of relation (blocks, precedes, etc.) | String | in: relates, duplicates, duplicated, blocks, blocked, precedes, follows, includes, partof, requires, required | READ / WRITE |\n| reverseType | The kind of relation from the other WP's perspective | String | in: relates, duplicates, duplicated, blocks, blocked, precedes, follows, includes, partof, requires, required | READ |\n| description | Short text further describing the relation | String | | READ / WRITE |\n| lag* | The number of days between closing of `from` and start of `to`| Integer | x >= 0 | READ / WRITE |\n\n\\* Only applicable for some relation types such as \"follows\". You can check using the relation by schema\nendpoint at `/api/v3/relations/schema/{type}`."
name: Relations
paths:
/api/v3/relations:
get:
summary: List Relations
operationId: list_relations
tags:
- Relations
description: 'Lists all relations according to the given (optional, logically conjunctive) filters and ordered by ID.
The response only includes relations between work packages which the user is allowed to see.'
parameters:
- name: filters
description: 'JSON specifying filter conditions. Accepts the same format as returned by
the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint. Valid fields to filter by are:
- id - ID of relation
- from - ID of work package from which the filtered relations emanates.
- to - ID of work package to which this related points.
- involved - ID of either the `from` or the `to` work package.
- type - The type of relation to filter by, e.g. "follows".'
example: '[{ "from": { "operator": "=", "values": 42 }" }]'
in: query
required: false
schema:
type: string
- name: sortBy
description: 'JSON specifying sort criteria.
Accepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/) endpoint.'
example: '[["type", "asc"]]'
in: query
required: false
schema:
type: string
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/RelationCollectionModel'
examples:
response:
$ref: '#/components/examples/RelationCollectionResponse'
'400':
description: Returned if the client provides invalid filter parameters.
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:InvalidQuery
message:
- Filters Type filter has invalid values.
/api/v3/relations/{id}:
get:
summary: Get Relation
operationId: get_relation
tags:
- Relations
description: Get a single relation specified by its unique identifier.
parameters:
- description: Relation id
example: 1
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
description: OK
content:
application/hal+json:
examples:
response:
$ref: '#/components/examples/RelationResponse'
schema:
$ref: '#/components/schemas/RelationReadModel'
'404':
description: 'Returned if the relation does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work packages for the involved work packages'
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The specified relation does not exist.
delete:
summary: Delete Relation
operationId: delete_relation
tags:
- Relations
description: Deletes the relation.
parameters:
- description: The unique identifier of the relation resource
example: 1
in: path
name: id
required: true
schema:
type: integer
responses:
'204':
description: Returned if the relation was deleted successfully. The response body is empty.
'403':
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** manage work package relations'
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not allowed to delete this relation.
'404':
description: 'Returned if the relation does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work packages'
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The specified relation does not exist.
'406':
$ref: '#/components/responses/MissingContentType'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
patch:
summary: Update Relation
operationId: update_relation
tags:
- Relations
description: 'When calling this endpoint the client provides a single object, containing the properties and links that it wants
to change, in the body. It is only allowed to provide properties or links supporting the **write** operation.
Note that changing the `type` of a relation invariably also changes the respective `reverseType` as well as the
"name" of it. The returned Relation object will reflect that change. For instance if you change a Relation''s
`type` to "follows" then the `reverseType` will be changed to `precedes`.
It is not allowed to change a relation''s involved work packages.'
parameters:
- description: Relation ID
example: 1
in: path
name: id
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RelationWriteModel'
examples:
request:
$ref: '#/components/examples/RelationUpdateRequest'
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/RelationReadModel'
examples:
response:
$ref: '#/components/examples/RelationResponse'
'400':
$ref: '#/components/responses/InvalidRequestBody'
'404':
description: 'Returned if the relation does not exist or the client does not have sufficient permissions to see it.
**Required permission:** view work packages'
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
message: The specified relation does not exist.
'406':
$ref: '#/components/responses/MissingContentType'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
'422':
description: "Returned if:\n\n- the client tries to modify a read-only property (`PropertyIsReadOnly`)\n- a constraint for a property was violated (`PropertyConstraintViolation`)\n- the client provides a link to an invalid resource (`ResourceTypeMismatch`) or a\n work package that does not exist or for which the client does not have sufficient permissions\n to see it (**required permissions**: `view work packages` for the involved work packages)."
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_embedded:
details:
attribute: lag
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:PropertyConstraintViolation
message: Lag must be a number greater than or equal to 0
/api/v3/work_packages/{id}/relations:
post:
summary: Create relation
operationId: create_relation
tags:
- Relations
description: 'Create a work package relation on the given work package. A successful creation will result in a relation between
two work packages, thus appearing on both involved work package resources.'
parameters:
- name: id
description: Work package id
example: 1
in: path
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RelationWriteModel'
examples:
request:
$ref: '#/components/examples/RelationCreateRequest'
responses:
'201':
description: Created
content:
application/hal+json:
schema:
$ref: '#/components/schemas/RelationReadModel'
examples:
Simple response:
$ref: '#/components/examples/RelationResponse'
'400':
$ref: '#/components/responses/InvalidRequestBody'
'403':
description: 'Returned if the client does not have sufficient permissions.
**Required permission:** manage work package relations'
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
message: You are not allowed to create a relation.
'409':
description: 'Returned if there already exists a relation between the given work packages of **any** type
or if the relation is not allowed.'
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:UpdateConflict
message: Couldn't update the resource because of conflicting modifications.
'406':
$ref: '#/components/responses/MissingContentType'
'415':
$ref: '#/components/responses/UnsupportedMediaType'
'422':
description: 'Returned if:
- the client tries to write a read-only property (`PropertyIsReadOnly`)
- a constraint for a property was violated (`PropertyConstraintViolation`)
- the client provides a link to an invalid resource (`ResourceTypeMismatch`)'
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
response:
value:
_embedded:
details:
attribute: lag
_type: Error
errorIdentifier: urn:openproject-org:api:v3:errors:PropertyConstraintViolation
message: Lag must be a number greater than or equal to 0
components:
examples:
RelationCollectionResponse:
description: Simple response of a relation collection.
value:
_type: Collection
total: 40
count: 20
pageSize: 20
offset: 1
_embedded:
elements:
- _type: Relation
id: 650
name: duplicated by
type: duplicated
reverseType: duplicates
lag: null
description: Those are the same... stupid Stormtroopers!
_links:
self:
href: /api/v3/relations/650
updateImmediately:
href: /api/v3/relations/650
method: patch
delete:
href: /api/v3/relations/650
method: delete,
title: Remove relation
from:
href: /api/v3/work_packages/108
title: Destroy Rebel Base
to:
href: /api/v3/work_packages/78
title: Annihilate Yavin 4
- _type: Relation
id: 652
name: relates to
type: relates
reverseType: relates
_hint: Relation resource shortened for brevity.
- _hint: Further relation resources shortened for brevity.
_links:
self:
href: /api/v3/relations?filters=%5B%5D&offset=1&pageSize=20
jumpTo:
href: /api/v3/relations?filters=%5B%5D&offset=%7Boffset%7D&pageSize=20
templated: true
changeSize:
href: /api/v3/relations?filters=%5B%5D&offset=1&pageSize=%7Bsize%7D
templated: true
nextByOffset:
href: /api/v3/relations?filters=%5B%5D&offset=2&pageSize=20
RelationResponse:
description: Simple response of a 'duplicated by' relation between two work packages.
value:
_type: Relation
id: 650
name: duplicated by
type: duplicated
reverseType: duplicates
lag: null
description: Those are the same... stupid Stormtroopers!
_embedded:
from:
id: 108
_type: WorkPackage
_abbreviated: Work package resource shortened for brevity.
to:
id: 78
_type: WorkPackage
_abbreviated: Work package resource shortened for brevity.
_links:
self:
href: /api/v3/relations/650
updateImmediately:
href: /api/v3/relations/650
method: patch
delete:
href: /api/v3/relations/650
method: delete,
title: Remove relation
from:
href: /api/v3/work_packages/108
title: Destroy Rebel Base
to:
href: /api/v3/work_packages/78
title: Annihilate Yavin 4
RelationCreateRequest:
description: Example request to create a relation between two work packages.
value:
type: follows
lag: 2
description: Build hangar AFTER improving external skeleton of Death Star.
_links:
to:
href: /api/v3/work_packages/1337
RelationUpdateRequest:
description: Example request to update the relation's description.
value:
description: This is the new description.
schemas:
CollectionModel:
type: object
required:
- _type
- total
- count
- _links
properties:
_type:
type: string
enum:
- Collection
total:
type: integer
description: The total amount of elements available in the collection.
minimum: 0
count:
type: integer
description: Actual amount of elements in this response.
minimum: 0
_links:
$ref: '#/components/schemas/CollectionLinks'
CollectionLinks:
type: object
required:
- self
properties:
self:
allOf:
- $ref: '#/components/schemas/Link'
- description: 'This collection resource.
**Resource**: Collection'
Formattable:
type: object
required:
- format
properties:
format:
type: string
enum:
- plain
- markdown
- custom
readOnly: true
description: Indicates the formatting language of the raw text
example: markdown
raw:
type: string
description: The raw text, as entered by the user
example: I **am** formatted!
html:
type: string
readOnly: true
description: The text converted to HTML according to the format
example: I <strong>am</strong> formatted!
example:
format: markdown
raw: I am formatted!
html: I am formatted!
Link:
type: object
required:
- href
properties:
href:
type:
- string
- 'null'
description: URL to the referenced resource (might be relative)
title:
type: string
description: Representative label for the resource
templated:
type: boolean
default: false
description: If true the href contains parts that need to be replaced by the client
method:
type: string
default: GET
description: The HTTP verb to use when requesting the resource
payload:
type: object
description: The payload to send in the request to achieve the desired result
identifier:
type: string
description: An optional unique identifier to the link object
type:
type: string
description: The MIME-Type of the returned resource.
example:
href: /api/v3/work_packages
method: POST
RelationReadModel:
type: object
properties:
_type:
type: string
enum:
- Relation
id:
type: integer
description: Relation ID
name:
type: string
description: The internationalised name of this type of relation
type:
type: string
description: The relation type.
enum:
- relates
- duplicates
- duplicated
- blocks
- blocked
- precedes
- follows
- includes
- partof
- requires
- required
reverseType:
type: string
description: The type of relation from the perspective of the related work package.
enum:
- relates
- duplicates
- duplicated
- blocks
- blocked
- precedes
- follows
- includes
- partof
- requires
- required
description:
type:
- string
- 'null'
description: A descriptive
# --- truncated at 32 KB (60 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openproject/refs/heads/main/openapi/openproject-relations-api-openapi.yml