-
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 routes with OpenAPI
- Loading branch information
Showing
4 changed files
with
101 additions
and
2 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
28 changes: 28 additions & 0 deletions
28
src/api/public/apidocs-new/components/schemas/issue_tracker.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,28 @@ | ||
type: object | ||
properties: | ||
name: | ||
type: string | ||
example: fate | ||
kind: | ||
type: string | ||
example: fate | ||
description: | ||
type: string | ||
example: openSUSE Feature Database | ||
url: | ||
type: string | ||
example: 'https://features.opensuse.org/' | ||
show-url: | ||
type: string | ||
example: 'https://features.opensuse.org/@@@' | ||
regex: | ||
type: string | ||
example: '(?:fate|Fate|FATE)\s*#\s*(\d+)' | ||
label: | ||
type: string | ||
example: 'fate#@@@' | ||
enable-fetch: | ||
type: string | ||
example: 'false' | ||
xml: | ||
name: issue-tracker |
7 changes: 7 additions & 0 deletions
7
src/api/public/apidocs-new/components/schemas/list_issue_trackers.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 @@ | ||
type: array | ||
items: | ||
$ref: 'issue_tracker.yaml' | ||
xml: | ||
name: issue-trackers | ||
wrapped: true | ||
|
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,62 @@ | ||
get: | ||
summary: Get the list of issue trackers. | ||
description: Get the list of issue trackers. | ||
security: | ||
- basic_authentication: [] | ||
responses: | ||
'200': | ||
description: | | ||
List of issue trackers. | ||
XML Schema used for body validation: [issue_trackers.rng](../schema/issue_trackers.rng) | ||
content: | ||
application/xml; charset=utf-8: | ||
schema: | ||
$ref: '../components/schemas/list_issue_trackers.yaml' | ||
'401': | ||
$ref: '../components/responses/unauthorized.yaml' | ||
tags: | ||
- Issue Trackers | ||
|
||
post: | ||
summary: Create an issue tracker. | ||
description: Create an issue tracker. | ||
security: | ||
- basic_authentication: [] | ||
requestBody: | ||
description: | | ||
Issue tracker definition. | ||
XML Schema used for body validation: [issue_tracker.rng](../schema/issue_tracker.rng) | ||
required: true | ||
content: | ||
application/xml; charset=utf-8: | ||
schema: | ||
$ref: '../components/schemas/issue_tracker.yaml' | ||
responses: | ||
'200': | ||
$ref: '../components/responses/succeeded.yaml' | ||
'400': | ||
description: | | ||
Validation failed. | ||
XML Schema used for body validation: [status.xsd](../schema/status.xsd) | ||
content: | ||
application/xml; charset=utf-8: | ||
schema: | ||
$ref: '../components/schemas/api_response.yaml' | ||
examples: | ||
empty_body: | ||
value: | ||
code: validation_failed | ||
summary: Document is empty, not allowed for issue_tracker | ||
summary: Empty Body | ||
wrong_xml_element: | ||
value: | ||
code: validation_failed | ||
summary: 'issue_tracker validation error: 1:0: ERROR: Expecting element issue-tracker, got foo' | ||
summary: Wrong XML Element | ||
'401': | ||
$ref: '../components/responses/unauthorized.yaml' | ||
tags: | ||
- Issue Trackers |