Skip to content

Commit

Permalink
Document POST staging workflow endpoint
Browse files Browse the repository at this point in the history
Endpoint: POST `staging/{staging_workflow_project}/workflow`
  • Loading branch information
saraycp committed Apr 24, 2023
1 parent 9ae65b2 commit 2277f2f
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
type: object
properties:
managers:
type: string
example: group-test
xml:
attribute: true
xml:
name: workflow
Original file line number Diff line number Diff line change
@@ -1,3 +1,54 @@
post:
summary: Create a staging workflow for the specified project
description: |
Create a staging workflow associated to the project and the manager group specified in the body of the request
security:
- basic_authentication: []
parameters:
- $ref: '../components/parameters/project_name.yaml'
requestBody:
description: "Title of the staging workflow's managers group"
content:
application/xml; charset=utf-8:
schema:
$ref: '../components/schemas/staging/managers_group.yaml'
responses:
'200':
$ref: '../components/responses/succeeded.yaml'
'401':
$ref: '../components/responses/unauthorized.yaml'
'400':
description: |
Bad Request.
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:
Staging Workflow Exists:
description: The project is already associated to a staging workflow
value:
code: staging_workflow_exists
summary: "Project project_name already has an associated Staging Workflow with id: ID"
Invalid XML Format:
value:
code: invalid_xml_format
summary: 'XML format is not valid'
Empty Body:
value:
code: invalid_request
summary: 'Empty body'
Invalid Request:
value:
code: invalid_request
summary: "Staging for project_name couldn't be created:"
'404':
$ref: '../components/responses/unknown_project.yaml'
tags:
- Staging Workflow

delete:
summary: Delete the staging workflow of the specified project
description: |
Expand Down

0 comments on commit 2277f2f

Please sign in to comment.