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 Memberships 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: 'Users and groups can become members of a project. Such a membership will also have one or more roles assigned to it. By that, memberships control the permissions a user has within a project.


    There are also memberships that do not govern the permissions within a certain project but rather govern global permissions. Among the permissions that can be granted like this are the permissions to "Create project" and "Manage users". Those memberships do not have a project associated.


    When creating and updating memberships, a custom message can be sent to users of new and updated memberships. This message can be provided within the `_meta` group.


    ## Linked Properties


    |  Link               | Description                                                   | Type             | Constraints                                                    | Supported operations |

    |:-------------------:|-----------------------------------------                      | -------------    | -------------------------------------------------------------- | -------------------- |

    | self                | This membership                                               | Membership       | not null                                                       | READ                 |

    | project             | The project for which the membership is granted               | Project          |                                                                | READ                 |

    | roles               | The list of roles the user or group is granted in the project | RoleCollection   | not null                                                       | READ                 |

    | principal           | The user or group that was granted membership                 | User or Group    | not null                                                       | READ                 |


    ## Local Properties


    | Property    | Description                                   | Type        | Constraints                                        | Supported operations |

    | :---------: | --------------------------------------------- | ----------- | -----------                                        | -------------------- |

    | id          | Membership id                                 | Integer     | x > 0                                              | READ                 |

    | createdAt   | Time of creation                              | DateTime    | not null                                           | READ                 |

    | updatedAt   | Time of latest update                         | DateTime    | not null                                           | READ                 |


    ## Meta parameters


    | Meta property              | Description                                                                          | Type         | Constraints | Supported operations |Condition |

    | :------------------------: | ---------------------------------------------------                                  | ----         | ----------- | -------------------- |----------|

    | notificationMessage        | The message included in the email(s) send to the users of new or updated memberships | Formattable  |             | READ/WRITE           |          |'
  name: Memberships
paths:
  /api/v3/memberships:
    get:
      summary: List memberships
      operationId: list_memberships
      tags:
      - Memberships
      description: 'Returns a collection of memberships. The client can choose to filter

        the memberships similar to how work packages are filtered. In addition to the

        provided filters, the server will reduce the result set to only contain memberships,

        for which the requesting client has sufficient permissions (*view_members*, *manage_members*).'
      parameters:
      - name: filters
        in: query
        required: false
        schema:
          type: string
        description: "JSON specifying filter conditions.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/)\nendpoint. Currently supported filters are:\n\n+ any_name_attribute: filters memberships based on the name of the principal. All possible name variants\n  (and also email and login) are searched.\n+ blocked: reduces the result set to all memberships that are temporarily blocked or that are not blocked\n  temporarily.\n+ group: filters memberships based on the name of a group. The group however is not the principal used for\n  filtering. Rather, the memberships of the group are used as the filter values.\n+ name: filters memberships based on the name of the principal. Note that only the name is used which depends\n  on a setting in the OpenProject instance.\n+ principal: filters memberships based on the id of the principal.\n+ project: filters memberships based on the id of the project.\n+ role: filters memberships based on the id of any role assigned to the membership.\n+ status: filters memberships based on the status of the principal.\n+ created_at: filters memberships based on the time the membership was created.\n+ updated_at: filters memberships based on the time the membership was updated last."
        examples:
          name-filter:
            summary: Filtering on the name of the principal
            value: '[{ "name": { "operator": "=", "values": ["A User"] }" }]'
          global-memberships:
            summary: Get memberships for global roles
            value: '[{ "project": { "operator": "!*", "values": null }" }]'
      - name: sortBy
        in: query
        required: false
        schema:
          default: '[["id", "asc"]]'
          type: string
        description: "JSON specifying sort criteria.\nAccepts the same format as returned by the [queries](https://www.openproject.org/docs/api/endpoints/queries/)\nendpoint. Currently supported sorts are:\n\n+ id: Sort by primary key\n+ name: Sort by the name of the principal. Note that this depends on the setting for how the name is to be\n  displayed at least for users.\n+ email: Sort by the email address of the principal. Groups and principal users, which do not have an email,\n  are sorted last.\n+ status: Sort by the status of the principal. Groups and principal users, which do not have a status, are\n  sorted together with the active users.\n+ created_at: Sort by membership creation datetime\n+ updated_at: Sort by the time the membership was updated last"
        example: '[["id", "asc"]]'
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/MembershipCollectionModel'
              examples:
                simple membership collection:
                  $ref: '#/components/examples/MembershipSimpleCollectionResponse'
        '400':
          $ref: '#/components/responses/InvalidQuery'
        '403':
          description: Returned if the client is not logged in and login is required.
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                _type: Error
                errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
                message: You are not authorized to view this resource.
    post:
      summary: Create a membership
      operationId: create_membership
      tags:
      - Memberships
      description: 'Creates a new membership applying the attributes provided in the body.


        You can use the form and schema to retrieve the valid attribute values and by that be guided towards successful

        creation.


        By providing a `notificationMessage` within the `_meta` block of the payload, the client can include a customized

        message to the user of the newly created membership. In case of a group, the message will be sent to every user

        belonging to the group.


        By including `{ "sendNotifications": false }` within the `_meta` block of the payload, no notifications is send

        out at all.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MembershipWriteModel'
            examples:
              global role:
                $ref: '#/components/examples/MembershipCreateRequestGlobalRole'
              no notification:
                $ref: '#/components/examples/MembershipCreateRequestNoNotification'
              custom message:
                $ref: '#/components/examples/MembershipCreateRequestCustomMessage'
      responses:
        '201':
          description: Created
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/MembershipReadModel'
              examples:
                simple membership:
                  $ref: '#/components/examples/MembershipSimpleResponse'
        '400':
          $ref: '#/components/responses/InvalidRequestBody'
        '403':
          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 authorized to access this resource.
          description: 'Returned if the client does not have sufficient permissions.


            **Required permission:** Manage members'
        '406':
          $ref: '#/components/responses/MissingContentType'
        '415':
          $ref: '#/components/responses/UnsupportedMediaType'
        '422':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                _embedded:
                  details:
                    attribute: project
                _type: Error
                errorIdentifier: urn:openproject-org:api:v3:errors:PropertyConstraintViolation
                message: Project can't be blank.
          description: 'Returned if:


            - a constraint for a property was violated (`PropertyConstraintViolation`)'
  /api/v3/memberships/available_projects:
    get:
      summary: Available projects for memberships
      operationId: get_memberships_available_projects
      tags:
      - Memberships
      description: 'Gets a list of projects in which a membership can be created in. The list contains all projects in which the user

        issuing the request has the manage members permissions.'
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ProjectCollectionModel'
              examples:
                simple project collection:
                  $ref: '#/components/examples/ProjectCollection'
        '403':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                _type: Error
                errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
                message: You are not authorized to access this resource.
          description: 'Returned if the client does not have sufficient permissions.


            **Required permission:** manage members'
  /api/v3/memberships/form:
    post:
      summary: Form create membership
      operationId: form_create_membership
      tags:
      - Memberships
      description: 'Requests and validates the creation form for memberships. The request payload, if sent, is validated. The form

        endpoint itself does not create a membership.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MembershipWriteModel'
            examples:
              global role:
                $ref: '#/components/examples/MembershipCreateRequestGlobalRole'
              no notification:
                $ref: '#/components/examples/MembershipCreateRequestNoNotification'
              custom message:
                $ref: '#/components/examples/MembershipCreateRequestCustomMessage'
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/MembershipFormModel'
              examples:
                form:
                  $ref: '#/components/examples/MembershipFormResponse'
        '400':
          $ref: '#/components/responses/InvalidRequestBody'
        '403':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                _type: Error
                errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
                message: You are not authorized to access this resource.
          description: 'Returned if the client does not have sufficient permissions.


            **Required permission:** manage memberships in any project'
        '406':
          $ref: '#/components/responses/MissingContentType'
        '415':
          $ref: '#/components/responses/UnsupportedMediaType'
  /api/v3/memberships/schema:
    get:
      summary: Schema membership
      operationId: get_membership_schema
      tags:
      - Memberships
      description: Retrieves the schema for the membership resource object.
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/MembershipSchemaModel'
              examples:
                schema:
                  $ref: '#/components/examples/MembershipSchemaResponse'
        '403':
          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 authorized to access this resource.
          description: 'Returned if the client does not have sufficient permissions to see the schema.


            **Required permission:** manage members or view memberships on any project'
  /api/v3/memberships/{id}:
    delete:
      summary: Delete membership
      operationId: delete_membership
      tags:
      - Memberships
      description: Deletes the membership.
      parameters:
      - name: id
        description: Membership id
        in: path
        required: true
        example: 1
        schema:
          type: integer
      responses:
        '204':
          description: Returned if the membership was successfully deleted
        '403':
          description: 'Returned if the client does not have sufficient permissions.


            **Required permission:** manage members'
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                _type: Error
                errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
                message: You are not authorized to access this resource.
        '404':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                _type: Error
                errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
                message: The requested resource could not be found.
          description: 'Returned if the membership does not exist or the client does not have sufficient permissions

            to see it.


            **Required permission:** view members


            *Note: A client without sufficient permissions shall not be able to test for the existence of

            a version. That''s why a 404 is returned here, even if a 403 might be more appropriate.*'
        '406':
          $ref: '#/components/responses/MissingContentType'
        '415':
          $ref: '#/components/responses/UnsupportedMediaType'
    get:
      summary: Get a membership
      operationId: get_membership
      description: Retrieves a membership resource identified by the given id.
      tags:
      - Memberships
      parameters:
      - name: id
        description: Membership id
        in: path
        required: true
        example: 1
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/MembershipReadModel'
              examples:
                simple membership:
                  $ref: '#/components/examples/MembershipSimpleResponse'
        '404':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                _type: Error
                errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
                message: The requested resource could not be found.
          description: 'Returned if the membership does not exist or the client does not have sufficient permissions

            to see it.


            **Required permission:** view members **or** manage members


            *Note: A client without sufficient permissions shall not be able to test for the existence of

            a membership. That''s why a 404 is returned here, even if a 403 might be more appropriate.*'
    patch:
      summary: Update membership
      operationId: update_membership
      description: 'Updates the given membership by applying the attributes provided in the body.


        By providing a `notificationMessage` within the `_meta` block of the payload, the client can include a customized message to the user

        of the updated membership. In case of a group, the message will be sent to every user belonging to the group.


        By including `{ "sendNotifications": false }` within the `_meta` block of the payload, no notifications is send out at all.'
      tags:
      - Memberships
      parameters:
      - name: id
        description: Membership id
        in: path
        required: true
        example: 1
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MembershipWriteModel'
            examples:
              add roles:
                $ref: '#/components/examples/MembershipUpdateAdditionalRoles'
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/MembershipReadModel'
              examples:
                simple membership:
                  $ref: '#/components/examples/MembershipSimpleResponse'
        '400':
          $ref: '#/components/responses/InvalidRequestBody'
        '403':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                _type: Error
                errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
                message: You are not authorized to access this resource.
          description: 'Returned if the client does not have sufficient permissions.


            **Required permission:** Manage members in the membership''s project.'
          headers: {}
        '404':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                _type: Error
                errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
                message: The requested resource could not be found.
          description: 'Returned if the membership does not exist or the client does not have sufficient permissions

            to see it.


            **Required permission:** view member


            *Note: A client without sufficient permissions shall not be able to test for the existence of

            a version. That''s why a 404 is returned here, even if a 403 might be more appropriate.*'
        '406':
          $ref: '#/components/responses/MissingContentType'
        '415':
          $ref: '#/components/responses/UnsupportedMediaType'
        '422':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                _embedded:
                  details:
                    attribute: roles
                _type: Error
                errorIdentifier: urn:openproject-org:api:v3:errors:PropertyConstraintViolation
                message: Roles has an unassignable role.
          description: 'Returned if:


            * a constraint for a property was violated (`PropertyConstraintViolation`)'
  /api/v3/memberships/{id}/form:
    post:
      summary: Form update membership
      operationId: form_update_membership
      tags:
      - Memberships
      description: 'Requests and validates the update form for a membership identified by the given id. The request payload, if sent,

        is validated. The form endpoint itself does not change the membership.'
      parameters:
      - name: id
        description: Membership id
        in: path
        required: true
        example: 1
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MembershipWriteModel'
            examples:
              no notification:
                $ref: '#/components/examples/MembershipCreateRequestNoNotification'
              custom message:
                $ref: '#/components/examples/MembershipCreateRequestCustomMessage'
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/MembershipReadModel'
              examples:
                simple membership:
                  $ref: '#/components/examples/MembershipSimpleResponse'
        '400':
          $ref: '#/components/responses/InvalidRequestBody'
        '403':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                _type: Error
                errorIdentifier: urn:openproject-org:api:v3:errors:MissingPermission
                message: You are not authorized to access this resource.
          description: 'Returned if the client does not have sufficient permissions.


            **Required permission:** manage versions in the version''s project'
        '406':
          $ref: '#/components/responses/MissingContentType'
        '415':
          $ref: '#/components/responses/UnsupportedMediaType'
components:
  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'
    RoleModel:
      type: object
      required:
      - name
      properties:
        _type:
          type: string
          enum:
          - Role
        id:
          type: integer
          description: Role id
          readOnly: true
          minimum: 1
        name:
          type: string
          description: Role name
        _links:
          type: object
          required:
          - self
          properties:
            self:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'This role


                  **Resource**: Role'
                readOnly: true
      example:
        _type: Role
        id: 3
        name: Manager
        _links:
          self:
            href: /api/v3/roles/3
            title: Manager
    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
    SchemaModel:
      type: object
      required:
      - _type
      - _links
      properties:
        _type:
          type: string
          enum:
          - Schema
        _dependencies:
          type: array
          description: A list of dependencies between one property's value and another property
          items:
            type: string
        _links:
          type: object
          properties:
            self:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'This schema


                  **Resource**: Schema'
    GroupModel:
      allOf:
      - $ref: '#/components/schemas/PrincipalModel'
      - $ref: '#/components/schemas/CustomFieldProperties'
      - type: object
        required:
        - _type
        - _embedded
        properties:
          _type:
            type: string
            enum:
            - Group
          _embedded:
            type: object
            properties:
              members:
                type: array
                description: Embedded list of members.
                items:
                  $ref: '#/components/schemas/UserModel'
          _links:
            type: object
            properties:
              self:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'This group resource


                    **Resource**: Group'
              members:
                type: array
                items:
                  allOf:
                  - $ref: '#/components/schemas/Link'
                  - description: 'A member of the group


                      # Conditions:


                      - user has permission `manage_members` in any project


                      **Resource**: User'
              memberships:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'An collection of all memberships of the group.


                    **Resource**: MembershipCollection'
              delete:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'An href to delete the group.


                    # Conditions:


                    - `admin`'
              updateImmediately:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'An href to update the group.


                    # Conditions:


                    - `admin`


                    **Resource**: Group'
    MembershipFormModel:
      type: object
      required:
      - _type
      - _embedded
      - _links
      properties:
        _type:
          type: string
          enum:
          - Form
        _embedded:
          type: object
          required:
          - payload
          - schema
          - validationError
          properties:
            payload:
              $ref: '#/components/schemas/MembershipWriteModel'
            schema:
              $ref: '#/components/schemas/MembershipSchemaModel'
            validationError:
              type: object
              properties:
                base:
                  $ref: '#/components/schemas/ErrorResponse'
                principal:
                  $ref: '#/components/schemas/ErrorResponse'
                roles:
                  $ref: '#/components/schemas/ErrorResponse'
        _links:
          type: object
          required:
          - self
          - validate
          - commit
          properties:
            self:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'This form request.


                  **Resource**: Form'
            validate:
              type: array
              items:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: The endpoint to validate the membership payload.
            commit:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'The endpoint to create the membership with the same payload, as sent to the form.


                  **Resource**: Membership'
    PortfolioModel:
      allOf:
      - $ref: '#/components/schemas/CustomFieldProperties'
      - $ref: '#/components/schemas/CustomCommentProperties'
      - type: object
        properties:
          _type:
            type: string
            enum:
            - Portfolio
          id:
            type: integer
            description: Portfolios' id
            minimum: 1
          identifier:
            type: string
          name:
            type: string
          active:
            type: boolean
            description: Indicates whether the portfolio is currently active or already archived
          favorited:
            type: boolean
            description: Indicates whether the portfolio is favorited by the current user
          statusExplanation:
            allOf:
            - $ref: '#/components/schemas/Formattable'
            - description: A text detailing and explaining why the portfolio has the reported status
          public:
            type: boolean
            description: Indicates whether the portfolio is accessible for everybody
          description:
            $ref: '#/components/schemas/Formattable'
          createdAt:
            type: string
            format: date-time
            description: Time of creation. Can be writable by admins with the `apiv3_write_readonly_attributes` setting enabled.
          updatedAt:
            type: string
            format: date-time
            description: Time of the most recent change to the portfolio
          _links:
            type: object
            required:
            - self
            - categories
            properties:
              update:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Form endpoint that aids in updating this portfolio


                    # Conditions


                    **Permission**: edit workspace'
              updateImmediately:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Directly update this portfolio


                    # Conditions


                    **Permission**: edit workspace'
              delete:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Delete this portfolio


                    # Conditions


                    **Permission**: admin'
              favor:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Mark this portfolio as favorited by the current user


                    # Conditions


                    Only present if the portfolio is not yet favorited


                    Permission**: none but login is required'
              disfavor:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Mark this portfolio as not favorited by the current user


                    # Conditions

                    Only present if the portfolio is favorited by the current user


                    Permission**: none but login is required'
              createWorkPackage:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Form endpoint that aids in preparing and creating a work package


                    # Conditions


                    **Permission**: add work packages'
              createWorkPackageImmediately:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Directly creates a work package in the portfolio


                    # Conditions


                    **Permission**: add work packages'
              self:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'This portfolio


                    **Resource**: Portfolio'
              categories:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Categories available in this portfolio


                    **Resource**: Collection'
              types:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Types available in this portfolio


                    **Resource**: Collection


                    # Conditions


                    **Permission**: view work packages or manage types'
              versions:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Versions available in this portfolio


                    **Resource**: Collection


                    # Conditions


                    **Permission**: view work packages or manage versions'
              memberships:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Memberships in the  portfolio


                    **Resource**: Collection


                    # Conditions


                    **Permission**: view members'
              workPackages:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Work Packages of this portfolio


                    **Resource**: Collection'
              parent:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Parent of the portfolio


                    **Resource**: Portfolio


                    # Conditions


                    **Permission** edit workspace'
              status:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Denotes the status of the portfolio, so whether the portfolio is on track, at risk or is having trouble.


                    **Resource**: ProjectStatus


                    # Conditions


                    **Permission** edit workspace'
              storages:
                type: array
                items:
                  allOf:
                  - $ref: '#/components/schemas/Link'
                  - description: 'The link to a storage that is active for this portfolio.


                      **Resource**: Storage


                      # Conditions


                      **Permission**: view_file_links'
              projectStorages:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'The project storage collection of this portfolio.


                    **Resource**: Collection


                    # Conditions


                    **Permission**: view_file_links'
              ancestors:
                type: array
                items:
                  allOf:
                  - $ref: '#/components/schemas/Link'
                  - description: 'A collection of links to the ancestor portfolios.


                      **Resource**: Portfolio'
    PrincipalModel:
      type: object
      required:
      - _type
      - id
      - name
      - _links
      properties:
        _type:
          type: string
          enum:
          - User
          - Group
          - PlaceholderUser
        id:
          type: integer
          description: The principal's unique identifier.
          minimum: 1
        name:
          type: string
          description: The principal's display name, layout depends on instance settings.
        createdAt:
          type: string
          format: date-time
          description: Time of creation
        updatedAt:
          type: string
          format: date-time
          description: Time of the most recent change to the principal
        _links:
          type: object
          required:
          - self
          properties:
            self:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'This principal resource.


                  **Resource**: User|Group|PlaceholderUser'
            memberships:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'An href to the collection of the principal''s memberships.


                  # Conditions:


                  - user has permission `view_members` or `manage_members` in any project


                  **Resource**: Collection'
    MembershipSchemaModel:
      allOf:
      - $ref: '#/components/schemas/SchemaModel'
      - type: object
        required:
        - id
        - createdAt
        - updatedAt
        - notificationMessage
        - project
        - principal
        - roles
        properties:
          id:
            $ref: '#/components/schemas/SchemaPropertyModel'
          createdAt:
            $ref: '#/components/schemas/SchemaPropertyModel'
          updatedAt:
            $ref: '#/components/schemas/SchemaPropertyModel'
          notificationMessage:
            $ref: '#/components/schemas/SchemaPropertyModel'
          project:
            $ref: '#/components/schemas/SchemaPropertyModel'
          principal:
            $ref: '#/components/schemas/SchemaPropertyModel'
          roles:
            $ref: '#/components/schemas/SchemaPropertyModel'
    SchemaPropertyModel:
      type: object
      required:
      - type
      - name
      - required
      - hasDefault
      - writable
      properties:
        type:
          type: string
          description: The resource type for this property.
        name:
          type: string
          description: The name of the property.
        required:
          type: boolean
          description: Indicates, if the property is required for submitting a request of this schema.
        hasDefault:
          type: boolean
          description: Indicates, if the property has a default.
        writable:
          type: boolean
          description: Indicates, if the property is writable when sending a request of this schema.
        options:
          type: object
          description: Additional options for the property.
        location:
          type: string
          description: Defines the json path where the property is located in the payload.
          default: ''
        placeholder:
          type: string
          description: A placeholder for the property to display if the property has no value.
        _links:
          type: object
          description: Useful links for this property (e.g. an endpoint to fetch allowed values)
    CollectionLinks:
      type: object
      required:
      - self
      properties:
        self:
          allOf:
          - $ref: '#/components/schemas/Link'
          - description: 'This collection resource.


              **Resource**: Collection'
    MembershipWriteModel:
      type: object
      required:
      - _links
      properties:
        _links:
          type: object
          properties:
            principal:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'The principal that is to get a membership.


                  **Resource**: Principal'
            roles:
              type: array
              items:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'A role the principal has.


                    **Resource**: Role'
            project:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'The project that is to get a membership. If no project is given, the principal''s membership is supposed

                  to be global.


                  **Resource**: Project'
        _meta:
          type: object
          properties:
            notificationMessage:
              allOf:
              - $ref: '#/components/schemas/Formattable'
              - description: A customised notification message, which will overwrite the standard notification.
            sendNotification:
              type: boolean
              description: Set to false, if no notification should get sent.
              default: true
    MembershipReadModel:
      type: object
      required:
      - _type
      - id
      - createdAt
      - updatedAt
      - _links
      properties:
        _type:
          type: string
          enum:
          - Membership
        id:
          type: integer
          description: The membership's id
          minimum: 1
        createdAt:
          type: string
          format: date-time
          description: The time the membership was created.
        updatedAt:
          type: string
          format: date-time
          description: The time the membership was last updated.
        _embedded:
          type: object
          properties:
            project:
              oneOf:
              - $ref: '#/components/schemas/ProjectModel'
              - $ref: '#/components/schemas/ProgramModel'
              - $ref: '#/components/schemas/PortfolioModel'
            principal:
              anyOf:
              - $ref: '#/components/schemas/UserModel'
              - $ref: '#/components/schemas/GroupModel'
            roles:
              type: array
              items:
                $ref: '#/components/schemas/RoleModel'
        _links:
          type: object
          required:
          - self
          - schema
          - project
          - principal
          - roles
          properties:
            self:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'This membership.


                  **Resource**: Membership'
            schema:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'This membership schema.


                  **Resource**: Schema'
            update:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'The endpoint for updating the membership.


                  # Conditions


                  **Permission**: manage_members'
            updateImmediately:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'The endpoint for updating the membership without form validation.


                  # Conditions


                  **Permission**: manage_members'
            project:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'The workspace the membership is related to.


                  **Resource**: Workspace'
            principal:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'The principal the membership is related to.


                  **Resource**: Principal'
            roles:
              type: array
              items:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'A role the principal has.


                    **Resource**: Role'
    PaginatedCollectionModel:
      allOf:
      - $ref: '#/components/schemas/CollectionModel'
      - type: object
        required:
        - pageSize
        - offset
        properties:
          pageSize:
            type: integer
            description: Amount of elements that a response will hold.
            minimum: 0
          offset:
            type: integer
            description: The page number that is requested from paginated collection.
            minimum: 1
          _links:
            type: object
            required:
            - jumpTo
            - changeSize
            properties:
              jumpTo:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Templated link to another page offset.


                    **Resource**: Collection'
              changeSize:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Templated link for another page size.


                    **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!
    OffsetPaginatedCollectionModel:
      allOf:
      - $ref: '#/components/schemas/CollectionModel'
      - type: object
        required:
        - pageSize
        - offset
        - _links
        properties:
          pageSize:
            type: integer
            description: 'The amount of elements per page. If not set by the request this value defaults to the server''s system

              settings.'
            minimum: 0
          offset:
            type: integer
            description: The page offset indicating on which page the element collection starts.
            minimum: 0
          _links:
            $ref: '#/components/schemas/OffsetPaginatedCollectionLinks'
    ErrorResponse:
      type: object
      required:
      - _type
      - errorIdentifier
      - message
      properties:
        _embedded:
          type: object
          properties:
            details:
              type: object
              properties:
                attribute:
                  type: string
                  example: project
        _type:
          type: string
          enum:
          - Error
        errorIdentifier:
          type: string
          example: urn:openproject-org:api:v3:errors:PropertyConstraintViolation
        message:
          type: string
          example: Project can't be blank.
    ProgramModel:
      allOf:
      - $ref: '#/components/schemas/CustomFieldProperties'
      - $ref: '#/components/schemas/CustomCommentProperties'
      - type: object
        properties:
          _type:
            type: string
            enum:
            - Program
          id:
            type: integer
            description: Programs' id
            minimum: 1
          identifier:
            type: string
          name:
            type: string
          active:
            type: boolean
            description: Indicates whether the program is currently active or already archived
          favorited:
            type: boolean
            description: Indicates whether the program is favorited by the current user
          statusExplanation:
            allOf:
            - $ref: '#/components/schemas/Formattable'
            - description: A text detailing and explaining why the program has the reported status
          public:
            type: boolean
            description: Indicates whether the program is accessible for everybody
          description:
            $ref: '#/components/schemas/Formattable'
          createdAt:
            type: string
            format: date-time
            description: Time of creation. Can be writable by admins with the `apiv3_write_readonly_attributes` setting enabled.
          updatedAt:
            type: string
            format: date-time
            description: Time of the most recent change to the program
          _links:
            type: object
            required:
            - self
            - categories
            properties:
              update:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Form endpoint that aids in updating this program


                    # Conditions


                    **Permission**: edit workspace'
              updateImmediately:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Directly update this program


                    # Conditions


                    **Permission**: edit workspace'
              delete:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Delete this program


                    # Conditions


                    **Permission**: admin'
              favor:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Mark this program as favorited by the current user


                    # Conditions


                    Only present if the program is not yet favorited


                    Permission**: none but login is required'
              disfavor:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Mark this program as not favorited by the current user


                    # Conditions

                    Only present if the program is favorited by the current user


                    Permission**: none but login is required'
              createWorkPackage:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Form endpoint that aids in preparing and creating a work package


                    # Conditions


                    **Permission**: add work packages'
              createWorkPackageImmediately:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Directly creates a work package in the program


                    # Conditions


                    **Permission**: add work packages'
              self:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'This program


                    **Resource**: Program'
              categories:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Categories available in this program


                    **Resource**: Collection'
              types:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Types available in this program


                    **Resource**: Collection


                    # Conditions


                    **Permission**: view work packages or manage types'
              versions:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Versions available in this program


                    **Resource**: Collection


                    # Conditions


                    **Permission**: view work packages or manage versions'
              memberships:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Memberships in the  program


                    **Resource**: Collection


                    # Conditions


                    **Permission**: view members'
              workPackages:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Work Packages of this program


                    **Resource**: Collection'
              parent:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Parent of the program


                    **Resource**: Program


                    # Conditions


                    **Permission** edit workspace'
              status:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Denotes the status of the program, so whether the program is on track, at risk or is having trouble.


                    **Resource**: ProjectStatus


                    # Conditions


                    **Permission** edit workspace'
              storages:
                type: array
                items:
                  allOf:
                  - $ref: '#/components/schemas/Link'
                  - description: 'The link to a storage that is active for this program.


                      **Resource**: Storage


                      # Conditions


                      **Permission**: view_file_links'
              projectStorages:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'The project storage collection of this program.


                    **Resource**: Collection


                    # Conditions


                    **Permission**: view_file_links'
              ancestors:
                type: array
                items:
                  allOf:
                  - $ref: '#/components/schemas/Link'
                  - description: 'A collection of links to the ancestor workspace.


                      **Resource**: Workspace'
    ProjectCollectionModel:
      allOf:
      - $ref: '#/components/schemas/OffsetPaginatedCollectionModel'
      - type: object
        required:
        - _links
        - _embedded
        properties:
          _links:
            allOf:
            - $ref: '#/components/schemas/OffsetPaginatedCollectionLinks'
            - type: object
              properties:
                representations:
                  type: array
                  items:
                    allOf:
                    - $ref: '#/components/schemas/Link'
                    - description: A project collection representation in a specific file format.
          _embedded:
            type: object
            required:
            - elements
            properties:
              elements:
                type: array
                items:
                  $ref: '#/components/schemas/ProjectModel'
    MembershipCollectionModel:
      allOf:
      - $ref: '#/components/schemas/PaginatedCollectionModel'
      - type: object
        required:
        - _embedded
        properties:
          _embedded:
            type: object
            required:
            - elements
            properties:
              elements:
                type: array
                items:
                  $ref: '#/components/schemas/MembershipReadModel'
    UserModel:
      allOf:
      - $ref: '#/components/schemas/PrincipalModel'
      - $ref: '#/components/schemas/CustomFieldProperties'
      - type: object
        required:
        - _type
        - avatar
        properties:
          _type:
            type: string
            enum:
            - User
          avatar:
            type:
            - string
            - 'null'
            format: uri
            description: URL to user's avatar
          login:
            type: string
            description: 'The user''s login name


              # Conditions


              - User is self, or `create_user` or `manage_user` permission globally'
            maxLength: 256
          firstName:
            type: string
            description: 'The user''s first name


              # Conditions


              - User is self, or `create_user` or `manage_user` permission globally'
            maxLength: 30
          lastName:
            type: string
            description: 'The user''s last name


              # Conditions


              - User is self, or `create_user` or `manage_user` permission globally'
            maxLength: 30
          email:
            type: string
            description: 'The user''s email address


              # Conditions


              - E-Mail address not hidden

              - User is not a new record

              - User is self, or `create_user` or `manage_user` permission globally'
            maxLength: 60
          admin:
            type: boolean
            description: 'Flag indicating whether or not the user is an admin


              # Conditions


              - `admin`'
          status:
            type: string
            description: 'The current activation status of the user.


              # Conditions


              - User is self, or `create_user` or `manage_user` permission globally'
          language:
            type: string
            description: 'User''s language | ISO 639-1 format


              # Conditions


              - User is self, or `create_user` or `manage_user` permission globally'
          identityUrl:
            type:
            - string
            - 'null'
            description: 'User''s identity_url for OmniAuth authentication.

              **Deprecated:** It will be removed in the near future.


              # Conditions


              - User is self, or `create_user` or `manage_user` permission globally'
            deprecated: true
          createdAt:
            type: string
            format: date-time
            description: Time of creation
          updatedAt:
            type: string
            format: date-time
            description: Time of the most recent change to the user
          _links:
            type: object
            properties:
              showUser:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'A relative path to show the user in the web application.


                    # Condition


                    - User is not a new record

                    - User is not `locked`'
              updateImmediately:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'A link to update the user resource.


                    # Conditions


                    - `admin`'
              lock:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Restrict the user from logging in and performing any actions.


                    # Conditions


                    - User is not locked

                    - `admin`'
              unlock:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Allow a locked user to login and act again.


                    # Conditions


                    - User is not locked

                    - `admin`'
              delete:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: "Permanently remove a user from the instance\n\n# Conditions\n\neither:\n  - `admin`\n  - Setting `users_deletable_by_admin` is set\nor:\n  - User is self\n  - Setting `users_deletable_by_self` is set"
              authSource:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Permanently remove a user from the instance


                    # Conditions


                    - LDAP authentication configured

                    - `admin`'
    CustomCommentProperties:
      type: object
      patternProperties:
        ^customComment\d+$:
          type:
          - 'null'
          - string
          description: 'A plain-text comment associated with a project custom field that has comments enabled.


            The property is only present when the corresponding `customField{N}` has `has_comment` set to `true`.'
    ProjectModel:
      allOf:
      - $ref: '#/components/schemas/CustomFieldProperties'
      - $ref: '#/components/schemas/CustomCommentProperties'
      - type: object
        properties:
          _type:
            type: string
            enum:
            - Project
          id:
            type: integer
            description: Projects' id
            minimum: 1
          identifier:
            type: string
          name:
            type: string
          active:
            type: boolean
            description: Indicates whether the project is currently active or already archived
          favorited:
            type: boolean
            description: Indicates whether the project is favorited by the current user
          statusExplanation:
            allOf:
            - $ref: '#/components/schemas/Formattable'
            - description: A text detailing and explaining why the project has the reported status
          public:
            type: boolean
            description: Indicates whether the project is accessible for everybody
          description:
            $ref: '#/components/schemas/Formattable'
          createdAt:
            type: string
            format: date-time
            description: Time of creation. Can be writable by admins with the `apiv3_write_readonly_attributes` setting enabled.
          updatedAt:
            type: string
            format: date-time
            description: Time of the most recent change to the project
          _links:
            type: object
            required:
            - self
            - categories
            properties:
              update:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Form endpoint that aids in updating this project


                    # Conditions


                    **Permission**: edit workspace'
              updateImmediately:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Directly update this project


                    # Conditions


                    **Permission**: edit workspace'
              delete:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Delete this project


                    # Conditions


                    **Permission**: admin'
              favor:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Mark this project as favorited by the current user


                    # Conditions


                    Only present if the project is not yet favorited


                    Permission**: none but login is required'
              disfavor:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Mark this project as not favorited by the current user


                    # Conditions

                    Only present if the project is favorited by the current user


                    Permission**: none but login is required'
              createWorkPackage:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Form endpoint that aids in preparing and creating a work package


                    # Conditions


                    **Permission**: add work packages'
              createWorkPackageImmediately:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Directly creates a work package in the project


                    # Conditions


                    **Permission**: add work packages'
              self:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'This project


                    **Resource**: Project'
              categories:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Categories available in this project


                    **Resource**: Collection'
              types:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Types available in this project


                    **Resource**: Collection


                    # Conditions


                    **Permission**: view work packages or manage types'
              versions:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Versions available in this project


                    **Resource**: Collection


                    # Conditions


                    **Permission**: view work packages or manage versions'
              memberships:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Memberships in the project


                    **Resource**: Collection


                    # Conditions


                    **Permission**: view members'
              workPackages:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Work Packages of this project


                    **Resource**: Collection'
              parent:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Parent of the project


                    **Resource**: Workspace


                    # Conditions


                    **Permission** edit workspace'
              status:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'Denotes the status of the project, so whether the project is on track, at risk or is having trouble.


                    **Resource**: ProjectStatus


                    # Conditions


                    **Permission** edit workspace'
              storages:
                type: array
                items:
                  allOf:
                  - $ref: '#/components/schemas/Link'
                  - description: 'The link to a storage that is active for this project.


                      **Resource**: Storage


                      # Conditions


                      **Permission**: view_file_links'
              projectStorages:
                allOf:
                - $ref: '#/components/schemas/Link'
                - description: 'The project storage collection of this project.


                    **Resource**: Collection


                    # Conditions


                    **Permission**: view_file_links'
              ancestors:
                type: array
                items:
                  allOf:
                  - $ref: '#/components/schemas/Link'
                  - description: 'A collection of links to the ancestor workspaces.


                      **Resource**: Workspace'
    OffsetPaginatedCollectionLinks:
      allOf:
      - $ref: '#/components/schemas/CollectionLinks'
      - type: object
        required:
        - jumpTo
        - changeSize
        properties:
          jumpTo:
            allOf:
            - $ref: '#/components/schemas/Link'
            - description: A templated link to jump to a given offset.
          changeSize:
            allOf:
            - $ref: '#/components/schemas/Link'
            - description: A templated link to change the current page size.
          previousByOffset:
            allOf:
            - $ref: '#/components/schemas/Link'
            - description: 'A link to the previous page of the collection.


                # Conditions

                - The collection is not on the first page.'
          nextByOffset:
            allOf:
            - $ref: '#/components/schemas/Link'
            - description: 'A link to the next page of the collection.


                # Conditions

                - The collection is not on the last page.'
    CustomFieldProperties:
      type: object
      patternProperties:
        ^customField\d+$:
          type:
          - 'null'
          - number
          - boolean
          - string
          - object
          description: 'A custom field value, that belongs to a custom field of a simple type:


            - Boolean

            - Date

            - Float

            - Integer

            - Link (URL)

            - Text

            - Long text'
  responses:
    MissingContentType:
      description: Occurs when the client did not send a Content-Type header
      content:
        text/plain:
          schema:
            type: string
          example: Missing content-type header
    UnsupportedMediaType:
      description: Occurs when the client sends an unsupported Content-Type header.
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            _type: Error
            errorIdentifier: urn:openproject-org:api:v3:errors:TypeNotSupported
            message: Expected CONTENT-TYPE to be (expected value) but got (actual value).
    InvalidRequestBody:
      description: Occurs when the client did not send a valid JSON object in the request body.
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            _type: Error
            errorIdentifier: urn:openproject-org:api:v3:errors:InvalidRequestBody
            message: The request body was not a single JSON object.
    InvalidQuery:
      description: Returned if the client sends invalid request parameters e.g. filters
      content:
        application/hal+json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            _type: Error
            errorIdentifier: urn:openproject-org:api:v3:errors:InvalidQuery
            message: Filters Invalid filter does not exist.
  examples:
    MembershipFormResponse:
      description: A simple form response example.
      value:
        _type: Form
        _embedded:
          payload:
            _meta:
              notificationMessage:
                format: markdown
                raw: '*Hallo*'
                html: <p class="op-uc-p"><em>Hallo</em></p>
            _links:
              project:
                href: /api/v3/projects/21
                title: Death Star v3
              principal:
                href: /api/v3/users/14
                title: Mara Jade
              roles: []
          schema:
            _type: Schema
            _abbreviated: Schema resource shortened for brevity
          validationErrors:
            roles:
              _type: Error
              errorIdentifier: urn:openproject-org:api:v3:errors:PropertyConstraintViolation
              message: Roles need to be assigned.
              _embedded:
                details:
                  attribute: roles
        _links:
          self:
            href: /api/v3/memberships/form
            method: post
          validate:
            href: /api/v3/memberships/form
            method: post
    MembershipCreateRequestGlobalRole:
      description: Create a membership for a global role. To address global roles, no project must be set.
      value:
        _links:
          principal:
            href: /api/v3/users/14
          roles:
          - href: /api/v3/roles/4
    MembershipSimpleResponse:
      description: A simple membership response example.
      value:
        _type: Membership
        id: 11
        createdAt: '2015-03-20T12:56:56.626Z'
        updatedAt: '2018-12-20T18:16:11.563Z'
        _embedded:
          project:
            _type: Project
            id: 3
            _abbreviated: Project resource shortened for brevity
          principal:
            _type: User
            id: 5
            _abbreviated: User resource shortened for brevity
          roles:
          - _type: Role
            id: 4
            _abbreviated: Roles resource shortened for brevity
        _links:
          self:
            href: /api/v3/memberships/11
            title: Darth Vader
          schema:
            href: /api/v3/memberships/schema
          update:
            href: /api/v3/memberships/11/form
            method: post
          updateImmediately:
            href: /api/v3/memberships/11
            method: patch
          project:
            href: /api/v3/projects/3
            title: Death Start v3
          principal:
            href: /api/v3/users/5
            title: Darth Vader
          roles:
          - href: /api/v3/roles/4
            title: Sith Lord
    MembershipCreateRequestCustomMessage:
      description: Create a membership and send a custom notification message.
      value:
        _links:
          principal:
            href: /api/v3/users/14
          project:
            href: /api/v3/projects/21
          roles:
          - href: /api/v3/roles/4
        _meta:
          notificationMessage:
            format: markdown
            raw: Granted permission to execute Order *66*.
    MembershipCreateRequestNoNotification:
      description: Create a membership without sending a notification message.
      value:
        _links:
          principal:
            href: /api/v3/users/14
          project:
            href: /api/v3/projects/21
          roles:
          - href: /api/v3/roles/4
        _meta:
          sendNotification: false
    ProjectCollection:
      value:
        _type: Collection
        count: 2
        total: 2
        pageSize: 20
        offset: 1
        _embedded:
          elements:
          - _abbreviated: Project resource shortened for brevity
            id: 1
            identifier: initialproject
            name: DeathStar construction
            active: true
            public: true
          - _abbreviated: Project resource shortened for brevity
            id: 2
            identifier: mysecret
            name: Palpatine's secret plan
            active: true
            public: false
        _links:
          self:
            href: /api/v3/projects?filters=%5B%5D&offset=1&pageSize=20
          jumpTo:
            href: /api/v3/projects?filters=%5B%5D&offset=%7Boffset%7D&pageSize=20
            templated: true
          changeSize:
            href: /api/v3/projects?filters=%5B%5D&offset=1&pageSize=%7Bsize%7D
            templated: true
          representations:
          - href: /projects.csv?filters=%5B%5D&offset=1&pageSize=20
            identifier: csv
            type: text/csv
            title: CSV
          - href: /projects.xls?filters=%5B%5D&offset=1&pageSize=20
            identifier: xls
            type: application/vnd.ms-excel
            title: XLS
    MembershipSimpleCollectionResponse:
      description: A simple membership collection response example.
      value:
        _type: Collection
        total: 1
        count: 1
        pageSize: 20
        offset: 1
        _embedded:
          elements:
          - _type: Membership
            id: 11
            createdAt: '2015-03-20T12:56:56.643Z'
            updatedAt: '2018-12-20T18:16:11.643Z'
            _links:
              self:
                href: /api/v3/memberships/11
                title: Darth Vader
              schema:
                href: /api/v3/memberships/schema
              update:
                href: /api/v3/memberships/11/form
                method: post
              updateImmediately:
                href: /api/v3/memberships/11
                method: patch
              project:
                href: /api/v3/projects/3
                title: Death Start v3
              principal:
                href: /api/v3/users/5
                title: Darth Vader
              roles:
              - href: /api/v3/roles/4
                title: Sith Lord
        _links:
          self:
            href: /api/v3/memberships
          jumpTo:
            href: /api/v3/memberships?filters=%5B%5D&offset=%7Boffset%7D&pageSize=20
            templated: true
          changeSize:
            href: /api/v3/memberships?filters=%5B%5D&offset=1&pageSize=%7Bsize%7D
            templated: true
          nextByOffset:
            href: /api/v3/memberships?filters=%5B%5D&offset=2&pageSize=20
    MembershipSchemaResponse:
      description: A simple schema response example.
      value:
        _type: Schema
        _dependencies: []
        id:
          type: Integer
          name: ID
          required: true
          hasDefault: false
          writable: false
          options: {}
        createdAt:
          type: DateTime
          name: Created on
          required: true
          hasDefault: false
          writable: false
          options: {}
        updatedAt:
          type: DateTime
          name: Updated on
          required: true
          hasDefault: false
          writable: false
          options: {}
        notificationMessage:
          type: Formattable
          name: Message
          required: false
          hasDefault: false
          writable: true
          options: {}
          location: _meta
        project:
          type: Project
          name: Project
          required: false
          hasDefault: false
          writable: true
          location: _links
          _links:
            allowedValues:
              href: /api/v3/memberships/available_projects?filters=%5B%7B%22principal%22%3A%7B%22operator%22%3A%22%21%22%2C%22values%22%3A%5B%2214%22%5D%7D%7D%5D
        principal:
          type: Principal
          name: Principal
          required: true
          hasDefault: false
          writable: true
          location: _links
          _links:
            allowedValues:
              href: /api/v3/principals?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22%21%22%2C%22values%22%3A%5B%223%22%5D%7D%7D%2C%7B%22member%22%3A%7B%22operator%22%3A%22%21%22%2C%22values%22%3A%5B%2221%22%5D%7D%7D%5D
        roles:
          type: '[]Role'
          name: Role
          required: true
          hasDefault: false
          writable: true
          location: _links
          _links:
            allowedValues:
              href: /api/v3/roles
        _links:
          self:
            href: /api/v3/memberships/schema
    MembershipUpdateAdditionalRoles:
      description: Updates a membership and add multiple roles.
      value:
        _links:
          roles:
          - href: /api/v3/roles/5
          - href: /api/v3/roles/6
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic