Update swagger API doc (#52)

... to add the newly added parameters.

Signed-off-by: Fangchi Wang <wfangchi@vmware.com>

Author: wfangchi

server/api/federation.go

@@ -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"

server/docs/docs.go

@@ -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": {
@@ -5098,6 +5105,9 @@ const docTemplate = `{
                 "externalSpark": {
                     "$ref": "#/definitions/service.ExternalSpark"
                 },
+                "fateflow_gpu_num": {
+                    "type": "integer"
+                },
                 "federation_uuid": {
                     "type": "string"
                 },
@@ -5359,6 +5369,9 @@ const docTemplate = `{
                 "labels": {
                     "$ref": "#/definitions/valueobject.Labels"
                 },
+                "less_privileged": {
+                    "type": "boolean"
+                },
                 "name": {
                     "description": "optional",
                     "type": "string"

server/docs/swagger.json

@@ -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": {
@@ -5090,6 +5097,9 @@
                 "externalSpark": {
                     "$ref": "#/definitions/service.ExternalSpark"
                 },
+                "fateflow_gpu_num": {
+                    "type": "integer"
+                },
                 "federation_uuid": {
                     "type": "string"
                 },
@@ -5351,6 +5361,9 @@
                 "labels": {
                     "$ref": "#/definitions/valueobject.Labels"
                 },
+                "less_privileged": {
+                    "type": "boolean"
+                },
                 "name": {
                     "description": "optional",
                     "type": "string"

server/docs/swagger.yaml

@@ -700,6 +700,8 @@ definitions:
         $ref: '#/definitions/service.ExternalPulsar'
       externalSpark:
         $ref: '#/definitions/service.ExternalSpark'
+      fateflow_gpu_num:
+        type: integer
       federation_uuid:
         type: string
       name:
@@ -876,6 +878,8 @@ definitions:
         type: string
       labels:
         $ref: '#/definitions/valueobject.Labels'
+      less_privileged:
+        type: boolean
       name:
         description: optional
         type: string
@@ -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: