Skip to content

Commit fe233cb

Browse files
committed
docs(swagger): fix field type
1 parent 3fe356c commit fe233cb

File tree

2 files changed

+41
-43
lines changed

2 files changed

+41
-43
lines changed

api-docs.yml

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1420,7 +1420,7 @@ paths:
14201420
/projects:
14211421
get:
14221422
tags:
1423-
- projects
1423+
- project
14241424
summary: Get projects
14251425
responses:
14261426
200:
@@ -1431,7 +1431,7 @@ paths:
14311431
$ref: "#/definitions/Project"
14321432
post:
14331433
tags:
1434-
- projects
1434+
- project
14351435
summary: Create a new project
14361436
consumes:
14371437
- application/json
@@ -1450,7 +1450,7 @@ paths:
14501450
/projects/restore:
14511451
post:
14521452
tags:
1453-
- projects
1453+
- project
14541454
summary: Restore Project
14551455
consumes:
14561456
- application/json
@@ -1661,7 +1661,7 @@ paths:
16611661
- $ref: "#/parameters/project_id"
16621662
get:
16631663
tags:
1664-
- project
1664+
- integration
16651665
summary: get all integrations
16661666
responses:
16671667
200:
@@ -1673,7 +1673,7 @@ paths:
16731673
post:
16741674
summary: create a new integration
16751675
tags:
1676-
- project
1676+
- integration
16771677
parameters:
16781678
- name: Integration
16791679
in: body
@@ -1691,7 +1691,7 @@ paths:
16911691
- $ref: "#/parameters/integration_id"
16921692
put:
16931693
tags:
1694-
- project
1694+
- integration
16951695
summary: Update Integration
16961696
parameters:
16971697
- name: Integration
@@ -1704,7 +1704,7 @@ paths:
17041704
description: Integration updated
17051705
delete:
17061706
tags:
1707-
- project
1707+
- integration
17081708
summary: Remove integration
17091709
responses:
17101710
204:
@@ -1726,7 +1726,7 @@ paths:
17261726
$ref: "#/definitions/IntegrationExtractValue"
17271727
post:
17281728
tags:
1729-
- project
1729+
- integration
17301730
summary: Add Integration Extracted Value
17311731
parameters:
17321732
- name: Integration Extracted Value
@@ -1783,7 +1783,7 @@ paths:
17831783
$ref: "#/definitions/IntegrationMatcher"
17841784
post:
17851785
tags:
1786-
- project
1786+
- integration
17871787
summary: Add Integration Matcher
17881788
parameters:
17891789
- name: Integration Matcher
@@ -1830,7 +1830,7 @@ paths:
18301830
- $ref: "#/parameters/project_id"
18311831
get:
18321832
tags:
1833-
- project
1833+
- key store
18341834
summary: Get access keys linked to project
18351835
parameters:
18361836
# TODO - the space in this parameter name results in a dredd warning
@@ -1864,7 +1864,7 @@ paths:
18641864
$ref: "#/definitions/AccessKey"
18651865
post:
18661866
tags:
1867-
- project
1867+
- key store
18681868
summary: Add access key
18691869
parameters:
18701870
- name: Access Key
@@ -1885,7 +1885,7 @@ paths:
18851885
- $ref: "#/parameters/key_id"
18861886
put:
18871887
tags:
1888-
- project
1888+
- key store
18891889
summary: Updates access key
18901890
parameters:
18911891
- name: Access Key
@@ -1900,7 +1900,7 @@ paths:
19001900
description: Bad type
19011901
delete:
19021902
tags:
1903-
- project
1903+
- key store
19041904
summary: Removes access key
19051905
responses:
19061906
204:
@@ -1912,7 +1912,7 @@ paths:
19121912
- $ref: "#/parameters/project_id"
19131913
get:
19141914
tags:
1915-
- project
1915+
- repository
19161916
summary: Get repositories
19171917
parameters:
19181918
- name: sort
@@ -1937,7 +1937,7 @@ paths:
19371937
$ref: "#/definitions/Repository"
19381938
post:
19391939
tags:
1940-
- project
1940+
- repository
19411941
summary: Add repository
19421942
parameters:
19431943
- name: Repository
@@ -1957,7 +1957,7 @@ paths:
19571957
- $ref: "#/parameters/repository_id"
19581958
get:
19591959
tags:
1960-
- project
1960+
- repository
19611961
summary: Get repository
19621962
responses:
19631963
200:
@@ -1966,7 +1966,7 @@ paths:
19661966
$ref: "#/definitions/Repository"
19671967
put:
19681968
tags:
1969-
- project
1969+
- repository
19701970
summary: Updates repository
19711971
parameters:
19721972
- name: Repository
@@ -1981,7 +1981,7 @@ paths:
19811981
description: Bad request
19821982
delete:
19831983
tags:
1984-
- project
1984+
- repository
19851985
summary: Removes repository
19861986
responses:
19871987
204:
@@ -1993,7 +1993,7 @@ paths:
19931993
- $ref: "#/parameters/project_id"
19941994
get:
19951995
tags:
1996-
- project
1996+
- inventory
19971997
summary: Get inventory
19981998
parameters:
19991999
- name: sort
@@ -2017,7 +2017,7 @@ paths:
20172017
$ref: "#/definitions/Inventory"
20182018
post:
20192019
tags:
2020-
- project
2020+
- inventory
20212021
summary: create inventory
20222022
parameters:
20232023
- name: Inventory
@@ -2036,7 +2036,7 @@ paths:
20362036
- $ref: "#/parameters/inventory_id"
20372037
get:
20382038
tags:
2039-
- project
2039+
- inventory
20402040
summary: Get inventory
20412041
responses:
20422042
200:
@@ -2045,7 +2045,7 @@ paths:
20452045
$ref: "#/definitions/Inventory"
20462046
put:
20472047
tags:
2048-
- project
2048+
- inventory
20492049
summary: Updates inventory
20502050
parameters:
20512051
- name: Inventory
@@ -2058,7 +2058,7 @@ paths:
20582058
description: Inventory updated
20592059
delete:
20602060
tags:
2061-
- project
2061+
- inventory
20622062
summary: Removes inventory
20632063
responses:
20642064
204:
@@ -2070,7 +2070,7 @@ paths:
20702070
- $ref: "#/parameters/project_id"
20712071
get:
20722072
tags:
2073-
- project
2073+
- variable group (environment)
20742074
summary: Get environment
20752075
parameters:
20762076
- name: sort
@@ -2096,7 +2096,7 @@ paths:
20962096
$ref: "#/definitions/Environment"
20972097
post:
20982098
tags:
2099-
- project
2099+
- variable group (environment)
21002100
summary: Add environment
21012101
parameters:
21022102
- name: environment
@@ -2115,7 +2115,7 @@ paths:
21152115
- $ref: "#/parameters/environment_id"
21162116
get:
21172117
tags:
2118-
- project
2118+
- variable group (environment)
21192119
summary: Get environment
21202120
responses:
21212121
200:
@@ -2124,7 +2124,7 @@ paths:
21242124
$ref: "#/definitions/Environment"
21252125
put:
21262126
tags:
2127-
- project
2127+
- variable group (environment)
21282128
summary: Update environment
21292129
parameters:
21302130
- name: environment
@@ -2137,7 +2137,7 @@ paths:
21372137
description: Environment Updated
21382138
delete:
21392139
tags:
2140-
- project
2140+
- variable group (environment)
21412141
summary: Removes environment
21422142
responses:
21432143
204:
@@ -2149,7 +2149,7 @@ paths:
21492149
- $ref: "#/parameters/project_id"
21502150
get:
21512151
tags:
2152-
- project
2152+
- template
21532153
summary: Get template
21542154
parameters:
21552155
- name: sort
@@ -2180,7 +2180,7 @@ paths:
21802180
$ref: "#/definitions/Task"
21812181
post:
21822182
tags:
2183-
- project
2183+
- template
21842184
summary: create template
21852185
parameters:
21862186
- name: template
@@ -2199,7 +2199,7 @@ paths:
21992199
- $ref: "#/parameters/template_id"
22002200
get:
22012201
tags:
2202-
- project
2202+
- template
22032203
summary: Get template
22042204
responses:
22052205
200:
@@ -2208,7 +2208,7 @@ paths:
22082208
$ref: "#/definitions/Template"
22092209
put:
22102210
tags:
2211-
- project
2211+
- template
22122212
summary: Updates template
22132213
parameters:
22142214
- name: template
@@ -2221,7 +2221,7 @@ paths:
22212221
description: template updated
22222222
delete:
22232223
tags:
2224-
- project
2224+
- template
22252225
summary: Removes template
22262226
responses:
22272227
204:
@@ -2353,7 +2353,7 @@ paths:
23532353
- $ref: "#/parameters/project_id"
23542354
get:
23552355
tags:
2356-
- project
2356+
- task
23572357
summary: Get Tasks related to current project
23582358
responses:
23592359
200:
@@ -2364,7 +2364,7 @@ paths:
23642364
$ref: '#/definitions/Task'
23652365
post:
23662366
tags:
2367-
- project
2367+
- task
23682368
summary: Starts a job
23692369
parameters:
23702370
- name: task
@@ -2407,7 +2407,7 @@ paths:
24072407
- $ref: "#/parameters/project_id"
24082408
get:
24092409
tags:
2410-
- project
2410+
- task
24112411
summary: Get last 200 Tasks related to current project
24122412
responses:
24132413
200:
@@ -2424,7 +2424,7 @@ paths:
24242424
- $ref: '#/parameters/task_id'
24252425
post:
24262426
tags:
2427-
- project
2427+
- task
24282428
summary: Stop a job
24292429
responses:
24302430
204:
@@ -2445,7 +2445,7 @@ paths:
24452445
$ref: "#/definitions/Task"
24462446
delete:
24472447
tags:
2448-
- project
2448+
- task
24492449
summary: Deletes task (including output)
24502450
responses:
24512451
204:
@@ -2457,7 +2457,7 @@ paths:
24572457
- $ref: '#/parameters/task_id'
24582458
get:
24592459
tags:
2460-
- project
2460+
- task
24612461
summary: Get task output
24622462
responses:
24632463
200:
@@ -2473,7 +2473,7 @@ paths:
24732473
- $ref: '#/parameters/task_id'
24742474
get:
24752475
tags:
2476-
- project
2476+
- task
24772477
summary: Get task raw output
24782478
responses:
24792479
200:

web/public/swagger/api-docs.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1036,9 +1036,7 @@ definitions:
10361036
use_remote_runner:
10371037
type: boolean
10381038
auth_methods:
1039-
type: array
1040-
items:
1041-
type: string
1039+
type: object
10421040
git_client:
10431041
type: string
10441042
schedule_timezone:

0 commit comments

Comments
 (0)