[#40397] OpenAPI Specs not OpenAPI 3.0 compatible

- https://community.openproject.org/work_packages/40397
- fixed crucial bugs and most warnings
- fixed spelling and naming

docs/api/apiv3/README.md

@@ -1,14 +1,14 @@
 # API Version 3
- 
+
 _Status: under development_
- 
+
 The documentation for APIv3 is written according to the [OpenAPI 3.0 Specification](https://swagger.io/specification/).
- 
-The file in the repository is split up into many files. Some OAS (OpenAPI Specification) do not support that.
-You can retrieve the complete, singular file from any OpenProject server under `/api/v3/spec.json` or `/api/v3/spec.yml`.
-Additionally, there is a rake task that outputs the specification as a whole as well, either as json or yaml depending
-on the given output file name:
+
+The file in the repository is split up into many files. Some OAS (OpenAPI Specification) do not support that. You can
+retrieve the complete, singular file from any OpenProject server under `/api/v3/spec.json` or `/api/v3/spec.yml`.
+Additionally, there is a script that outputs the specification as a whole as well, either as json or yaml depending on
+the given format argument:
 
 ```
-bundle exec rake api:save_spec ./openproject-oas.yml
+./script/api/spec --format yaml > openproject-oas.yml
 ```

docs/api/apiv3/components/schemas/error_response.yml

@@ -0,0 +1,26 @@
+# Schema: error response
+---
+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.

docs/api/apiv3/components/schemas/link.yml

@@ -25,10 +25,6 @@ properties:
   identifier:
     type: string
     description: "\tAn optional unique identifier to the link object"
-examples:
-- href: 
-- href: "/api/v3/work_packages"
+example:
+  href: "/api/v3/work_packages"
   method: POST
-- href: "/api/v3/examples/{example_id}"
-  templated: true
-- href: urn:openproject-org:api:v3:undisclosed

docs/api/apiv3/components/schemas/user_preference_model.yml

@@ -9,7 +9,7 @@ properties:
     type: boolean
     description: Hide mail address from other users
   notifications:
-    type: NotificationSetting
+    type: object
     description: The settings for the notifications to be received by the user
   timeZone:
     type: string

docs/api/apiv3/openapi-spec.yml

@@ -133,7 +133,7 @@ info:
     are supported. The client signals the desired compression by setting the [`Accept-Encoding` header](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3).
     If no `Accept-Encoding` header is send, `Accept-Encoding: identity` is assumed which will result in the API responding uncompressed.
   title: OpenProject API V3 (Stable)
-  version: ''
+  version: '3'
 servers: []
 paths:
   "/api/v3":
@@ -362,8 +362,6 @@ paths:
     "$ref": "./paths/views.yml"
   "/api/v3/views/{id}":
     "$ref": "./paths/view.yml"
-  "/api/v3/views/{identifier}":
-    "$ref": "./paths/views_{identifier}.yml"
   "/api/v3/wiki_pages/{id}":
     "$ref": "./paths/wiki_page.yml"
   "/api/v3/wiki_pages/{id}/attachments":
@@ -505,6 +503,8 @@ components:
       "$ref": "./components/schemas/document_model.yml"
     DocumentsModel:
       "$ref": "./components/schemas/documents_model.yml"
+    ErrorResponse:
+      "$ref": "./components/schemas/error_response.yml"
     Example_FormModel:
       "$ref": "./components/schemas/example_form_model.yml"
     Example_SchemaModel:

docs/api/apiv3/paths/action.yml

@@ -35,6 +35,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/activity.yml

@@ -94,6 +94,8 @@ patch:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -106,6 +108,8 @@ patch:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -120,6 +124,8 @@ patch:
     '422':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/attachment.yml

@@ -20,6 +20,8 @@ delete:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -36,6 +38,8 @@ delete:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -103,6 +107,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/attachments.yml

@@ -39,6 +39,8 @@ post:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -55,6 +57,8 @@ post:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -69,6 +73,8 @@ post:
     '422':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/budget.yml

@@ -30,6 +30,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/capabilities_context_global.yml

@@ -20,6 +20,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/capability.yml

@@ -37,6 +37,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/category.yml

@@ -36,6 +36,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/custom_action.yml

@@ -34,6 +34,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -48,6 +50,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/custom_action_execute.yml

@@ -16,6 +16,8 @@ post:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -28,6 +30,8 @@ post:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -42,6 +46,8 @@ post:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -53,6 +59,8 @@ post:
     '409':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -65,6 +73,8 @@ post:
     '422':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/custom_object.yml

@@ -28,6 +28,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/document.yml

@@ -65,6 +65,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/documents.yml

@@ -120,6 +120,8 @@ get:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -132,6 +134,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/example_form.yml

@@ -89,6 +89,8 @@ post:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -106,6 +108,8 @@ post:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -118,6 +122,8 @@ post:
     '409':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/grid.yml

@@ -60,6 +60,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/grid_form.yml

@@ -13,6 +13,8 @@ post:
     '200':
       content:
         application/hal+json:
+          schema:
+            type: object
           examples:
             response:
               value:
@@ -118,6 +120,8 @@ post:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -134,6 +138,8 @@ post:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/grids.yml

@@ -79,6 +79,8 @@ get:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -91,6 +93,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -118,6 +122,8 @@ patch:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -130,6 +136,8 @@ patch:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -167,6 +175,8 @@ post:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -179,6 +189,8 @@ post:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/group.yml

@@ -20,6 +20,8 @@ delete:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -34,6 +36,8 @@ delete:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -100,6 +104,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -163,6 +169,8 @@ patch:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -175,6 +183,8 @@ patch:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -189,6 +199,8 @@ patch:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -208,6 +220,8 @@ patch:
     '422':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -245,7 +259,7 @@ patch:
             _links:
               properties:
                 members:
-                  type: arrray
+                  type: array
                   items:
                     type: object
                     properties:

docs/api/apiv3/paths/groups.yml

@@ -74,6 +74,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -105,6 +107,8 @@ post:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -117,6 +121,8 @@ post:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -131,6 +137,8 @@ post:
     '422':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -163,7 +171,7 @@ post:
             _links:
               properties:
                 members:
-                  type: arrray
+                  type: array
                   items:
                     type: object
                     properties:

docs/api/apiv3/paths/membership.yml

@@ -16,6 +16,8 @@ delete:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -30,6 +32,8 @@ delete:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -104,6 +108,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -144,6 +150,8 @@ patch:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -156,6 +164,8 @@ patch:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -170,6 +180,8 @@ patch:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -188,6 +200,8 @@ patch:
     '422':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/membership_form.yml

@@ -96,6 +96,8 @@ post:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -108,6 +110,8 @@ post:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/memberships.yml

@@ -129,6 +129,8 @@ post:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -141,6 +143,8 @@ post:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -155,6 +159,8 @@ post:
     '422':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/memberships_available_projects.yml

@@ -75,6 +75,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/memberships_form.yml

@@ -8,6 +8,8 @@ post:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -20,6 +22,8 @@ post:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/memberships_schema.yml

@@ -70,6 +70,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/my_preferences.yml

@@ -48,6 +48,8 @@ get:
     '401':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -109,6 +111,8 @@ patch:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -121,6 +125,8 @@ patch:
     '401':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -132,6 +138,8 @@ patch:
     '422':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/news.yml

@@ -130,6 +130,8 @@ get:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -142,6 +144,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/news_item.yml

@@ -58,6 +58,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/notification.yml

@@ -20,6 +20,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/notifications.yml

@@ -76,6 +76,8 @@ get:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -88,6 +90,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/post.yml

@@ -40,6 +40,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/post_attachments.yml

@@ -59,6 +59,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -173,6 +175,8 @@ post:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -189,6 +193,8 @@ post:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -205,6 +211,8 @@ post:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -223,6 +231,8 @@ post:
     '422':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/priorities.yml

@@ -63,6 +63,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/priority.yml

@@ -33,6 +33,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/project.yml

@@ -18,6 +18,8 @@ delete:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -32,6 +34,8 @@ delete:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -50,6 +54,8 @@ delete:
     '422':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -95,6 +101,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -146,6 +154,8 @@ patch:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -158,6 +168,8 @@ patch:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -172,6 +184,8 @@ patch:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -190,6 +204,8 @@ patch:
     '422':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/project_available_assignees.yml

@@ -75,6 +75,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -92,6 +94,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/project_available_responsibles.yml

@@ -75,6 +75,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -92,6 +94,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/project_budgets.yml

@@ -45,6 +45,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -62,6 +64,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/project_categories.yml

@@ -52,6 +52,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/project_copy.yml

@@ -18,6 +18,8 @@ post:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -30,6 +32,8 @@ post:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -44,6 +48,8 @@ post:
     '422':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/project_copy_form.yml

@@ -16,6 +16,8 @@ post:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -28,6 +30,8 @@ post:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/project_form.yml

@@ -27,6 +27,8 @@ post:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -39,6 +41,8 @@ post:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/project_queries_default.yml

@@ -174,6 +174,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -188,6 +190,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/project_queries_filter_instance_schemas.yml

@@ -113,6 +113,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/project_queries_schema.yml

@@ -23,6 +23,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/project_status.yml

@@ -29,6 +29,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/project_types.yml

@@ -55,6 +55,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/project_versions.yml

@@ -82,6 +82,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/project_work_packages.yml

@@ -94,6 +94,8 @@ get:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -107,6 +109,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -123,6 +127,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -310,6 +316,8 @@ post:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -322,6 +330,8 @@ post:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -338,6 +348,8 @@ post:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -356,6 +368,8 @@ post:
     '422':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/projects.yml

@@ -179,6 +179,8 @@ post:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -191,6 +193,8 @@ post:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -205,6 +209,8 @@ post:
     '422':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/projects_available_parent_projects.yml

@@ -116,6 +116,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/projects_form.yml

@@ -16,6 +16,8 @@ post:
     '200':
       content:
         application/hal+json:
+          schema:
+            type: object
           examples:
             response:
               value:
@@ -245,6 +247,8 @@ post:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -257,6 +261,8 @@ post:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/queries.yml

@@ -31,6 +31,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -65,6 +67,8 @@ post:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -77,6 +81,8 @@ post:
     '422':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/queries_available_projects.yml

@@ -67,6 +67,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/queries_column.yml

@@ -30,6 +30,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -44,6 +46,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/queries_default.yml

@@ -178,6 +178,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/queries_filter.yml

@@ -29,6 +29,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -43,6 +45,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/queries_filter_instance_schemas.yml

@@ -105,6 +105,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/queries_filter_instance_schemas_{id}.yml

@@ -64,6 +64,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -78,6 +80,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/queries_operator.yml

@@ -30,6 +30,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -44,6 +46,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/queries_schema.yml

@@ -15,6 +15,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/queries_sort_by.yml

@@ -37,6 +37,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -51,6 +53,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/query.yml

@@ -16,6 +16,8 @@ delete:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -32,6 +34,8 @@ delete:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -179,6 +183,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -316,6 +322,8 @@ patch:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -328,6 +336,8 @@ patch:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -342,6 +352,8 @@ patch:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -356,6 +368,8 @@ patch:
     '422':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/query_star.yml

@@ -115,6 +115,8 @@ patch:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -126,6 +128,8 @@ patch:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -142,6 +146,8 @@ patch:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/query_unstar.yml

@@ -115,6 +115,8 @@ patch:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -126,6 +128,8 @@ patch:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -142,6 +146,8 @@ patch:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/relation.yml

@@ -18,6 +18,8 @@ delete:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -32,6 +34,8 @@ delete:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -96,6 +100,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -160,6 +166,8 @@ patch:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -172,6 +180,8 @@ patch:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -186,6 +196,8 @@ patch:
     '422':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/relation_form.yml

@@ -96,6 +96,8 @@ post:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -112,6 +114,8 @@ post:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/relations_schema_{type}.yml

@@ -55,6 +55,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/render_markdown.yml

@@ -31,7 +31,9 @@ post:
       headers: {}
     '400':
       content:
-        application/json:
+        application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -46,7 +48,9 @@ post:
       headers: {}
     '415':
       content:
-        application/json:
+        application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/render_plain.yml

@@ -14,7 +14,9 @@ post:
       headers: {}
     '415':
       content:
-        application/json:
+        application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/revision.yml

@@ -46,6 +46,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/role.yml

@@ -30,6 +30,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -44,6 +46,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/status.yml

@@ -33,6 +33,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/statuses.yml

@@ -84,6 +84,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/time_entries.yml

@@ -155,6 +155,8 @@ get:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -167,6 +169,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -193,6 +197,8 @@ post:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -205,6 +211,8 @@ post:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -219,6 +227,8 @@ post:
     '422':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/time_entries_activity_item.yml

@@ -39,6 +39,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/time_entries_available_projects.yml

@@ -25,6 +25,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/time_entries_form.yml

@@ -8,6 +8,8 @@ post:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -20,6 +22,8 @@ post:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/time_entries_id_form.yml

@@ -16,6 +16,8 @@ post:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -28,6 +30,8 @@ post:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -42,6 +46,8 @@ post:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/time_entries_schema.yml

@@ -94,6 +94,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/time_entry.yml

@@ -16,6 +16,8 @@ delete:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -27,6 +29,8 @@ delete:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -106,6 +110,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -142,6 +148,8 @@ patch:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -154,6 +162,8 @@ patch:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -168,6 +178,8 @@ patch:
     '422':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/type.yml

@@ -35,6 +35,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/types.yml

@@ -47,6 +47,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/user.yml

@@ -20,6 +20,8 @@ delete:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -34,6 +36,8 @@ delete:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -98,6 +102,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -135,6 +141,8 @@ patch:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -147,6 +155,8 @@ patch:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -161,6 +171,8 @@ patch:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -176,6 +188,8 @@ patch:
     '422':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/user_form.yml

@@ -16,6 +16,8 @@ post:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -28,6 +30,8 @@ post:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -42,6 +46,8 @@ post:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/user_lock.yml

@@ -51,6 +51,8 @@ delete:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -65,6 +67,8 @@ delete:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -79,6 +83,8 @@ delete:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -143,6 +149,8 @@ post:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -157,6 +165,8 @@ post:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -171,6 +181,8 @@ post:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/users.yml

@@ -98,6 +98,8 @@ get:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -109,6 +111,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -138,6 +142,8 @@ post:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -150,6 +156,8 @@ post:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -164,6 +172,8 @@ post:
     '422':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/version.yml

@@ -16,6 +16,8 @@ delete:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -30,6 +32,8 @@ delete:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -102,6 +106,8 @@ get:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -142,6 +148,8 @@ patch:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -154,6 +162,8 @@ patch:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -168,6 +178,8 @@ patch:
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/version_form.yml

@@ -16,6 +16,8 @@ post:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -28,6 +30,8 @@ post:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/versions.yml

@@ -104,6 +104,8 @@ post:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -116,6 +118,8 @@ post:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/versions_available_projects.yml

@@ -75,6 +75,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/versions_form.yml

@@ -8,6 +8,8 @@ post:
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -20,6 +22,8 @@ post:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/versions_schema.yml

@@ -103,6 +103,8 @@ get:
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:

docs/api/apiv3/paths/view.yml

@@ -3,7 +3,7 @@
 get:
   parameters:
     - description: View id
-      example: '1'
+      example: 42
       in: path
       name: id
       required: true
@@ -18,9 +18,12 @@ get:
               "$ref": "../components/examples/view_work_packages_table.yml"
             ViewTeamPlanner:
               "$ref": "../components/examples/view_team_planner.yml"
+      description: Returns the result of a single view, dependent of the view type.
     '400':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -29,10 +32,12 @@ get:
                 message: The request body was not a single JSON object.
       description: Occurs when the client did not send a valid JSON object in the
         request body.
-      headers: {}
+      headers: { }
     '403':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -43,10 +48,12 @@ get:
         Returned if the client does not have sufficient permissions.
 
         **Required permission:** The required permission depends on the type of the view.
-      headers: {}
+      headers: { }
     '404':
       content:
         application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
           examples:
             response:
               value:
@@ -58,9 +65,117 @@ get:
 
         *Note: A client without sufficient permissions shall not be able to test for the existence of
         a view. That's why a 404 is returned here, even if a 403 might be more appropriate.*
-      headers: {}
+      headers: { }
   tags:
     - Views
   description: ''
   operationId: View_view
-  summary: View view
+  summary: View view
+
+post:
+  parameters:
+    - description: The view identifier
+      name: id
+      in: path
+      required: true
+      example: '1'
+      schema:
+        type: string
+  requestBody:
+    content:
+      application/json:
+        examples:
+          'Views::WorkPackagesTable':
+            value:
+              _links:
+                query:
+                  href: /api/v3/queries/5
+          'Views::TeamPlanner':
+            value:
+              _links:
+                query:
+                  href: /api/v3/queries/5
+        schema:
+          type: object
+          properties:
+            _links:
+              type: object
+              properties:
+                query:
+                  type: object
+                  properties:
+                    href:
+                      type: string
+                      format: uri
+  responses:
+    '201':
+      content:
+        application/hal+json:
+          schema:
+            type: object
+          examples:
+            'Views::WorkPackagesTable':
+              "$ref": "../components/examples/view_work_packages_table.yml"
+            'Views::TeamPlanner':
+              "$ref": "../components/examples/view_team_planner.yml"
+      description: Created
+      headers: { }
+    '400':
+      content:
+        application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
+          examples:
+            response:
+              value:
+                _type: Error
+                errorIdentifier: urn:openproject-org:api:v3:errors:InvalidRequestBody
+                message: The request body was not a single JSON object.
+      description: Occurs when the client did not send a valid JSON object in the
+        request body.
+      headers: { }
+    '422':
+      content:
+        application/hal+json:
+          schema:
+            $ref: "../components/schemas/error_response.yml"
+          examples:
+            response:
+              value:
+                _embedded:
+                  details:
+                    attribute: query
+                _type: Error
+                errorIdentifier: urn:openproject-org:api:v3:errors:PropertyConstraintViolation
+                message: "Query does not exist."
+      description: |-
+        Returned if:
+
+        * the client tries to modify a read-only property (`PropertyIsReadOnly`)
+
+        * a constraint for a property was violated (`PropertyConstraintViolation`)
+
+        * the client provides a link to an invalid resource (`ResourceTypeMismatch`),
+          e.g. a query not found
+      headers: { }
+  tags:
+    - Views
+  description: |-
+    When calling this endpoint the client provides a single object, containing at least the properties and links that are required, in the body.
+    The required fields of a View can be found in its schema, which is embedded in the respective form.
+    Note that it is only allowed to provide properties or links supporting the write operation.
+
+    There are different subtypes of `Views` (e.g. `Views::WorkPackagesTable`) with each having its own
+    endpoint for creating that subtype e.g.
+
+    * `/api/v3/views/work_packages_table` for `Views::WorkPackagesTable`
+    * `/api/v3/views/team_planner` for `Views::TeamPlanner`
+    * `/api/v3/views/work_packages_calendar` for `Views::WorkPackagesCalendar`
+
+    **Not yet implemented** To get the list of available subtypes and by that the endpoints for creating a subtype, use the
+    ```
+      /api/v3/views/schemas
+    ```
+    endpoint.
+  operationId: Create_views
+  summary: Create view

docs/api/apiv3/paths/views_{identifier}.yml

@@ -1,95 +0,0 @@
-# /api/v3/views/{identifier}
----
-
-post:
-  requestBody:
-    content:
-      application/json:
-        examples:
-          'Views::WorkPackagesTable':
-            value:
-              _links:
-                query:
-                  href: /api/v3/queries/5
-          'Views::TeamPlanner':
-            value:
-              _links:
-                query:
-                  href: /api/v3/queries/5
-        schema:
-          type: object
-          properties:
-            _links:
-              type: object
-              properties:
-                query:
-                  type: object
-                  properties:
-                    href:
-                      type: href
-  responses:
-    '201':
-      content:
-        application/hal+json:
-          examples:
-            'Views::WorkPackagesTable':
-              "$ref": "../components/examples/view_work_packages_table.yml"
-            'Views::TeamPlanner':
-              "$ref": "../components/examples/view_team_planner.yml"
-      description: Created
-      headers: {}
-    '400':
-      content:
-        application/hal+json:
-          examples:
-            response:
-              value:
-                _type: Error
-                errorIdentifier: urn:openproject-org:api:v3:errors:InvalidRequestBody
-                message: The request body was not a single JSON object.
-      description: Occurs when the client did not send a valid JSON object in the
-        request body.
-      headers: {}
-    '422':
-      content:
-        application/hal+json:
-          examples:
-            response:
-              value:
-                _embedded:
-                  details:
-                    attribute: query
-                _type: Error
-                errorIdentifier: urn:openproject-org:api:v3:errors:PropertyConstraintViolation
-                message: "Query does not exist."
-      description: |-
-        Returned if:
-
-        * the client tries to modify a read-only property (`PropertyIsReadOnly`)
-
-        * a constraint for a property was violated (`PropertyConstraintViolation`)
-
-        * the client provides a link to an invalid resource (`ResourceTypeMismatch`),
-          e.g. a query not found
-      headers: {}
-  tags:
-    - Views
-  description: |-
-    When calling this endpoint the client provides a single object, containing at least the properties and links that are required, in the body.
-    The required fields of a View can be found in its schema, which is embedded in the respective form.
-    Note that it is only allowed to provide properties or links supporting the write operation.
-
-    There are different subtypes of `Views` (e.g. `Views::WorkPackagesTable`) with each having its own
-    endpoint for creating that subtype e.g.
-
-    * `/api/v3/views/work_packages_table` for `Views::WorkPackagesTable`
-    * `/api/v3/views/team_planner` for `Views::TeamPlanner`
-    * `/api/v3/views/work_packages_calendar` for `Views::WorkPackagesCalendar`
-
-    **Not yet implemented** To get the list of available subtypes and by that the endpoints for creating a subtype, use the
-    ```
-      /api/v3/views/schemas
-    ```
-    endpoint.
-  operationId: Create_views
-  summary: Create view