Skip to content

Commit 13ef89f

Browse files
fiftinfiftin
committed
docs: update swagger on web
1 parent 7b47c2e commit 13ef89f

File tree

1 file changed

+98
-81
lines changed

1 file changed

+98
-81
lines changed

‎web/public/swagger/api-docs.yml

Lines changed: 98 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ info:
55
description: |
66
Semaphore API provides endpoints for managing and interacting with the Semaphore UI.
77
This documentation outlines the available operations and data models.
8-
version: "2.14.0-beta1"
8+
version: "2.16.11"
99

1010
consumes:
1111
- application/json
@@ -159,16 +159,12 @@ definitions:
159159
alert:
160160
type: boolean
161161
alert_chat:
162-
type:
163-
- string
164-
- 'null'
162+
type: string
165163
max_parallel_tasks:
166164
type: integer
167165
minimum: 0
168166
type:
169-
type:
170-
- string
171-
- 'null'
167+
type: string
172168
templates:
173169
type: array
174170
items:
@@ -187,39 +183,27 @@ definitions:
187183
playbook:
188184
type: string
189185
arguments:
190-
type:
191-
- string
192-
- 'null'
186+
type: string
193187
description:
194188
type: string
195189
allow_override_args_in_task:
196190
type: boolean
197191
suppress_success_alerts:
198192
type: boolean
199193
cron:
200-
type:
201-
- string
202-
- 'null'
194+
type: string
203195
build_template:
204-
type:
205-
- string
206-
- 'null'
196+
type: string
207197
autorun:
208198
type: boolean
209199
survey_vars:
210-
type:
211-
- string
212-
- 'null'
200+
type: string
213201
start_version:
214-
type:
215-
- string
216-
- 'null'
202+
type: string
217203
type:
218204
type: string
219205
vault_key:
220-
type:
221-
- string
222-
- 'null'
206+
type: string
223207
allow_override_branch_in_task:
224208
type: boolean
225209
repositories:
@@ -265,13 +249,9 @@ definitions:
265249
inventory:
266250
type: string
267251
ssh_key:
268-
type:
269-
- string
270-
- 'null'
252+
type: string
271253
become_key:
272-
type:
273-
- string
274-
- 'null'
254+
type: string
275255
type:
276256
type: string
277257
enum: [static, static-yaml, file]
@@ -283,15 +263,11 @@ definitions:
283263
name:
284264
type: string
285265
password:
286-
type:
287-
- string
288-
- 'null'
266+
type: string
289267
json:
290268
type: string
291269
env:
292-
type:
293-
- string
294-
- 'null'
270+
type: string
295271

296272
APIToken:
297273
type: object
@@ -316,17 +292,13 @@ definitions:
316292
alert:
317293
type: boolean
318294
alert_chat:
319-
type:
320-
- string
321-
- 'null'
295+
type: string
322296
example: Test
323297
max_parallel_tasks:
324298
type: integer
325299
minimum: 0
326300
type:
327-
type:
328-
- string
329-
- 'null'
301+
type: string
330302
demo:
331303
description: Create Demo project resources?
332304
type: boolean
@@ -345,17 +317,13 @@ definitions:
345317
alert:
346318
type: boolean
347319
alert_chat:
348-
type:
349-
- string
350-
- 'null'
320+
type: string
351321
example: Test
352322
max_parallel_tasks:
353323
type: integer
354324
minimum: 0
355325
type:
356-
type:
357-
- string
358-
- 'null'
326+
type: string
359327

360328
AccessKeyRequest:
361329
type: object
@@ -435,6 +403,7 @@ definitions:
435403
type: integer
436404
name:
437405
type: string
406+
example: Test
438407
secret:
439408
type: string
440409
type:
@@ -556,6 +525,8 @@ definitions:
556525
template_id:
557526
type: integer
558527
minimum: 1
528+
params:
529+
$ref: '#/definitions/TaskPrams'
559530

560531
IntegrationRequest:
561532
type: object
@@ -567,6 +538,8 @@ definitions:
567538
type: integer
568539
template_id:
569540
type: integer
541+
params:
542+
$ref: '#/definitions/TaskPrams'
570543

571544
IntegrationExtractValueRequest:
572545
type: object
@@ -682,6 +655,7 @@ definitions:
682655
example: master
683656
ssh_key_id:
684657
type: integer
658+
685659
Repository:
686660
type: object
687661
properties:
@@ -717,25 +691,72 @@ definitions:
717691
type: string
718692
secret:
719693
type: string
694+
arguments:
695+
type: string
720696
git_branch:
721-
type:
722-
- string
723-
- 'null'
724-
limit:
725697
type: string
698+
message:
699+
type: string
700+
inventory_id:
701+
type: integer
726702
params:
727-
type: object
728-
properties:
729-
debug:
730-
type: boolean
731-
dry_run:
732-
type: boolean
733-
diff:
734-
type: boolean
735-
limit:
736-
type: array
703+
allOf:
704+
- $ref: '#/definitions/AnsibleTaskParams'
705+
- $ref: '#/definitions/TerraformTaskParams'
706+
limit:
707+
type: string
708+
709+
AnsibleTaskParams:
710+
type: object
711+
properties:
712+
debug:
713+
type: boolean
714+
dry_run:
715+
type: boolean
716+
diff:
717+
type: boolean
718+
limit:
719+
type: array
720+
items:
721+
type: string
722+
tags:
723+
type: array
724+
items:
725+
type: string
726+
skip_tags:
727+
type: array
728+
items:
729+
type: string
730+
731+
TerraformTaskParams:
732+
type: object
733+
properties:
734+
plan:
735+
type: boolean
736+
destroy:
737+
type: boolean
738+
auto_approve:
739+
type: boolean
740+
upgrade:
741+
type: boolean
742+
743+
TaskPrams:
744+
type: object
745+
properties:
746+
environment:
747+
type: string
748+
git_branch:
749+
type: string
737750
message:
738751
type: string
752+
inventory_id:
753+
type: integer
754+
arguments:
755+
type: string
756+
params:
757+
allOf:
758+
- $ref: '#/definitions/AnsibleTaskParams'
759+
- $ref: '#/definitions/TerraformTaskParams'
739760

740761
TaskOutput:
741762
type: object
@@ -860,13 +881,9 @@ definitions:
860881
type: string
861882
enum: ["", build, deploy]
862883
start_version:
863-
type:
864-
- string
865-
- 'null'
884+
type: string
866885
build_template_id:
867-
type:
868-
- integer
869-
- 'null'
886+
type: integer
870887
autorun:
871888
type: boolean
872889
survey_vars:
@@ -919,13 +936,9 @@ definitions:
919936
enum: [password, script]
920937
example: script
921938
vault_key_id:
922-
type:
923-
- integer
924-
- 'null'
939+
type: integer
925940
script:
926-
type:
927-
- string
928-
- 'null'
941+
type: string
929942
example: path/to/script-client.py
930943

931944
ScheduleRequest:
@@ -945,6 +958,8 @@ definitions:
945958
type: string
946959
active:
947960
type: boolean
961+
params:
962+
$ref: '#/definitions/TaskPrams'
948963

949964
Schedule:
950965
type: object
@@ -961,6 +976,8 @@ definitions:
961976
type: string
962977
active:
963978
type: boolean
979+
params:
980+
$ref: '#/definitions/TaskPrams'
964981

965982
ViewRequest:
966983
type: object
@@ -1000,13 +1017,9 @@ definitions:
10001017
user_id:
10011018
type: integer
10021019
object_id:
1003-
type:
1004-
- integer
1005-
- 'null'
1020+
type: integer
10061021
object_type:
1007-
type:
1008-
- string
1009-
- 'null'
1022+
type: string
10101023
description:
10111024
type: string
10121025

@@ -2366,6 +2379,10 @@ paths:
23662379
type: string
23672380
message:
23682381
type: string
2382+
arguments:
2383+
type: string
2384+
inventory_id:
2385+
type: integer
23692386
responses:
23702387
201:
23712388
description: Task queued

0 commit comments

Comments
 (0)