Skip to content

Commit

Permalink
Update Swagger REST API doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@cb-github-robot @web-flow
cb-github-robot authored and web-flow committed Aug 19, 2024
1 parent 49b4552 commit 3cfe631
Show file tree
Hide file tree
Showing 3 changed files with 107 additions and 107 deletions.
80 changes: 40 additions & 40 deletions src/api/rest/docs/docs.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1886,46 +1886,6 @@ const docTemplate = `{
}
}
},
"/ns/{nsId}/defaultResources": {
"delete": {
"description": "Delete all Default Resource Objects in the given namespace",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"[Infra resource] MCIR Common"
],
"summary": "Delete all Default Resource Objects in the given namespace",
"operationId": "DelAllDefaultResources",
"parameters": [
{
"type": "string",
"default": "default",
"description": "Namespace ID",
"name": "nsId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.IdList"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/common.SimpleMsg"
}
}
}
}
},
"/ns/{nsId}/installBenchmarkAgent/mci/{mciId}": {
"post": {
"description": "Install the benchmark agent to specified MCI",
Expand Down Expand Up @@ -7910,6 +7870,46 @@ const docTemplate = `{
}
}
},
"/ns/{nsId}/sharedResources": {
"delete": {
"description": "Delete all Default Resource Objects in the given namespace",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"[Infra resource] MCIR Common"
],
"summary": "Delete all Default Resource Objects in the given namespace",
"operationId": "DelAllSharedResources",
"parameters": [
{
"type": "string",
"default": "default",
"description": "Namespace ID",
"name": "nsId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.IdList"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/common.SimpleMsg"
}
}
}
}
},
"/object": {
"get": {
"description": "Get value of an object",
Expand Down
80 changes: 40 additions & 40 deletions src/api/rest/docs/swagger.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1879,46 +1879,6 @@
}
}
},
"/ns/{nsId}/defaultResources": {
"delete": {
"description": "Delete all Default Resource Objects in the given namespace",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"[Infra resource] MCIR Common"
],
"summary": "Delete all Default Resource Objects in the given namespace",
"operationId": "DelAllDefaultResources",
"parameters": [
{
"type": "string",
"default": "default",
"description": "Namespace ID",
"name": "nsId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.IdList"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/common.SimpleMsg"
}
}
}
}
},
"/ns/{nsId}/installBenchmarkAgent/mci/{mciId}": {
"post": {
"description": "Install the benchmark agent to specified MCI",
Expand Down Expand Up @@ -7903,6 +7863,46 @@
}
}
},
"/ns/{nsId}/sharedResources": {
"delete": {
"description": "Delete all Default Resource Objects in the given namespace",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"tags": [
"[Infra resource] MCIR Common"
],
"summary": "Delete all Default Resource Objects in the given namespace",
"operationId": "DelAllSharedResources",
"parameters": [
{
"type": "string",
"default": "default",
"description": "Namespace ID",
"name": "nsId",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/common.IdList"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/common.SimpleMsg"
}
}
}
}
},
"/object": {
"get": {
"description": "Get value of an object",
Expand Down
54 changes: 27 additions & 27 deletions src/api/rest/docs/swagger.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4459,33 +4459,6 @@ paths:
summary: Control the lifecycle of VM (suspend, resume, reboot, terminate)
tags:
- '[MC-Infra] MCI Control lifecycle'
/ns/{nsId}/defaultResources:
delete:
consumes:
- application/json
description: Delete all Default Resource Objects in the given namespace
operationId: DelAllDefaultResources
parameters:
- default: default
description: Namespace ID
in: path
name: nsId
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.IdList'
"404":
description: Not Found
schema:
$ref: '#/definitions/common.SimpleMsg'
summary: Delete all Default Resource Objects in the given namespace
tags:
- '[Infra resource] MCIR Common'
/ns/{nsId}/installBenchmarkAgent/mci/{mciId}:
post:
consumes:
Expand Down Expand Up @@ -8565,6 +8538,33 @@ paths:
summary: Delete Subnet
tags:
- '[Infra resource] MCIR Network management'
/ns/{nsId}/sharedResources:
delete:
consumes:
- application/json
description: Delete all Default Resource Objects in the given namespace
operationId: DelAllSharedResources
parameters:
- default: default
description: Namespace ID
in: path
name: nsId
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/common.IdList'
"404":
description: Not Found
schema:
$ref: '#/definitions/common.SimpleMsg'
summary: Delete all Default Resource Objects in the given namespace
tags:
- '[Infra resource] MCIR Common'
/object:
delete:
consumes:
Expand Down

0 comments on commit 3cfe631

Please sign in to comment.