Skip to content

Commit

Permalink
Fix lint error
Browse files Browse the repository at this point in the history
  • Loading branch information
d-yoshi committed Apr 27, 2024
1 parent 41a7532 commit fb6296d
Show file tree
Hide file tree
Showing 46 changed files with 111 additions and 25 deletions.
12 changes: 9 additions & 3 deletions src/openapi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,17 @@ openapi: 3.0.3

info:
title: Redmine API
description: "NOTE: This is unofficial OpenAPI specification file."
version: 5.0.0
description: "Unofficial OpenAPI specification for the Redmine API."
contact:
name: d-yoshi/redmine-openapi
url: https://github.com/d-yoshi/redmine-openapi
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
version: 1.0.0

servers:
- url: /

externalDocs:
description: Redmine API Official Developer Guide
Expand Down Expand Up @@ -79,7 +85,7 @@ paths:

/versions/{version_id}.{format}:
$ref: ./paths/versions.version_id.yml

/projects/{project_id}/wiki/index.{format}:
$ref: ./paths/projects.project_id.wiki.index.yml

Expand Down
5 changes: 4 additions & 1 deletion src/paths/attachments.attachment_id.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ get:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_Attachments#GET
summary: GET
operationId: getAttachment
parameters:
- $ref: ../components/parameters/path/format.yml
- $ref: ../components/parameters/path/attachment_id.yml
Expand All @@ -24,6 +25,7 @@ patch:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_Attachments#PATCH
summary: PATCH
operationId: updateAttachment
parameters:
- $ref: ../components/parameters/path/format.yml
- $ref: ../components/parameters/path/attachment_id.yml
Expand All @@ -50,9 +52,10 @@ delete:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_Attachments#DELETE
summary: DELETE
operationId: deleteAttachment
parameters:
- $ref: ../components/parameters/path/format.yml
- $ref: ../components/parameters/path/attachment_id.yml
responses:
204:
description: ""
description: ""
1 change: 1 addition & 0 deletions src/paths/custom_fields.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ get:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_CustomFields#GET
summary: GET
operationId: getCustomFields
parameters:
- $ref: ../components/parameters/path/format.yml
responses:
Expand Down
3 changes: 2 additions & 1 deletion src/paths/enumerations.document_categories.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ get:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_Enumerations#GET-3
summary: GET
operationId: getDocumentCategories
parameters:
- $ref: ../components/parameters/path/format.yml
responses:
Expand All @@ -19,4 +20,4 @@ get:
document_categories:
type: array
items:
$ref: ../components/schemas/DocumentCategory.yml
$ref: ../components/schemas/DocumentCategory.yml
3 changes: 2 additions & 1 deletion src/paths/enumerations.issue_priorities.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ get:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_Enumerations#GET
summary: GET
operationId: getIssuePriorities
parameters:
- $ref: ../components/parameters/path/format.yml
responses:
Expand All @@ -19,4 +20,4 @@ get:
issue_priorities:
type: array
items:
$ref: ../components/schemas/IssuePriority.yml
$ref: ../components/schemas/IssuePriority.yml
3 changes: 2 additions & 1 deletion src/paths/enumerations.time_entry_activities.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ get:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_Enumerations#GET-2
summary: GET
operationId: getTimeEntryActivities
parameters:
- $ref: ../components/parameters/path/format.yml
responses:
Expand All @@ -19,4 +20,4 @@ get:
time_entry_activities:
type: array
items:
$ref: ../components/schemas/TimeEntryActivity.yml
$ref: ../components/schemas/TimeEntryActivity.yml
1 change: 1 addition & 0 deletions src/paths/groups.group_id.users.user_id.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ delete:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_Groups#DELETE-2
summary: DELETE
operationId: removeUserFromGroup
parameters:
- $ref: ../components/parameters/path/format.yml
- $ref: ../components/parameters/path/group_id.yml
Expand Down
1 change: 1 addition & 0 deletions src/paths/groups.group_id.users.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ post:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_Groups#POST-2
summary: POST
operationId: addUserToGroup
parameters:
- $ref: ../components/parameters/path/format.yml
- $ref: ../components/parameters/path/group_id.yml
Expand Down
3 changes: 3 additions & 0 deletions src/paths/groups.group_id.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ get:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_Groups#GET-2
summary: GET
operationId: getGroup
parameters:
- $ref: ../components/parameters/path/format.yml
- $ref: ../components/parameters/path/group_id.yml
Expand Down Expand Up @@ -54,6 +55,7 @@ put:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_Groups#PUT
summary: PUT
operationId: updateGroup
parameters:
- $ref: ../components/parameters/path/format.yml
- $ref: ../components/parameters/path/group_id.yml
Expand Down Expand Up @@ -84,6 +86,7 @@ delete:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_Groups#DELETE
summary: DELETE
operationId: deleteGroup
parameters:
- $ref: ../components/parameters/path/format.yml
- $ref: ../components/parameters/path/group_id.yml
Expand Down
2 changes: 2 additions & 0 deletions src/paths/groups.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ get:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_Groups#GET
summary: GET
operationId: getGroups
parameters:
- $ref: ../components/parameters/path/format.yml
responses:
Expand All @@ -27,6 +28,7 @@ post:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_Groups#POST
summary: POST
operationId: createGroup
parameters:
- $ref: ../components/parameters/path/format.yml
requestBody:
Expand Down
3 changes: 3 additions & 0 deletions src/paths/issue_categories.issue_category_id.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ get:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_IssueCategories#GET-2
summary: GET
operationId: getIssueCategory
parameters:
- $ref: ../components/parameters/path/format.yml
- $ref: ../components/parameters/path/issue_category_id.yml
Expand All @@ -26,6 +27,7 @@ put:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_IssueCategories#PUT
summary: PUT
operationId: updateIssueCategory
parameters:
- $ref: ../components/parameters/path/format.yml
- $ref: ../components/parameters/path/issue_category_id.yml
Expand Down Expand Up @@ -60,6 +62,7 @@ delete:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_IssueCategories#DELETE
summary: DELETE
operationId: deleteIssueCategory
parameters:
- $ref: ../components/parameters/path/format.yml
- $ref: ../components/parameters/path/issue_category_id.yml
Expand Down
2 changes: 1 addition & 1 deletion src/paths/issue_statuses.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ get:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_IssueStatuses#GET
summary: Returns possible Status Values for Issues
operationId: getIssueStatuses
parameters:
- $ref: ../components/parameters/path/format.yml
responses:
Expand All @@ -13,4 +14,3 @@ get:
application/json:
schema:
$ref: ../components/schemas/IssueStatuses.yml

5 changes: 3 additions & 2 deletions src/paths/issues.issue_id.relations.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@

get:
tags:
- Issue Relations
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_IssueRelations#GET
summary: GET
operationId: getIssueRelationsByIssue
parameters:
- $ref: ../components/parameters/path/format.yml
- $ref: ../components/parameters/path/issue_id.yml
Expand All @@ -29,6 +29,7 @@ post:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_IssueRelations#POST
summary: POST
operationId: createIssueRelationsByIssue
parameters:
- $ref: ../components/parameters/path/format.yml
- $ref: ../components/parameters/path/issue_id.yml
Expand Down Expand Up @@ -71,4 +72,4 @@ post:
content:
application/json:
schema:
$ref: ../components/schemas/Errors.yml
$ref: ../components/schemas/Errors.yml
1 change: 1 addition & 0 deletions src/paths/issues.issue_id.watchers.user_id.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ delete:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_Issues#Removing-a-watcher
summary: Removing a watcher
operationId: deleteWatcher
parameters:
- $ref: ../components/parameters/path/format.yml
- $ref: ../components/parameters/path/issue_id.yml
Expand Down
1 change: 1 addition & 0 deletions src/paths/issues.issue_id.watchers.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ post:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_Issues#Adding-a-watcher
summary: Adding a watcher
operationId: createWatcher
parameters:
- $ref: ../components/parameters/path/format.yml
- $ref: ../components/parameters/path/issue_id.yml
Expand Down
3 changes: 3 additions & 0 deletions src/paths/issues.issue_id.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ get:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_Issues#Showing-an-issue
summary: Showing an issue
operationId: getIssue
parameters:
- $ref: ../components/parameters/path/format.yml
- $ref: ../components/parameters/path/issue_id.yml
Expand Down Expand Up @@ -45,6 +46,7 @@ put:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_Issues#Updating-an-issue
summary: Updating an issue
operationId: updateIssue
parameters:
- $ref: ../components/parameters/path/format.yml
- $ref: ../components/parameters/path/issue_id.yml
Expand Down Expand Up @@ -126,6 +128,7 @@ delete:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_Issues#Deleting-an-issue
summary: Deleting an issue
operationId: deleteIssue
parameters:
- $ref: ../components/parameters/path/format.yml
- $ref: ../components/parameters/path/issue_id.yml
Expand Down
2 changes: 2 additions & 0 deletions src/paths/issues.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ get:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_Issues#Listing-issues
summary: Listing issues
operationId: getIssues
parameters:
- $ref: ../components/parameters/path/format.yml
- $ref: ../components/parameters/query/offset.yml
Expand Down Expand Up @@ -91,6 +92,7 @@ post:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_Issues#Creating-an-issue
summary: Creating an issue
operationId: createIssue
parameters:
- $ref: ../components/parameters/path/format.yml
requestBody:
Expand Down
1 change: 1 addition & 0 deletions src/paths/journals.journal_id.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ put:
tags:
- Journals
summary: PUT
operationId: updateJournal
parameters:
- $ref: ../components/parameters/path/format.yml
- $ref: ../components/parameters/path/journal_id.yml
Expand Down
9 changes: 6 additions & 3 deletions src/paths/memberships.membership_id.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@ get:
- Project Memberships
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_Memberships#GET-2
summary: GET
operationId: getMembership
parameters:
- $ref: ../components/parameters/path/project_id.yml
- $ref: ../components/parameters/path/membership_id.yml
- $ref: ../components/parameters/path/format.yml
responses:
Expand All @@ -25,8 +26,9 @@ put:
- Project Memberships
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_Memberships#PUT
summary: PUT
operationId: updateMembership
parameters:
- $ref: ../components/parameters/path/project_id.yml
- $ref: ../components/parameters/path/membership_id.yml
- $ref: ../components/parameters/path/format.yml
responses:
Expand All @@ -44,8 +46,9 @@ delete:
- Project Memberships
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_Memberships#DELETE
summary: DELETE
operationId: deleteMembership
parameters:
- $ref: ../components/parameters/path/project_id.yml
- $ref: ../components/parameters/path/membership_id.yml
- $ref: ../components/parameters/path/format.yml
responses:
Expand Down
2 changes: 2 additions & 0 deletions src/paths/my_account.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ get:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_MyAccount#GET
summary: GET
operationId: getMyAccount
parameters:
- $ref: ../components/parameters/path/format.yml
responses:
Expand All @@ -28,6 +29,7 @@ put:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_MyAccount#PUT
summary: PUT
operationId: updateMyAccount
parameters:
- $ref: ../components/parameters/path/format.yml
requestBody:
Expand Down
1 change: 1 addition & 0 deletions src/paths/news.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ get:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_News#GET
summary: GET
operationId: getNews
parameters:
- $ref: ../components/parameters/path/format.yml
responses:
Expand Down
2 changes: 2 additions & 0 deletions src/paths/projects.project_id.archive.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ put:
- Projects
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_Projects#Archiving-a-project
summary: Archiving a project
operationId: archiveProject
parameters:
- $ref: ../components/parameters/path/format.yml
- $ref: ../components/parameters/path/project_id.yml
Expand Down
4 changes: 3 additions & 1 deletion src/paths/projects.project_id.files.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ get:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_Files#GET
summary: GET
operationId: getFiles
parameters:
- $ref: ../components/parameters/path/format.yml
- $ref: ../components/parameters/path/project_id.yml
Expand All @@ -28,6 +29,7 @@ post:
externalDocs:
url: https://www.redmine.org/projects/redmine/wiki/Rest_Files#POST
summary: POST
operationId: createFile
parameters:
- $ref: ../components/parameters/path/format.yml
- $ref: ../components/parameters/path/project_id.yml
Expand Down Expand Up @@ -74,4 +76,4 @@ post:
filename:
type: string
description:
type: string
type: string
Loading

0 comments on commit fb6296d

Please sign in to comment.