-
Notifications
You must be signed in to change notification settings - Fork 437
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Document /issue_trackers/<name>/issues/<issue_name>
... routes with OpenAPI.
- Loading branch information
Showing
4 changed files
with
65 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 changes: 7 additions & 0 deletions
7
src/api/public/apidocs-new/components/parameters/issue_name.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
in: path | ||
name: issue_name | ||
schema: | ||
type: string | ||
required: true | ||
description: Issue name. | ||
example: 12345 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
type: object | ||
properties: | ||
created_at: | ||
type: string | ||
example: '2021-01-18 19:17:51 UTC' | ||
updated_at: | ||
type: string | ||
example: '2021-01-18 19:17:51 UTC' | ||
name: | ||
type: string | ||
example: 12345 | ||
tracker: | ||
type: string | ||
example: fate | ||
label: | ||
type: string | ||
example: 'fate#12345' | ||
url: | ||
type: string | ||
example: 'https://features.opensuse.org/12345' | ||
xml: | ||
name: issue |
34 changes: 34 additions & 0 deletions
34
src/api/public/apidocs-new/paths/issue_trackers_issue_tracker_name_issues_issue_name.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
get: | ||
summary: Show an issue of an issue tracker. | ||
description: Show an issue of an issue tracker. | ||
security: | ||
- basic_authentication: [] | ||
parameters: | ||
- $ref: '../components/parameters/issue_name.yaml' | ||
responses: | ||
'200': | ||
description: | | ||
Issue definition. | ||
XML Schema used for body validation: [issue.rng](../schema/issue.rng) | ||
content: | ||
application/xml; charset=utf-8: | ||
schema: | ||
$ref: '../components/schemas/issue.yaml' | ||
'401': | ||
$ref: '../components/responses/unauthorized.yaml' | ||
'404': | ||
description: | | ||
Not Found. | ||
XML Schema used for body validation: [status.xsd](../schema/status.xsd) | ||
content: | ||
application/xml; charset=utf-8: | ||
schema: | ||
$ref: '../components/schemas/api_response.yaml' | ||
example: | ||
code: issue_tracker_not_found | ||
summary: Error: Issue Tracker 'foo' not found. | ||
tags: | ||
- Issue Trackers | ||
|