Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Workflow] Update Swagger REST API doc #978

Merged
merged 1 commit into from
Nov 16, 2021
Merged

[Workflow] Update Swagger REST API doc #978

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 26 additions & 4 deletions src/api/rest/docs/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5949,6 +5949,11 @@ var doc = `{
"type": "string",
"example": "[yes, no]"
},
"label": {
"description": "Label is for describing the mcis in a keyword (any string can be used)",
"type": "string",
"example": "User custom label"
},
"masterIp": {
"type": "string",
"example": "32.201.134.113"
Expand All @@ -5969,6 +5974,11 @@ var doc = `{
"statusCount": {
"$ref": "#/definitions/mcis.StatusCountInfo"
},
"systemLabel": {
"description": "SystemLabel is for describing the mcis in a keyword (any string can be used) for special System purpose",
"type": "string",
"example": "Managed by CB-Tumblebug"
},
"targetAction": {
"type": "string"
},
Expand Down Expand Up @@ -6440,13 +6450,16 @@ var doc = `{
"label": {
"description": "Label is for describing the mcis in a keyword (any string can be used)",
"type": "string",
"default": "no",
"example": "custom tag"
"example": "DynamicVM"
},
"name": {
"type": "string",
"example": "mcis01"
},
"systemLabel": {
"description": "SystemLabel is for describing the mcis in a keyword (any string can be used) for special System purpose",
"type": "string"
},
"vm": {
"type": "array",
"items": {
Expand Down Expand Up @@ -6476,7 +6489,8 @@ var doc = `{
},
"label": {
"description": "Label is for describing the mcis in a keyword (any string can be used)",
"type": "string"
"type": "string",
"example": "User custom label"
},
"name": {
"type": "string"
Expand All @@ -6490,6 +6504,11 @@ var doc = `{
"statusCount": {
"$ref": "#/definitions/mcis.StatusCountInfo"
},
"systemLabel": {
"description": "SystemLabel is for describing the mcis in a keyword (any string can be used) for special System purpose",
"type": "string",
"example": "Managed by CB-Tumblebug"
},
"targetAction": {
"type": "string"
},
Expand Down Expand Up @@ -6528,7 +6547,6 @@ var doc = `{
"label": {
"description": "Label is for describing the mcis in a keyword (any string can be used)",
"type": "string",
"default": "no",
"example": "custom tag"
},
"name": {
Expand All @@ -6538,6 +6556,10 @@ var doc = `{
"placementAlgo": {
"type": "string"
},
"systemLabel": {
"description": "SystemLabel is for describing the mcis in a keyword (any string can be used) for special System purpose",
"type": "string"
},
"vm": {
"type": "array",
"items": {
Expand Down
30 changes: 26 additions & 4 deletions src/api/rest/docs/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5935,6 +5935,11 @@
"type": "string",
"example": "[yes, no]"
},
"label": {
"description": "Label is for describing the mcis in a keyword (any string can be used)",
"type": "string",
"example": "User custom label"
},
"masterIp": {
"type": "string",
"example": "32.201.134.113"
Expand All @@ -5955,6 +5960,11 @@
"statusCount": {
"$ref": "#/definitions/mcis.StatusCountInfo"
},
"systemLabel": {
"description": "SystemLabel is for describing the mcis in a keyword (any string can be used) for special System purpose",
"type": "string",
"example": "Managed by CB-Tumblebug"
},
"targetAction": {
"type": "string"
},
Expand Down Expand Up @@ -6426,13 +6436,16 @@
"label": {
"description": "Label is for describing the mcis in a keyword (any string can be used)",
"type": "string",
"default": "no",
"example": "custom tag"
"example": "DynamicVM"
},
"name": {
"type": "string",
"example": "mcis01"
},
"systemLabel": {
"description": "SystemLabel is for describing the mcis in a keyword (any string can be used) for special System purpose",
"type": "string"
},
"vm": {
"type": "array",
"items": {
Expand Down Expand Up @@ -6462,7 +6475,8 @@
},
"label": {
"description": "Label is for describing the mcis in a keyword (any string can be used)",
"type": "string"
"type": "string",
"example": "User custom label"
},
"name": {
"type": "string"
Expand All @@ -6476,6 +6490,11 @@
"statusCount": {
"$ref": "#/definitions/mcis.StatusCountInfo"
},
"systemLabel": {
"description": "SystemLabel is for describing the mcis in a keyword (any string can be used) for special System purpose",
"type": "string",
"example": "Managed by CB-Tumblebug"
},
"targetAction": {
"type": "string"
},
Expand Down Expand Up @@ -6514,7 +6533,6 @@
"label": {
"description": "Label is for describing the mcis in a keyword (any string can be used)",
"type": "string",
"default": "no",
"example": "custom tag"
},
"name": {
Expand All @@ -6524,6 +6542,10 @@
"placementAlgo": {
"type": "string"
},
"systemLabel": {
"description": "SystemLabel is for describing the mcis in a keyword (any string can be used) for special System purpose",
"type": "string"
},
"vm": {
"type": "array",
"items": {
Expand Down
28 changes: 25 additions & 3 deletions src/api/rest/docs/swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -874,6 +874,11 @@ definitions:
default:yes)
example: '[yes, no]'
type: string
label:
description: Label is for describing the mcis in a keyword (any string can
be used)
example: User custom label
type: string
masterIp:
example: 32.201.134.113
type: string
Expand All @@ -888,6 +893,11 @@ definitions:
type: string
statusCount:
$ref: '#/definitions/mcis.StatusCountInfo'
systemLabel:
description: SystemLabel is for describing the mcis in a keyword (any string
can be used) for special System purpose
example: Managed by CB-Tumblebug
type: string
targetAction:
type: string
targetStatus:
Expand Down Expand Up @@ -1212,14 +1222,17 @@ definitions:
example: "no"
type: string
label:
default: "no"
description: Label is for describing the mcis in a keyword (any string can
be used)
example: custom tag
example: DynamicVM
type: string
name:
example: mcis01
type: string
systemLabel:
description: SystemLabel is for describing the mcis in a keyword (any string
can be used) for special System purpose
type: string
vm:
items:
$ref: '#/definitions/mcis.TbVmDynamicReq'
Expand All @@ -1246,6 +1259,7 @@ definitions:
label:
description: Label is for describing the mcis in a keyword (any string can
be used)
example: User custom label
type: string
name:
type: string
Expand All @@ -1255,6 +1269,11 @@ definitions:
type: string
statusCount:
$ref: '#/definitions/mcis.StatusCountInfo'
systemLabel:
description: SystemLabel is for describing the mcis in a keyword (any string
can be used) for special System purpose
example: Managed by CB-Tumblebug
type: string
targetAction:
type: string
targetStatus:
Expand All @@ -1279,7 +1298,6 @@ definitions:
example: "no"
type: string
label:
default: "no"
description: Label is for describing the mcis in a keyword (any string can
be used)
example: custom tag
Expand All @@ -1289,6 +1307,10 @@ definitions:
type: string
placementAlgo:
type: string
systemLabel:
description: SystemLabel is for describing the mcis in a keyword (any string
can be used) for special System purpose
type: string
vm:
items:
$ref: '#/definitions/mcis.TbVmReq'
Expand Down