swagger bug fix

Signed-off-by: Saurabh Deoras <[email protected]>
talakad · Mar 6, 2018 · 8631faa · 8631faa
1 parent 845420d
commit 8631faa
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 9 deletions.
diff --git a/api/server/cluster.go b/api/server/cluster.go
@@ -118,9 +118,9 @@ func (c *clusterApi) getNodeConf(w http.ResponseWriter, r *http.Request) {
 	json.NewEncoder(w).Encode(config)
 }
 
-// swagger:operation DELETE /config/node/{id} config getNodeConfig
+// swagger:operation DELETE /config/node/{id} config deleteNodeConfig
 //
-// Get node configuration.
+// Delete node configuration.
 //
 // This will delete the requested node configuration object
 //
@@ -134,7 +134,8 @@ func (c *clusterApi) getNodeConf(w http.ResponseWriter, r *http.Request) {
 //   required: true
 //   type: string
 // responses:
-//   '200'
+//   '200':
+//      description: success
 func (c *clusterApi) delNodeConf(w http.ResponseWriter, r *http.Request) {
 	method := "delNodeConf"
 	inst, err := cluster.Inst()
@@ -164,10 +165,12 @@ func (c *clusterApi) delNodeConf(w http.ResponseWriter, r *http.Request) {
 //   description: cluster config json
 //   required: true
 //   schema:
-//     $ref: '#/definitions/ClusterConfig'
+//    $ref: '#/definitions/ClusterConfig'
 // responses:
-//   200:
+//   '200':
 //     description: success
+//     schema:
+//       type: string
 func (c *clusterApi) setClusterConf(w http.ResponseWriter, r *http.Request) {
 	method := "setClusterConf"
 	inst, err := cluster.Inst()
@@ -223,8 +226,8 @@ func (c *clusterApi) setClusterConf(w http.ResponseWriter, r *http.Request) {
 //   schema:
 //     $ref: '#/definitions/NodeConfig'
 // responses:
-//   200:
-//     description: success
+//   '200':
+//      description: success
 func (c *clusterApi) setNodeConf(w http.ResponseWriter, r *http.Request) {
 	method := "setNodeConf"
 	inst, err := cluster.Inst()

diff --git a/api/swagger/swagger.json b/api/swagger/swagger.json
@@ -395,7 +395,10 @@
         ],
         "responses": {
           "200": {
-            "description": "success"
+            "description": "success",
+            "schema": {
+              "type": "string"
+            }
           }
         }
       }
@@ -442,7 +445,7 @@
         "operationId": "getNodeConfig",
         "parameters": [
           {
-            "type": "integer",
+            "type": "string",
             "description": "id to get node with",
             "name": "id",
             "in": "path",
@@ -457,6 +460,31 @@
             }
           }
         }
+      },
+      "delete": {
+        "description": "This will delete the requested node configuration object",
+        "produces": [
+          "application/json"
+        ],
+        "tags": [
+          "config"
+        ],
+        "summary": "Delete node configuration.",
+        "operationId": "deleteNodeConfig",
+        "parameters": [
+          {
+            "type": "string",
+            "description": "id to reference node",
+            "name": "id",
+            "in": "path",
+            "required": true
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "success"
+          }
+        }
       }
     },
     "/loggingurl": {
@@ -1606,6 +1634,13 @@
           "type": "boolean",
           "x-go-name": "Multicontainer"
         },
+        "node_id": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "x-go-name": "NodeId"
+        },
         "nolh": {
           "type": "boolean",
           "x-go-name": "Nolh"

diff --git a/osdconfig/struct.go b/osdconfig/struct.go
@@ -6,6 +6,7 @@ type NodesConfig struct {
 }
 
 // NodeConfig is a node level config data
+// swagger:model
 type NodeConfig struct {
 	NodeId  string         `json:"node_id,omitempty" enable:"true" hidden:"false" usage:"ID for the node"`
 	Network *NetworkConfig `json:"network,omitempty" enable:"true" hidden:"false" usage:"Network configuration" description:"Configure network values for a node"`
@@ -20,6 +21,7 @@ func (conf *NodeConfig) Init() *NodeConfig {
 }
 
 // KvdbConfig stores parameters defining kvdb configuration
+// swagger:model
 type KvdbConfig struct {
 	Username       string   `json:"username,omitempty" enable:"true" hidden:"false" usage:"Username for kvdb"`
 	Password       string   `json:"password,omitempty" enable:"true" hidden:"false" usage:"Passwd for kvdb"`
@@ -71,6 +73,7 @@ func (conf *ClusterConfig) Init() *ClusterConfig {
 }
 
 // NetworkConfig is a network configuration parameters struct
+// swagger:model
 type NetworkConfig struct {
 	MgtIface  string `json:"mgt_iface,omitempty" enable:"true" hidden:"false" usage:"Management interface"`
 	DataIface string `json:"data_iface,omitempty" enable:"true" hidden:"false" usage:"Data interface"`
@@ -81,6 +84,7 @@ func (conf *NetworkConfig) Init() *NetworkConfig {
 }
 
 // SecretsConfig is a secrets configuration parameters struct
+// swagger:model
 type SecretsConfig struct {
 	SecretType       string       `json:"secret_type,omitempty" enable:"true" hidden:"false" usage:"Secret type"`
 	ClusterSecretKey string       `json:"cluster_secret_key,omitempty" enable:"true" hidden:"false" usage:"Secret key"`
@@ -95,6 +99,7 @@ func (conf *SecretsConfig) Init() *SecretsConfig {
 }
 
 // VaultConfig is a vault configuration parameters struct
+// swagger:model
 type VaultConfig struct {
 	VaultToken         string `json:"vault_token,omitempty" enable:"true" hidden:"false" usage:"Vault token"`
 	VaultAddr          string `json:"vault_addr,omitempty" enable:"true" hidden:"false" usage:"Vault address"`
@@ -112,6 +117,7 @@ func (conf *VaultConfig) Init() *VaultConfig {
 }
 
 // AWS configuration parameters struct
+// swagger:model
 type AWSConfig struct {
 	AwsAccessKeyId     string `json:"aws_access_key_id,omitempty" enable:"true" hidden:"false" usage:"AWS access key ID"`
 	AwsSecretAccessKey string `json:"aws_secret_access_key,omitempty" enable:"true" hidden:"false" usage:"AWS secret access key"`
@@ -125,6 +131,7 @@ func (conf *AWSConfig) Init() *AWSConfig {
 }
 
 // StorageConfig is a storage configuration parameters struct
+// swagger:model
 type StorageConfig struct {
 	DevicesMd        []string `json:"devices_md,omitempty" enable:"true" hidden:"false" usage:"Devices MD"`
 	MaxCount         int32    `json:"max_count,omitempty" enable:"true" hidden:"false" usage:"Maximum count"`