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

Update swagger API doc #52

Merged
merged 1 commit into from
May 12, 2023
Merged

Update swagger API doc #52

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
1 change: 1 addition & 0 deletions server/api/federation.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -494,6 +494,7 @@ func (controller *FederationController) deleteFATEExchange(c *gin.Context) {
// @Param enable_persistence query bool true "choose if use the persistent volume"
// @Param storage_class query string true "provide the name of StorageClass"
// @Param enable_psp query bool true "choose if enable the podSecurityPolicy"
// @Param fateflow_gpu_num query int true "number of gpu to assign to fateflow pod, default 0"
// @Success 200 {object} GeneralResponse{data=string} "Success, the data field is the yaml content"
// @Failure 401 {object} GeneralResponse "Unauthorized operation"
// @Failure 500 {object} GeneralResponse{code=int} "Internal server error"
Expand Down
13 changes: 13 additions & 0 deletions server/docs/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1643,6 +1643,13 @@ const docTemplate = `{
"name": "enable_psp",
"in": "query",
"required": true
},
{
"type": "integer",
"description": "number of gpu to assign to fateflow pod, default 0",
"name": "fateflow_gpu_num",
"in": "query",
"required": true
}
],
"responses": {
Expand Down Expand Up @@ -5098,6 +5105,9 @@ const docTemplate = `{
"externalSpark": {
"$ref": "#/definitions/service.ExternalSpark"
},
"fateflow_gpu_num": {
"type": "integer"
},
"federation_uuid": {
"type": "string"
},
Expand Down Expand Up @@ -5359,6 +5369,9 @@ const docTemplate = `{
"labels": {
"$ref": "#/definitions/valueobject.Labels"
},
"less_privileged": {
"type": "boolean"
},
"name": {
"description": "optional",
"type": "string"
Expand Down
13 changes: 13 additions & 0 deletions server/docs/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1635,6 +1635,13 @@
"name": "enable_psp",
"in": "query",
"required": true
},
{
"type": "integer",
"description": "number of gpu to assign to fateflow pod, default 0",
"name": "fateflow_gpu_num",
"in": "query",
"required": true
}
],
"responses": {
Expand Down Expand Up @@ -5090,6 +5097,9 @@
"externalSpark": {
"$ref": "#/definitions/service.ExternalSpark"
},
"fateflow_gpu_num": {
"type": "integer"
},
"federation_uuid": {
"type": "string"
},
Expand Down Expand Up @@ -5351,6 +5361,9 @@
"labels": {
"$ref": "#/definitions/valueobject.Labels"
},
"less_privileged": {
"type": "boolean"
},
"name": {
"description": "optional",
"type": "string"
Expand Down
9 changes: 9 additions & 0 deletions server/docs/swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -700,6 +700,8 @@ definitions:
$ref: '#/definitions/service.ExternalPulsar'
externalSpark:
$ref: '#/definitions/service.ExternalSpark'
fateflow_gpu_num:
type: integer
federation_uuid:
type: string
name:
Expand Down Expand Up @@ -876,6 +878,8 @@ definitions:
type: string
labels:
$ref: '#/definitions/valueobject.Labels'
less_privileged:
type: boolean
name:
description: optional
type: string
Expand Down Expand Up @@ -2427,6 +2431,11 @@ paths:
name: enable_psp
required: true
type: boolean
- description: number of gpu to assign to fateflow pod, default 0
in: query
name: fateflow_gpu_num
required: true
type: integer
produces:
- application/json
responses:
Expand Down