OpenProject Schemas API

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 Schemas 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: "The schema provides detailed information about the properties of a resource.\n\nThe schema is represented by a dictionary where keys are names of resource properties and values are\nobjects describing the corresponding property.\n\nThese objects are called **field schema** and form the core of the schema representation.\nEach of them can contain its own `_links` and `_embedded` section.\n\n## Linked Properties\n\n| Link                | Description                              | Type          | Nullable | Supported operations |\n|:-------------------:| ---------------------------------------- | ------------- | -------- | -------------------- |\n| self                | This schema                              | Schema        |          | READ                 |\n\n## Local Properties\n\n| Property            | Description                                                                        | Type             |\n| :-----------------: | ---------------------------------------------------------------------------------- | ---------------- |\n| _dependencies       | A list of dependencies between one property's value and another property           | SchemaDependency |\n\nThe `_dependencies` property contains the list of dependencies that exist between the value selected for one of the properties of the described resource and the resource's structure. Depending on the value, additional properties might exist or properties might have other values allowed to be assigned. See [SchemaDependency](https://www.openproject.org/docs/api/endpoints/schemas/#schema-dependencies) for more information.\n\n## Field schema\n\n### Linked Properties\n\n| Property             | Description                                                    | Conditions                                           |\n| :--------------:     | -------------------------------------------------------------- | ---------------------------------------------        |\n| allowedValues        | List of resources that are assignable by the current user.     | Will not exist if `allowedValuesSchemas` is present. |\n| allowedValuesSchemas | Link to schemas further describing the property.               | Will not exist if `allowedValues` is present.        |\n\nThe `allowedValues` can either contain a list of canonical links or just a single link to a collection resource.\nThis is an optimization to allow efficient handling of both small resource lists (that can be enumerated inline) and large\nresource lists (requiring one or more separate requests).\n\nThe `allowedValuesSchemas` will on rare occasions (e.g. for a [Query](https://www.openproject.org/docs/api/endpoints/queries/)) replace `allowedValues`. This is done when there is no fixed set of allowed values. Instead, the allowed values will have to follow a schema, or one of a list of schemas, in its own right.\n\nOnly one of the links (`allowedValues`, `allowedValuesSchemas`) will exist for any given property.\n\n### Local Properties\n\n| Property          | Description                                                                        | Type         | Default |\n|:-----------------:| ---------------------------------------------------------------------------------- | ------------ | ------- |\n| type              | The data type of the property                                                      | MetaType     |         |\n| name              | Human readable name of the property as it could be displayed in a UI               | String       |         |\n| required          | If true this property is not nullable                                              | Boolean      | true    |\n| hasDefault        | If true this property will have a default value if none is provided                | Boolean      | false   |\n| writable          | If false it is not allowed to **change** the property value                        | Boolean      | true    |\n| minLength         | The value of the property must at least contain the specified amount of characters | Integer      | 0       |\n| maxLength         | The value of the property must at most contain the specified amount of characters  | Integer      | ∞       |\n| regularExpression | The value of the property must match the given regular expression (if not null)    | String       | null    |\n| formula           | If present, contains a formula that is used to calculate the value of the property | String       | null    |\n| location          | If present, contains a reference to the location of the property in the JSON       | String       | null    |\n| description       | If present, contains a formattable, human readable description                     | Formattable  | null    |\n| deprecated        | If present, the client should consider the existence of the property deprecated    | Boolean      | false   |\n| placeholder       | If present, contains the text to display as a placeholder, so if no value is set   | String       | null    |\n\nAll of the above properties that do not have a default value *must* be present in the schema.\nFor properties that have a default value, the client can assume the default value, if the property is missing.\n\nNote that regular expressions used in the API follow the rules of [Ruby Regular Expressions](https://ruby-doc.org/core-2.2.6/Regexp.html).\n\n### Location property\n\nThe location property gives a hint as to where to find the resource property:\n\n  * when not set, it is in the resource top level attributes;\n  * when set to `_links`, it is under the path `_links.propertyName`;\n  * when set to `_meta`, it is under the path `_meta.propertyName`.\n\nFor example, for a work package schema, the field schema of the `user` property has a location\nproperty set to `_links`. This means that the `user` property will be found under the path\n`_links.user` of the json payload of the work package resource.\n\n## Schema Dependencies\n\nA `SchemaDependency` describes the dependencies between a value chosen for a resource's property\nand the resource's structure. By that, additional properties or changes in a property are\ndescribed.\n\nA `SchemaDependency` will never describe a property to disappear, only to appear. As such it\nalways provides additional information. For a property that is depending on another property's\nvalue, this can result in not being listed in the resource's schema itself at all. This will be\nthe case if the existence of the property as a whole will be dependent. If only one of the aspects\n(e.g. *writable*) of the property changes with the selected value, the property itself will\nalready be listed in the schema, but it will lack the dependent aspect.\n\nGiven that SchemaDependencies will only add information, and the content type of JSON, a client should be able to join the two objects, the schema and the dependency, into one object easily.\n\nSchemaDependencies are always embedded inside a Schema's `_dependencies` attribute. As such, they are not independently existing resources. Consequently, they do not have a `self` reference.\n\n### Linked Properties\n\nA SchemaDependency does not have any links.\n\n### Local Properties\n\n| Property            | Description                                                                        | Type             |\n| :-----------------: | ---------------------------------------------------------------------------------- | ---------------- |\n| on                  | The name of the property on which the dependency exists                            | string           |\n| dependencies        | The additions to a schema grouped by the value of the depending property           | object           |\n\nThe following excerpt exemplifies the objects that can be found as a value of the `dependencies` property:\n\n```json\n{\n  \"_type\": \"SchemaDependency\",\n  \"on\": \"someProperty\",\n  \"dependencies\": {\n    \"1\": {\n      \"loremIpsum\": {\n        \"type\": \"User\",\n        \"name\": \"Lorem ipsum\",\n        \"required\": true,\n        \"hasDefault\": false,\n        \"writable\": true,\n        \"location\": \"_links\",\n        \"placeholder\": \"Lorem ipsum placeholder\",\n        \"description\": {\n            \"format\": \"markdown\",\n            \"raw\": \"A description for field Lorem ipsum. This may contain [links](https://example.com).\",\n            \"html\": \"<p>A description for field Lorem ipsum. This may contain <a href=\\\"https://example.com\\\">links</a>.</p>\"\n        };\n        \"_links\": {\n          \"allowedValues\": {\n            \"href\": \"/api/v3/some/path/to/users\"\n          }\n        }\n      }\n    },\n    \"2\": {\n      \"loremIpsum\": {\n        \"type\": \"User\",\n        \"name\": \"Lorem ipsum\",\n        \"required\": true,\n        \"hasDefault\": false,\n        \"writable\": true,\n        \"location\": \"_links\",\n        \"_links\": {\n          \"allowedValues\": {\n            \"href\": \"/api/v3/a/totally/different/path/to/other/users\"\n          }\n        }\n      }\n    },\n    \"3\": {\n      \"loremIpsum\": {\n        \"type\": \"User\",\n        \"name\": \"Lorem ipsum\",\n        \"required\": true,\n        \"hasDefault\": false,\n        \"writable\": false,\n        \"location\": \"_links\",\n      }\n    },\n    \"4\": {}\n  }\n}\n```\n\nGiven the example above:\n  * If the depending property is `1`, `2` or `3`:\n    * The client must set the property `loremIpsum`, because of `\"required\": true` for all three field schemas\n    * When the depending property is `1` or `2`, the values allowed to be set for `loremIpsum` property differ\n    * When the depending property is `3`, the `loremIpsum` property will not be writable\n  * If the depending property is `4`, the `loremIpsum` property does not exist\n\nBecause of the limitation of JSON objects, all keys will be strings, even when the depending value is actually something different (e.g. Integer, Date).\nThis is also true for resources where the resource url is used as the key."
  name: Schemas
paths:
  /api/v3/example/schema:
    get:
      responses:
        '200':
          content:
            application/hal+json:
              examples:
                response:
                  value:
                    _dependencies: []
                    _links:
                      self:
                        href: /api/v3/example/schema
                    _type: Schema
                    lockVersion:
                      name: Resource Version
                      type: Integer
                      writable: false
                    status:
                      _embedded:
                        allowedValues:
                        - _links:
                            self:
                              href: /api/v3/statuses/1
                          _type: Status
                          createdAt: '2014-05-21T08:51:20.396Z'
                          defaultDoneRatio: 0
                          id: 1
                          isClosed: false
                          isDefault: true
                          name: New
                          position: 1
                          updatedAt: '2014-05-21T09:12:00.441Z'
                        - _links:
                            self:
                              href: /api/v3/statuses/2
                          _type: Status
                          createdAt: '2014-05-21T08:51:20.396Z'
                          defaultDoneRatio: 100
                          id: 2
                          isClosed: true
                          isDefault: false
                          name: Closed
                          position: 2
                          updatedAt: '2014-05-21T09:12:00.441Z'
                      _links:
                        allowedValues:
                        - href: /api/v3/statuses/1
                          title: New
                        - href: /api/v3/statuses/2
                          title: Closed
                      location: _links
                      name: Status
                      type: Status
                    subject:
                      maxLength: 255
                      minLength: 1
                      name: Subject
                      type: String
              schema:
                $ref: '#/components/schemas/Example_SchemaModel'
          description: OK
          headers: {}
      tags:
      - Schemas
      description: This is an example of how a schema might look like. Note that this endpoint does not exist in the actual implementation.
      operationId: view_the_schema
      summary: view the schema
components:
  schemas:
    Example_SchemaModel:
      type: object
      example:
        _type: Schema
        _dependencies: []
        _links:
          self:
            href: /api/v3/example/schema
        lockVersion:
          name: Resource Version
          type: Integer
          writable: false
        subject:
          name: Subject
          type: String
          minLength: 1
          maxLength: 255
        status:
          _links:
            allowedValues:
            - href: /api/v3/statuses/1
              title: New
            - href: /api/v3/statuses/2
              title: Closed
          name: Status
          type: Status
          location: _links
          _embedded:
            allowedValues:
            - _links:
                self:
                  href: /api/v3/statuses/1
              _type: Status
              id: 1
              name: New
              position: 1
              isDefault: true
              isClosed: false
              defaultDoneRatio: 0
              createdAt: '2014-05-21T08:51:20.991Z'
              updatedAt: '2014-05-21T09:12:00.155Z'
            - _links:
                self:
                  href: /api/v3/statuses/2
              _type: Status
              id: 2
              name: Closed
              position: 2
              isDefault: false
              isClosed: true
              defaultDoneRatio: 100
              createdAt: '2014-05-21T08:51:20.991Z'
              updatedAt: '2014-05-21T09:12:00.155Z'
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic