Explorar el Código

review comments

Matthew R Kasun hace 2 años
padre
commit
20fe1e0b20
Se han modificado 4 ficheros con 45 adiciones y 39 borrados
  1. 2 2
      controllers/docs.go
  2. 2 2
      controllers/network.go
  3. 1 1
      controllers/node.go
  4. 40 34
      swagger.yml

+ 2 - 2
controllers/docs.go

@@ -209,7 +209,7 @@ type byteArrayResponse struct {
 	ByteArray []byte `json:"byte_array"`
 }
 
-// swagger:parameters getNetwork deleteNetwork getNetworkACL updateNetworkACL getNetworkNodes
+// swagger:parameters getNetwork deleteNetwork updateNetwork getNetworkACL updateNetworkACL
 type NetworkParam struct {
 	// name: network name
 	// in:  path
@@ -237,7 +237,7 @@ type networkBodyParam struct {
 	Network models.Network `json:"network"`
 }
 
-// swagger:parameters updateNetwork updateNetwork updateNetworkNodeLimit keyUpdate createAccessKey getAccessKeys
+// swagger:parameters updateNetworkNodeLimit keyUpdate createAccessKey getAccessKeys getNetworkNodes
 type networkPathParam struct {
 	// Network
 	// in: path

+ 2 - 2
controllers/network.go

@@ -30,7 +30,7 @@ func networkHandlers(r *mux.Router) {
 	r.HandleFunc("/api/networks/{networkname}/acls", logic.SecurityCheck(true, http.HandlerFunc(getNetworkACL))).Methods(http.MethodGet)
 }
 
-// swagger:route GET /api/networks networks getAllNetworks
+// swagger:route GET /api/networks networks getNetworks
 //
 // Lists all networks.
 //
@@ -278,7 +278,7 @@ func createNetwork(w http.ResponseWriter, r *http.Request) {
 	json.NewEncoder(w).Encode(network)
 }
 
-// swagger:route PUT /api/networks networks updateNetwork
+// swagger:route PUT /api/networks/{networkname} networks updateNetwork
 //
 // Update pro settings for a network.
 //

+ 1 - 1
controllers/node.go

@@ -258,7 +258,7 @@ func Authorize(hostAllowed, networkCheck bool, authNetwork string, next http.Han
 	}
 }
 
-// swagger:route GET /api/nodes/{networkname} nodes getNetworkNodes
+// swagger:route GET /api/nodes/{network} nodes getNetworkNodes
 //
 // Gets all nodes associated with network including pending nodes.
 //

+ 40 - 34
swagger.yml

@@ -1634,7 +1634,7 @@ paths:
                 - hosts
     /api/networks:
         get:
-            operationId: getAllNetworks
+            operationId: getNetworks
             responses:
                 "200":
                     $ref: '#/responses/getNetworksSliceResponse'
@@ -1660,26 +1660,26 @@ paths:
             summary: Create a network.
             tags:
                 - networks
-        put:
-            operationId: updateNetwork
+    /api/networks/{networkname}:
+        delete:
+            operationId: deleteNetwork
             parameters:
-                - description: Network
+                - description: 'name: network name'
                   in: path
-                  name: network
+                  name: networkname
                   required: true
                   type: string
-                  x-go-name: Network
+                  x-go-name: Networkname
             responses:
                 "200":
-                    $ref: '#/responses/networkBodyResponse'
+                    $ref: '#/responses/successResponse'
             schemes:
                 - https
-            summary: Update pro settings for a network.
+            summary: Delete a network.  Will not delete if there are any nodes that belong to the network.
             tags:
                 - networks
-    /api/networks/{networkname}:
-        delete:
-            operationId: deleteNetwork
+        get:
+            operationId: getNetwork
             parameters:
                 - description: 'name: network name'
                   in: path
@@ -1689,14 +1689,14 @@ paths:
                   x-go-name: Networkname
             responses:
                 "200":
-                    $ref: '#/responses/successResponse'
+                    $ref: '#/responses/networkBodyResponse'
             schemes:
                 - https
-            summary: Delete a network.  Will not delete if there are any nodes that belong to the network.
+            summary: Get a network.
             tags:
                 - networks
-        get:
-            operationId: getNetwork
+        put:
+            operationId: updateNetwork
             parameters:
                 - description: 'name: network name'
                   in: path
@@ -1704,12 +1704,18 @@ paths:
                   required: true
                   type: string
                   x-go-name: Networkname
+                - description: Network
+                  in: body
+                  name: network
+                  schema:
+                    $ref: '#/definitions/Network'
+                  x-go-name: Network
             responses:
                 "200":
                     $ref: '#/responses/networkBodyResponse'
             schemes:
                 - https
-            summary: Get a network.
+            summary: Update pro settings for a network.
             tags:
                 - networks
     /api/networks/{networkname}/acls:
@@ -1770,6 +1776,24 @@ paths:
             summary: Get all nodes across all networks.
             tags:
                 - nodes
+    /api/nodes/{network}:
+        get:
+            operationId: getNetworkNodes
+            parameters:
+                - description: Network
+                  in: path
+                  name: network
+                  required: true
+                  type: string
+                  x-go-name: Network
+            responses:
+                "200":
+                    $ref: '#/responses/nodeSliceResponse'
+            schemes:
+                - https
+            summary: Gets all nodes associated with network including pending nodes.
+            tags:
+                - nodes
     /api/nodes/{network}/{nodeid}:
         delete:
             operationId: deleteNode
@@ -2012,24 +2036,6 @@ paths:
             summary: Lists all the users attached to an ingress gateway.
             tags:
                 - users
-    /api/nodes/{networkname}:
-        get:
-            operationId: getNetworkNodes
-            parameters:
-                - description: 'name: network name'
-                  in: path
-                  name: networkname
-                  required: true
-                  type: string
-                  x-go-name: Networkname
-            responses:
-                "200":
-                    $ref: '#/responses/nodeSliceResponse'
-            schemes:
-                - https
-            summary: Gets all nodes associated with network including pending nodes.
-            tags:
-                - nodes
     /api/nodes/adm/{network}/authenticate:
         post:
             operationId: authenticate