Merge remote-tracking branch 'origin/redmine-5.0.x'

d-yoshi · May 6, 2024 · 106a271 · 106a271
2 parents fd3f2b4 + 1a35f9e
commit 106a271
Show file tree

Hide file tree

Showing 49 changed files with 207 additions and 192 deletions.
diff --git a/openapi.yml b/openapi.yml
diff --git a/src/components/parameters/query/key.yml b/src/components/parameters/query/key.yml
@@ -0,0 +1,4 @@
+name: key
+in: query
+schema:
+  type: string
diff --git a/src/components/securitySchemes.yml → src/components/security_schemes.yml b/src/components/securitySchemes.yml → src/components/security_schemes.yml
@@ -6,3 +6,8 @@ ApiKeyAuth:
   type: apiKey
   in: header
   name: X-Redmine-API-Key
+
+ApiKeyInQueryAuth:
+  type: apiKey
+  in: query
+  name: key
diff --git a/src/openapi.yml b/src/openapi.yml
@@ -9,7 +9,7 @@ info:
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
-  version: 0.8.0
+  version: 0.8.1
 
 servers:
   - url: /
@@ -21,6 +21,7 @@ externalDocs:
 security:
   - BasicAuth: []
   - ApiKeyAuth: []
+  - ApiKeyInQueryAuth: []
 
 paths:
   /issues.{format}:
@@ -160,7 +161,7 @@ paths:
 
 components:
   securitySchemes:
-    $ref: ./components/securitySchemes.yml
+    $ref: ./components/security_schemes.yml
 
 tags:
   $ref: ./tags.yml
diff --git a/src/paths/attachments.attachment_id.yml b/src/paths/attachments.attachment_id.yml
@@ -6,9 +6,9 @@ get:
   summary: GET
   operationId: getAttachment
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
     - $ref: ../components/parameters/path/attachment_id.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
   responses:
     200:
       description: ""
@@ -28,9 +28,9 @@ patch:
   summary: PATCH
   operationId: updateAttachment
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
     - $ref: ../components/parameters/path/attachment_id.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
   requestBody:
     content:
       application/json:
@@ -56,9 +56,9 @@ delete:
   summary: DELETE
   operationId: deleteAttachment
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
     - $ref: ../components/parameters/path/attachment_id.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
   responses:
     204:
       description: ""
diff --git a/src/paths/custom_fields.yml b/src/paths/custom_fields.yml
@@ -6,8 +6,8 @@ get:
   summary: GET
   operationId: getCustomFields
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
   responses:
     200:
       description: ""

diff --git a/src/paths/enumerations.document_categories.yml b/src/paths/enumerations.document_categories.yml
@@ -6,8 +6,8 @@ get:
   summary: GET
   operationId: getDocumentCategories
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
   responses:
     200:
       description: ""

diff --git a/src/paths/enumerations.issue_priorities.yml b/src/paths/enumerations.issue_priorities.yml
@@ -6,8 +6,8 @@ get:
   summary: GET
   operationId: getIssuePriorities
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
   responses:
     200:
       description: ""

diff --git a/src/paths/enumerations.time_entry_activities.yml b/src/paths/enumerations.time_entry_activities.yml
@@ -6,8 +6,8 @@ get:
   summary: GET
   operationId: getTimeEntryActivities
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
   responses:
     200:
       description: ""

diff --git a/src/paths/groups.group_id.users.user_id.yml b/src/paths/groups.group_id.users.user_id.yml
@@ -6,10 +6,10 @@ delete:
   summary: DELETE
   operationId: removeUserFromGroup
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
     - $ref: ../components/parameters/path/group_id.yml
     - $ref: ../components/parameters/path/user_id.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
   responses:
     204:
       description: ""
diff --git a/src/paths/groups.group_id.users.yml b/src/paths/groups.group_id.users.yml
@@ -6,9 +6,9 @@ post:
   summary: POST
   operationId: addUserToGroup
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
     - $ref: ../components/parameters/path/group_id.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
   requestBody:
     content:
       application/json:

diff --git a/src/paths/groups.group_id.yml b/src/paths/groups.group_id.yml
@@ -6,9 +6,9 @@ get:
   summary: GET
   operationId: getGroup
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
     - $ref: ../components/parameters/path/group_id.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - name: include
       in: query
       schema:
@@ -38,9 +38,9 @@ put:
   summary: PUT
   operationId: updateGroup
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
     - $ref: ../components/parameters/path/group_id.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
   requestBody:
     content:
       application/json:
@@ -68,9 +68,9 @@ delete:
   summary: DELETE
   operationId: deleteGroup
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
     - $ref: ../components/parameters/path/group_id.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
   responses:
     204:
       description: ""
diff --git a/src/paths/groups.yml b/src/paths/groups.yml
@@ -6,8 +6,8 @@ get:
   summary: GET
   operationId: getGroups
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
   responses:
     200:
       description: ""
@@ -31,8 +31,8 @@ post:
   summary: POST
   operationId: createGroup
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
   requestBody:
     content:
       application/json:

diff --git a/src/paths/issue_categories.issue_category_id.yml b/src/paths/issue_categories.issue_category_id.yml
@@ -6,9 +6,9 @@ get:
   summary: GET
   operationId: getIssueCategory
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
     - $ref: ../components/parameters/path/issue_category_id.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
   responses:
     200:
       description: ""
@@ -30,9 +30,9 @@ put:
   summary: PUT
   operationId: updateIssueCategory
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
     - $ref: ../components/parameters/path/issue_category_id.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
   requestBody:
     content:
       application/json:
@@ -64,9 +64,9 @@ delete:
   summary: DELETE
   operationId: deleteIssueCategory
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
     - $ref: ../components/parameters/path/issue_category_id.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - name: reassign_to_id
       in: query
       schema:

diff --git a/src/paths/issue_statuses.yml b/src/paths/issue_statuses.yml
@@ -6,8 +6,8 @@ get:
   summary: Returns possible Status Values for Issues
   operationId: getIssueStatuses
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
   responses:
     200:
       description: ""

diff --git a/src/paths/issues.issue_id.relations.yml b/src/paths/issues.issue_id.relations.yml
@@ -6,9 +6,9 @@ get:
   summary: GET
   operationId: getIssueRelationsByIssue
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
     - $ref: ../components/parameters/path/issue_id.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
   responses:
     200:
       description: ""
@@ -32,9 +32,9 @@ post:
   summary: POST
   operationId: createIssueRelationsByIssue
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
     - $ref: ../components/parameters/path/issue_id.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
   requestBody:
     content:
       application/json:

diff --git a/src/paths/issues.issue_id.watchers.user_id.yml b/src/paths/issues.issue_id.watchers.user_id.yml
@@ -6,10 +6,10 @@ delete:
   summary: Removing a watcher
   operationId: deleteWatcher
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
     - $ref: ../components/parameters/path/issue_id.yml
     - $ref: ../components/parameters/path/user_id.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
   responses:
     204:
       description: ""
diff --git a/src/paths/issues.issue_id.watchers.yml b/src/paths/issues.issue_id.watchers.yml
@@ -6,9 +6,9 @@ post:
   summary: Adding a watcher
   operationId: createWatcher
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
     - $ref: ../components/parameters/path/issue_id.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
   requestBody:
     content:
       application/json:

diff --git a/src/paths/issues.issue_id.yml b/src/paths/issues.issue_id.yml
@@ -6,9 +6,9 @@ get:
   summary: Showing an issue
   operationId: getIssue
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
     - $ref: ../components/parameters/path/issue_id.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - name: include
       in: query
       schema:
@@ -43,9 +43,9 @@ put:
   summary: Updating an issue
   operationId: updateIssue
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
     - $ref: ../components/parameters/path/issue_id.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
   requestBody:
     content:
       application/json:
@@ -108,9 +108,9 @@ delete:
   summary: Deleting an issue
   operationId: deleteIssue
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
     - $ref: ../components/parameters/path/issue_id.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
   responses:
     204:
       description: ""
diff --git a/src/paths/issues.yml b/src/paths/issues.yml
@@ -6,12 +6,12 @@ get:
   summary: Listing issues
   operationId: getIssues
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
-    - $ref: ../components/parameters/header/x_redmine_nometa.yml
     - $ref: ../components/parameters/path/format.yml
     - $ref: ../components/parameters/query/offset.yml
     - $ref: ../components/parameters/query/limit.yml
     - $ref: ../components/parameters/query/nometa.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
+    - $ref: ../components/parameters/header/x_redmine_nometa.yml
     - name: sort
       in: query
       schema:
@@ -87,8 +87,8 @@ post:
   summary: Creating an issue
   operationId: createIssue
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
   requestBody:
     content:
       application/json:

diff --git a/src/paths/journals.journal_id.yml b/src/paths/journals.journal_id.yml
@@ -4,9 +4,9 @@ put:
   summary: PUT
   operationId: updateJournal
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
     - $ref: ../components/parameters/path/journal_id.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
   requestBody:
     content:
       application/json:

diff --git a/src/paths/memberships.membership_id.yml b/src/paths/memberships.membership_id.yml
@@ -6,9 +6,9 @@ get:
   summary: GET
   operationId: getMembership
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
     - $ref: ../components/parameters/path/membership_id.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
   responses:
     200:
       description: ""
@@ -30,9 +30,9 @@ put:
   summary: PUT
   operationId: updateMembership
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
     - $ref: ../components/parameters/path/membership_id.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
   responses:
     204:
       description: ""
@@ -51,9 +51,9 @@ delete:
   summary: DELETE
   operationId: deleteMembership
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
     - $ref: ../components/parameters/path/membership_id.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
   responses:
     204:
       description: ""
diff --git a/src/paths/my_account.yml b/src/paths/my_account.yml
@@ -6,8 +6,8 @@ get:
   summary: GET
   operationId: getMyAccount
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
   responses:
     200:
       description: ""
@@ -24,8 +24,8 @@ put:
   summary: PUT
   operationId: updateMyAccount
   parameters:
-    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
     - $ref: ../components/parameters/path/format.yml
+    - $ref: ../components/parameters/header/x_redmine_switch_user.yml
   requestBody:
     content:
       application/json: