github
/
portainer
mirror of https://github.com/portainer/portainer
1
0
Fork 0
Code Issues Releases Wiki Activity

docs(api): update swagger related files to support swagger-codegen (#2404) 

* Linting updates to api/swagger.yaml

* Security updates to api/swagger.yml

* Add api/swagger_config.json for swagger-codegen

* Add swagger_config.json packageVersion to match swagger.yml
pull/2253/head
Mark Stansberry 2018-10-27 23:05:54 -04:00 committed by Anthony Lapenna
parent 7e6c647e93
commit 6ab510e5cb
2 changed files with 138 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

130
api/swagger.yaml
View File

@ -153,6 +153,8 @@ paths:
operationId: "DockerHubInspect" operationId: "DockerHubInspect"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: [] parameters: []
responses: responses:
200: 200:
@ -175,6 +177,8 @@ paths:
- "application/json" - "application/json"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- in: "body" - in: "body"
name: "body" name: "body"
@ -211,6 +215,8 @@ paths:
operationId: "EndpointList" operationId: "EndpointList"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: [] parameters: []
responses: responses:
200: 200:
@ -233,6 +239,8 @@ paths:
- "multipart/form-data" - "multipart/form-data"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- name: "Name" - name: "Name"
in: "formData" in: "formData"
@ -265,7 +273,7 @@ paths:
- name: "TLSSkipVerify" - name: "TLSSkipVerify"
in: "formData" in: "formData"
type: "string" type: "string"
description: "Skip server verification when using TLS" (example: false) description: "Skip server verification when using TLS (example: false)"
- name: "TLSCACertFile" - name: "TLSCACertFile"
in: "formData" in: "formData"
type: "file" type: "file"
@ -324,6 +332,8 @@ paths:
operationId: "EndpointInspect" operationId: "EndpointInspect"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -365,6 +375,8 @@ paths:
- "application/json" - "application/json"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -413,6 +425,8 @@ paths:
Remove an endpoint. Remove an endpoint.
**Access policy**: administrator **Access policy**: administrator
operationId: "EndpointDelete" operationId: "EndpointDelete"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -460,6 +474,8 @@ paths:
- "application/json" - "application/json"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -508,6 +524,8 @@ paths:
- "application/json" - "application/json"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -573,6 +591,8 @@ paths:
operationId: "EndpointGroupList" operationId: "EndpointGroupList"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: [] parameters: []
responses: responses:
200: 200:
@ -595,6 +615,8 @@ paths:
- "application/json" - "application/json"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- in: "body" - in: "body"
name: "body" name: "body"
@ -629,6 +651,8 @@ paths:
operationId: "EndpointGroupInspect" operationId: "EndpointGroupInspect"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -670,6 +694,8 @@ paths:
- "application/json" - "application/json"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -720,6 +746,8 @@ paths:
Remove an endpoint group. Remove an endpoint group.
**Access policy**: administrator **Access policy**: administrator
operationId: "EndpointGroupDelete" operationId: "EndpointGroupDelete"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -767,6 +795,8 @@ paths:
- "application/json" - "application/json"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -815,6 +845,8 @@ paths:
operationId: "RegistryList" operationId: "RegistryList"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: [] parameters: []
responses: responses:
200: 200:
@ -837,6 +869,8 @@ paths:
- "application/json" - "application/json"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- in: "body" - in: "body"
name: "body" name: "body"
@ -878,6 +912,8 @@ paths:
operationId: "RegistryInspect" operationId: "RegistryInspect"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -919,6 +955,8 @@ paths:
- "application/json" - "application/json"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -969,6 +1007,8 @@ paths:
Remove a registry. Remove a registry.
**Access policy**: administrator **Access policy**: administrator
operationId: "RegistryDelete" operationId: "RegistryDelete"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -1009,6 +1049,8 @@ paths:
- "application/json" - "application/json"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -1057,6 +1099,8 @@ paths:
- "application/json" - "application/json"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- in: "body" - in: "body"
name: "body" name: "body"
@ -1107,6 +1151,8 @@ paths:
- "application/json" - "application/json"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -1157,6 +1203,8 @@ paths:
Remove a resource control. Remove a resource control.
**Access policy**: restricted **Access policy**: restricted
operationId: "ResourceControlDelete" operationId: "ResourceControlDelete"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -1202,6 +1250,8 @@ paths:
operationId: "SettingsInspect" operationId: "SettingsInspect"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: [] parameters: []
responses: responses:
200: 200:
@ -1224,6 +1274,8 @@ paths:
- "application/json" - "application/json"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- in: "body" - in: "body"
name: "body" name: "body"
@ -1258,6 +1310,8 @@ paths:
operationId: "PublicSettingsInspect" operationId: "PublicSettingsInspect"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: [] parameters: []
responses: responses:
200: 200:
@ -1281,6 +1335,8 @@ paths:
- "application/json" - "application/json"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- in: "body" - in: "body"
name: "body" name: "body"
@ -1313,6 +1369,8 @@ paths:
operationId: "StatusInspect" operationId: "StatusInspect"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: [] parameters: []
responses: responses:
200: 200:
@ -1336,6 +1394,8 @@ paths:
operationId: "StackList" operationId: "StackList"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- name: "filters" - name: "filters"
in: "query" in: "query"
@ -1368,6 +1428,8 @@ paths:
- "application/json" - "application/json"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- name: "type" - name: "type"
in: "query" in: "query"
@ -1447,6 +1509,8 @@ paths:
operationId: "StackInspect" operationId: "StackInspect"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -1492,6 +1556,8 @@ paths:
- "application/json" - "application/json"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -1544,6 +1610,8 @@ paths:
Remove a stack. Remove a stack.
**Access policy**: restricted **Access policy**: restricted
operationId: "StackDelete" operationId: "StackDelete"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -1594,6 +1662,8 @@ paths:
operationId: "StackFileInspect" operationId: "StackFileInspect"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -1639,6 +1709,8 @@ paths:
operationId: "StackMigrate" operationId: "StackMigrate"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -1693,6 +1765,8 @@ paths:
operationId: "UserList" operationId: "UserList"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: [] parameters: []
responses: responses:
200: 200:
@ -1716,6 +1790,8 @@ paths:
- "application/json" - "application/json"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- in: "body" - in: "body"
name: "body" name: "body"
@ -1764,6 +1840,8 @@ paths:
operationId: "UserInspect" operationId: "UserInspect"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -1805,6 +1883,8 @@ paths:
- "application/json" - "application/json"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -1855,6 +1935,8 @@ paths:
Remove a user. Remove a user.
**Access policy**: administrator **Access policy**: administrator
operationId: "UserDelete" operationId: "UserDelete"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -1893,6 +1975,8 @@ paths:
operationId: "UserMembershipsInspect" operationId: "UserMembershipsInspect"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -1936,6 +2020,8 @@ paths:
- "application/json" - "application/json"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -1983,6 +2069,8 @@ paths:
operationId: "UserAdminCheck" operationId: "UserAdminCheck"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: [] parameters: []
responses: responses:
204: 204:
@ -2012,6 +2100,8 @@ paths:
- "application/json" - "application/json"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- in: "body" - in: "body"
name: "body" name: "body"
@ -2056,6 +2146,8 @@ paths:
- multipart/form-data - multipart/form-data
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- in: "path" - in: "path"
name: "certificate" name: "certificate"
@ -2097,6 +2189,8 @@ paths:
operationId: "TagList" operationId: "TagList"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: [] parameters: []
responses: responses:
200: 200:
@ -2119,6 +2213,8 @@ paths:
- "application/json" - "application/json"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- in: "body" - in: "body"
name: "body" name: "body"
@ -2158,6 +2254,8 @@ paths:
Remove a tag. Remove a tag.
**Access policy**: administrator **Access policy**: administrator
operationId: "TagDelete" operationId: "TagDelete"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -2190,6 +2288,8 @@ paths:
operationId: "TeamList" operationId: "TeamList"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: [] parameters: []
responses: responses:
200: 200:
@ -2212,6 +2312,8 @@ paths:
- "application/json" - "application/json"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- in: "body" - in: "body"
name: "body" name: "body"
@ -2260,6 +2362,8 @@ paths:
operationId: "TeamInspect" operationId: "TeamInspect"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -2308,6 +2412,8 @@ paths:
- "application/json" - "application/json"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -2349,6 +2455,8 @@ paths:
Remove a team. Remove a team.
**Access policy**: administrator **Access policy**: administrator
operationId: "TeamDelete" operationId: "TeamDelete"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -2388,6 +2496,8 @@ paths:
operationId: "TeamMembershipsInspect" operationId: "TeamMembershipsInspect"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -2429,6 +2539,8 @@ paths:
operationId: "TeamMembershipList" operationId: "TeamMembershipList"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: [] parameters: []
responses: responses:
200: 200:
@ -2458,6 +2570,8 @@ paths:
- "application/json" - "application/json"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- in: "body" - in: "body"
name: "body" name: "body"
@ -2508,6 +2622,8 @@ paths:
- "application/json" - "application/json"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -2558,6 +2674,8 @@ paths:
Remove a team membership. Access is only available to administrators leaders of the associated team. Remove a team membership. Access is only available to administrators leaders of the associated team.
**Access policy**: restricted **Access policy**: restricted
operationId: "TeamMembershipDelete" operationId: "TeamMembershipDelete"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -2604,6 +2722,8 @@ paths:
operationId: "TemplateList" operationId: "TemplateList"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
responses: responses:
200: 200:
@ -2626,6 +2746,8 @@ paths:
- "application/json" - "application/json"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- in: "body" - in: "body"
name: "body" name: "body"
@ -2667,6 +2789,8 @@ paths:
operationId: "TemplateInspect" operationId: "TemplateInspect"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -2715,6 +2839,8 @@ paths:
- "application/json" - "application/json"
produces: produces:
- "application/json" - "application/json"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"
@ -2763,6 +2889,8 @@ paths:
Remove a template. Remove a template.
**Access policy**: administrator **Access policy**: administrator
operationId: "TemplateDelete" operationId: "TemplateDelete"
security:
- jwt: []
parameters: parameters:
- name: "id" - name: "id"
in: "path" in: "path"

5
api/swagger_config.json Normal file
View File

@ -0,0 +1,5 @@
{
"packageName": "portainer",
"packageVersion": "1.20-dev",
"projectName": "portainer"
}