Commit 796aa025 authored by Swapnil's avatar Swapnil
Browse files

Update WorkflowServceAPI-WIP.yaml

parent 36bc4e2c
Pipeline #9926 passed with stages
in 19 minutes and 9 seconds
......@@ -10,8 +10,8 @@ info:
**Workflow Run** - Workflow Run is single execution of a workflow. For example, a CSV workflow executed to ingest a CSV is CSV workflow run.
In case of Airflow as orchestrator, a workflow run will be equivalent to one dag run.
Each instance of workflow run is represented by unique run id. ({runId}).
version: 2.0.8
Each instance of workflow run is represented by unique run id. ({runId}).
version: 2.0.5
title: Workflow Service API
contact:
email: sdubey7@slb.com
......@@ -72,7 +72,157 @@ paths:
schema:
$ref: '#/components/schemas/workflow'
description: Request payload for deploying new workflow.
get:
tags:
- Workflow
summary: List all the workflow applicable for a tenant.
operationId: listAllWorkflow
description: List all the workflows for the tenant.
parameters:
- name: prefix
in: query
description: 'Filter workflow names which start with the full prefix specified.'
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/workflow'
type: array
description: List of all the workflows.
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/error'
'401':
description: Invalid/Expired Credential
content:
application/json:
schema:
$ref: '#/components/schemas/error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/error'
/workflow/{id}:
delete:
tags:
- Workflow
summary: Delete a workflow defintion.
operationId: deleteWorkflow
description: Delete a workflow by id specified.
parameters:
- name: id
in: path
description: Specify the workflow id to delete.
required: true
schema:
type: string
responses:
'204':
description: Workflow deleted successfully.
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/error'
'401':
description: Invalid/Expired Credential
content:
application/json:
schema:
$ref: '#/components/schemas/error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/error'
get:
tags:
- Workflow
summary: Get complete details for a workflow.
operationId: viewWorkflow
description: Get complete details for an workflow.
parameters:
- name: id
in: path
description: Workflow id.
required: true
schema:
type: string
responses:
'200':
description: Workflow Details.
content:
application/json:
schema:
$ref: '#/components/schemas/workflow'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/error'
'401':
description: Invalid/Expired Credential
content:
application/json:
schema:
$ref: '#/components/schemas/error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/error'
/workflow/{id}/workflowRun:
post:
tags:
......@@ -129,7 +279,100 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/error'
get:
tags:
- Workflow Run
summary: Get all run instances of a workflow.
operationId: getAllWorkflowRuns
description: Get all run instances for a worflow.
parameters:
- name: id
in: path
description: Workflow id for which the execution details has to be fetched.
required: true
schema:
type: string
- name: prefix
in: query
description: 'A prefix used when generating the runId of the workflow run. Prefix cannot contain the word "backfill"'
required: false
schema:
type: string
- name: startDate
in: query
description: 'The start date where this call should start creating workflow runs from (inclusive)'
required: false
schema:
type: string
- name: endDate
in: query
description: 'The end date where this call should stop creating workflow runs at (inclusive)'
required: false
schema:
type: boolean
- name: limit
in: query
description: 'The maximum number of workflow runs to create in a single request. Maximum is 500.'
required: false
schema:
type: integer
- name: cursor
in: query
description: 'Cursor for subsequent request.'
required: false
schema:
type: string
- name: partial
in: query
description: 'Whether or not a partial batch can be created. If true, and the number of workflow runs that would be created between the start and end exceeds the limit, no workflow runs will be created.'
required: false
schema:
type: boolean
- name: conf
in: query
description: 'JSON configuration added to the Workflow run conf attribute'
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/workflowRun'
type: array
description: History of workflow runs.
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/error'
'401':
description: Invalid/Expired Credential
content:
application/json:
schema:
$ref: '#/components/schemas/error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/error'
/workflow/{id}/workflowRun/{runId}:
get:
......@@ -248,7 +491,64 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/error'
$ref: '#/components/schemas/error'
/workflow/{id}/:
put:
tags:
- Workflow
summary: API to update the re-configurable propoerties of the workflow.
operationId: updateWorkflow
description: Update the re-configurable properties of a workflow.
parameters:
- name: id
in: path
description: Workflow id.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/workflow'
responses:
'200':
description: Workflow updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/workflow'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/error'
'401':
description: Invalid/Expired Credential
content:
application/json:
schema:
$ref: '#/components/schemas/error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/error'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/error'
servers:
- url: 'https://virtserver.swaggerhub.com/SLB-DELFI/WorkflowServceAPI/1.0.0'
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment