-
Notifications
You must be signed in to change notification settings - Fork 433
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Document package showlinked command with OpenAPI
- Loading branch information
Showing
3 changed files
with
71 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
17 changes: 17 additions & 0 deletions
17
src/api/public/apidocs-new/components/responses/unknown_project_or_package.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,17 @@ | ||
description: | | ||
Not Found. | ||
XML Schema used for body validation: [status.xsd](../schema/status.xsd) | ||
content: | ||
application/xml; charset=utf-8: | ||
schema: | ||
$ref: '../schemas/api_response.yaml' | ||
examples: | ||
Unknown Project: | ||
value: | ||
code: unknown_project | ||
summary: "Project not found: home:some_project" | ||
Unknown Package: | ||
value: | ||
code: unknown_package | ||
summary: "Package not found: home:some_project/some_package" |
48 changes: 48 additions & 0 deletions
48
src/api/public/apidocs-new/paths/source_project_name_package_name_cmd_showlinked.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,48 @@ | ||
post: | ||
summary: List all packages linking to this one. | ||
description: List all packages linking to this one. Despite using the method `POST`, this endpoint doesn't alter any data. | ||
security: | ||
- basic_authentication: [] | ||
parameters: | ||
- $ref: '../components/parameters/project_name.yaml' | ||
- $ref: '../components/parameters/package_name.yaml' | ||
responses: | ||
'200': | ||
description: OK | ||
content: | ||
application/xml; charset=utf-8: | ||
schema: | ||
type: array | ||
items: | ||
type: object | ||
properties: | ||
name: | ||
type: string | ||
xml: | ||
attribute: true | ||
project: | ||
type: string | ||
xml: | ||
attribute: true | ||
xml: | ||
name: package | ||
xml: | ||
name: collection | ||
wrapped : true | ||
examples: | ||
No results: | ||
value: | | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<collection/> | ||
Two linked packages: | ||
value: | ||
- name: hello_world | ||
project: home:Admin:branches:home:Admin | ||
- name: hello_world2 | ||
project: home:Admin:branches:home:Admin | ||
'401': | ||
$ref: '../components/responses/unauthorized.yaml' | ||
'404': | ||
$ref: '../components/responses/unknown_project_or_package.yaml' | ||
tags: | ||
- Sources - Packages |