Repository navigation
Expand file tree
/
Copy pathworkflows.jsonnet
More file actions
188 lines (187 loc) · 5.83 KB
/
Copy pathworkflows.jsonnet
File metadata and controls
188 lines (187 loc) · 5.83 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
local openapi = import '../lib/openapi.libsonnet';
{
'/v1/workspaces/{workspaceId}/workflows': {
get: {
tags: ['Workflows'],
summary: 'List workflows',
operationId: 'listWorkflows',
description: 'Returns a list of workflows.',
parameters: [
openapi.workspaceIdParam(),
openapi.limitParam(),
openapi.offsetParam(),
],
responses: openapi.paginatedResponse(openapi.schemaRef('Workflow'))
+ openapi.badRequestResponse(),
},
post: {
tags: ['Workflows'],
summary: 'Create a workflow',
operationId: 'createWorkflow',
description: 'Creates a workflow.',
parameters: [
openapi.workspaceIdParam(),
],
requestBody: {
required: true,
content: {
'application/json': {
schema: openapi.schemaRef('CreateWorkflow'),
},
},
},
responses: openapi.createdResponse(openapi.schemaRef('Workflow'))
+ openapi.badRequestResponse()
+ {
'409': {
description: 'Workflow slug already exists in this workspace',
content: {
'application/json': {
schema: openapi.schemaRef('WorkflowSlugConflictResponse'),
},
},
},
},
},
},
'/v1/workspaces/{workspaceId}/workflows/slug/{slug}': {
get: {
tags: ['Workflows'],
summary: 'Get a workflow by slug',
operationId: 'getWorkflowBySlug',
description: 'Gets a workflow by its slug within the workspace.',
parameters: [
openapi.workspaceIdParam(),
openapi.stringParam('slug', 'Slug of the workflow'),
],
responses: openapi.okResponse(openapi.schemaRef('Workflow'))
+ openapi.notFoundResponse()
+ openapi.badRequestResponse(),
},
},
'/v1/workspaces/{workspaceId}/workflows/slug/{slug}/runs': {
post: {
tags: ['Workflows'],
summary: 'Create a workflow run by slug',
operationId: 'createWorkflowRunBySlug',
description: 'Creates a new run for a workflow identified by slug.',
parameters: [
openapi.workspaceIdParam(),
openapi.stringParam('slug', 'Slug of the workflow'),
],
requestBody: {
required: true,
content: {
'application/json': {
schema: {
type: 'object',
required: ['inputs'],
properties: {
inputs: {
type: 'object',
additionalProperties: true,
description: 'Input values for the workflow run.',
},
},
},
},
},
},
responses: openapi.createdResponse(openapi.schemaRef('WorkflowRun'))
+ openapi.notFoundResponse()
+ openapi.badRequestResponse(),
},
},
'/v1/workspaces/{workspaceId}/workflows/{workflowId}': {
get: {
tags: ['Workflows'],
summary: 'Get a workflow',
operationId: 'getWorkflow',
description: 'Gets a workflow by ID.',
parameters: [
openapi.workspaceIdParam(),
openapi.workflowIdParam(),
],
responses: openapi.okResponse(openapi.schemaRef('Workflow'))
+ openapi.notFoundResponse()
+ openapi.badRequestResponse(),
},
put: {
tags: ['Workflows'],
summary: 'Update a workflow',
operationId: 'updateWorkflow',
description: 'Updates a workflow template.',
parameters: [
openapi.workspaceIdParam(),
openapi.workflowIdParam(),
],
requestBody: {
required: true,
content: {
'application/json': {
schema: openapi.schemaRef('UpdateWorkflow'),
},
},
},
responses: openapi.acceptedResponse(openapi.schemaRef('Workflow'))
+ openapi.notFoundResponse()
+ openapi.badRequestResponse()
+ {
'409': {
description: 'Workflow slug already exists in this workspace',
content: {
'application/json': {
schema: openapi.schemaRef('WorkflowSlugConflictResponse'),
},
},
},
},
},
delete: {
tags: ['Workflows'],
summary: 'Delete a workflow',
operationId: 'deleteWorkflow',
description: 'Deletes a workflow.',
parameters: [
openapi.workspaceIdParam(),
openapi.workflowIdParam(),
],
responses: openapi.acceptedResponse(openapi.schemaRef('Workflow'), 'Workflow deleted')
+ openapi.notFoundResponse()
+ openapi.badRequestResponse(),
},
},
'/v1/workspaces/{workspaceId}/workflows/{workflowId}/runs': {
post: {
tags: ['Workflows'],
summary: 'Create a workflow run',
operationId: 'createWorkflowRun',
description: 'Creates a new run for a workflow.',
parameters: [
openapi.workspaceIdParam(),
openapi.workflowIdParam(),
],
requestBody: {
required: true,
content: {
'application/json': {
schema: {
type: 'object',
required: ['inputs'],
properties: {
inputs: {
type: 'object',
additionalProperties: true,
description: 'Input values for the workflow run.',
},
},
},
},
},
},
responses: openapi.createdResponse(openapi.schemaRef('WorkflowRun'))
+ openapi.notFoundResponse()
+ openapi.badRequestResponse(),
},
},
}