Fix sections for /server/ and /users/ paths in Swagger docs

controllers/server.go

@@ -67,7 +67,7 @@ func securityCheckServer(adminonly bool, next http.Handler) http.HandlerFunc {
 	}
 }
 
-// swagger:route DELETE /api/server/removenetwork/{network} nodes removeNetwork
+// swagger:route DELETE /api/server/removenetwork/{network} server removeNetwork
 //
 // Remove a network from the server.
 //
@@ -97,7 +97,7 @@ func removeNetwork(w http.ResponseWriter, r *http.Request) {
 	json.NewEncoder(w).Encode(fmt.Sprintf("network %s removed from server", network))
 }
 
-// swagger:route GET /api/server/getserverinfo nodes getServerInfo
+// swagger:route GET /api/server/getserverinfo server getServerInfo
 //
 // Get the server configuration.
 //
@@ -118,7 +118,7 @@ func getServerInfo(w http.ResponseWriter, r *http.Request) {
 	//w.WriteHeader(http.StatusOK)
 }
 
-// swagger:route GET /api/server/getconfig nodes getConfig
+// swagger:route GET /api/server/getconfig server getConfig
 //
 // Get the server configuration.
 //
@@ -140,7 +140,7 @@ func getConfig(w http.ResponseWriter, r *http.Request) {
 	//w.WriteHeader(http.StatusOK)
 }
 
-// swagger:route POST /api/server/register nodes register
+// swagger:route POST /api/server/register server register
 //
 // Registers a client with the server and return the Certificate Authority and certificate.
 //

controllers/user.go

@@ -30,7 +30,7 @@ func userHandlers(r *mux.Router) {
 	r.HandleFunc("/api/oauth/callback", auth.HandleAuthCallback).Methods("GET")
 }
 
-// swagger:route POST /api/users/adm/authenticate nodes authenticateUser
+// swagger:route POST /api/users/adm/authenticate user authenticateUser
 //
 // Node authenticates using its password and retrieves a JWT for authorization.
 //
@@ -97,7 +97,7 @@ func authenticateUser(response http.ResponseWriter, request *http.Request) {
 	response.Write(successJSONResponse)
 }
 
-// swagger:route GET /api/users/adm/hasadmin nodes hasAdmin
+// swagger:route GET /api/users/adm/hasadmin user hasAdmin
 //
 // Checks whether the server has an admin.
 //
@@ -137,7 +137,7 @@ func GetUserInternal(username string) (models.User, error) {
 	return user, err
 }
 
-// swagger:route GET /api/users/{username} nodes getUser
+// swagger:route GET /api/users/{username} user getUser
 //
 // Get an individual user.
 //
@@ -165,7 +165,7 @@ func getUser(w http.ResponseWriter, r *http.Request) {
 	json.NewEncoder(w).Encode(user)
 }
 
-// swagger:route GET /api/users nodes getUsers
+// swagger:route GET /api/users user getUsers
 //
 // Get all users.
 //
@@ -192,7 +192,7 @@ func getUsers(w http.ResponseWriter, r *http.Request) {
 	json.NewEncoder(w).Encode(users)
 }
 
-// swagger:route POST /api/users/adm/createadmin nodes createAdmin
+// swagger:route POST /api/users/adm/createadmin user createAdmin
 //
 // Make a user an admin.
 //
@@ -228,7 +228,7 @@ func createAdmin(w http.ResponseWriter, r *http.Request) {
 	json.NewEncoder(w).Encode(admin)
 }
 
-// swagger:route POST /api/users/{username} nodes createUser
+// swagger:route POST /api/users/{username} user createUser
 //
 // Create a user.
 //
@@ -261,7 +261,7 @@ func createUser(w http.ResponseWriter, r *http.Request) {
 	json.NewEncoder(w).Encode(user)
 }
 
-// swagger:route PUT /api/users/networks/{username} nodes updateUserNetworks
+// swagger:route PUT /api/users/networks/{username} user updateUserNetworks
 //
 // Updates the networks of the given user.
 //
@@ -305,7 +305,7 @@ func updateUserNetworks(w http.ResponseWriter, r *http.Request) {
 	json.NewEncoder(w).Encode(user)
 }
 
-// swagger:route PUT /api/users/{username} nodes updateUser
+// swagger:route PUT /api/users/{username} user updateUser
 //
 // Update a user.
 //
@@ -356,7 +356,7 @@ func updateUser(w http.ResponseWriter, r *http.Request) {
 	json.NewEncoder(w).Encode(user)
 }
 
-// swagger:route PUT /api/users/{username}/adm nodes updateUserAdm
+// swagger:route PUT /api/users/{username}/adm user updateUserAdm
 //
 // Updates the given admin user's info (as long as the user is an admin).
 //
@@ -408,7 +408,7 @@ func updateUserAdm(w http.ResponseWriter, r *http.Request) {
 	json.NewEncoder(w).Encode(user)
 }
 
-// swagger:route DELETE /api/users/{username} nodes deleteUser
+// swagger:route DELETE /api/users/{username} user deleteUser
 //
 // Delete a user.
 //

swagger.yaml

@@ -1087,6 +1087,13 @@ paths:
     /api/networks/{networkname}:
         delete:
             operationId: deleteNetwork
+            parameters:
+                - description: Network Name
+                  in: path
+                  name: networkname
+                  required: true
+                  type: string
+                  x-go-name: NetworkName
             responses:
                 "200":
                     $ref: '#/responses/stringJSONResponse'
@@ -1097,6 +1104,13 @@ paths:
                 - networks
         get:
             operationId: getNetwork
+            parameters:
+                - description: Network Name
+                  in: path
+                  name: networkname
+                  required: true
+                  type: string
+                  x-go-name: NetworkName
             responses:
                 "200":
                     $ref: '#/responses/networkBodyResponse'
@@ -1114,6 +1128,12 @@ paths:
                   schema:
                     $ref: '#/definitions/Network'
                   x-go-name: Network
+                - description: Network Name
+                  in: path
+                  name: networkname
+                  required: true
+                  type: string
+                  x-go-name: NetworkName
             responses:
                 "200":
                     $ref: '#/responses/networkBodyResponse'
@@ -1126,6 +1146,12 @@ paths:
         get:
             operationId: getNetworkACL
             parameters:
+                - description: Network Name
+                  in: path
+                  name: networkname
+                  required: true
+                  type: string
+                  x-go-name: NetworkName
                 - description: ACL Container
                   in: body
                   name: acl_container
@@ -1143,6 +1169,12 @@ paths:
         put:
             operationId: updateNetworkACL
             parameters:
+                - description: Network Name
+                  in: path
+                  name: networkname
+                  required: true
+                  type: string
+                  x-go-name: NetworkName
                 - description: ACL Container
                   in: body
                   name: acl_container
@@ -1160,6 +1192,13 @@ paths:
     /api/networks/{networkname}/keys:
         get:
             operationId: getAccessKeys
+            parameters:
+                - description: Network Name
+                  in: path
+                  name: networkname
+                  required: true
+                  type: string
+                  x-go-name: NetworkName
             responses:
                 "200":
                     $ref: '#/responses/accessKeySliceBodyResponse'
@@ -1171,6 +1210,12 @@ paths:
         post:
             operationId: createAccessKey
             parameters:
+                - description: Network Name
+                  in: path
+                  name: networkname
+                  required: true
+                  type: string
+                  x-go-name: NetworkName
                 - description: Access Key
                   in: body
                   name: access_key
@@ -1189,6 +1234,12 @@ paths:
         delete:
             operationId: deleteAccessKey
             parameters:
+                - description: Network Name
+                  in: path
+                  name: networkname
+                  required: true
+                  type: string
+                  x-go-name: NetworkName
                 - description: Access Key Name
                   in: path
                   name: access_key_name
@@ -1206,6 +1257,13 @@ paths:
     /api/networks/{networkname}/keyupdate:
         post:
             operationId: keyUpdate
+            parameters:
+                - description: Network Name
+                  in: path
+                  name: networkname
+                  required: true
+                  type: string
+                  x-go-name: NetworkName
             responses:
                 "200":
                     $ref: '#/responses/networkBodyResponse'
@@ -1217,6 +1275,13 @@ paths:
     /api/networks/{networkname}/nodelimit:
         put:
             operationId: updateNetworkNodeLimit
+            parameters:
+                - description: Network Name
+                  in: path
+                  name: networkname
+                  required: true
+                  type: string
+                  x-go-name: NetworkName
             responses:
                 "200":
                     $ref: '#/responses/networkBodyResponse'
@@ -1239,13 +1304,6 @@ paths:
     /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'
@@ -1256,13 +1314,6 @@ paths:
                 - nodes
         post:
             operationId: createNode
-            parameters:
-                - description: Network
-                  in: path
-                  name: network
-                  required: true
-                  type: string
-                  x-go-name: Network
             responses:
                 "200":
                     $ref: '#/responses/nodeGetResponse'
@@ -1537,12 +1588,6 @@ paths:
         post:
             operationId: authenticate
             parameters:
-                - description: Network
-                  in: path
-                  name: network
-                  required: true
-                  type: string
-                  x-go-name: Network
                 - description: AuthParams
                   in: body
                   name: auth_params
@@ -1560,13 +1605,6 @@ paths:
     /api/nodes/adm/{network}/lastmodified:
         get:
             operationId: getLastModified
-            parameters:
-                - description: Network
-                  in: path
-                  name: network
-                  required: true
-                  type: string
-                  x-go-name: Network
             responses:
                 "200":
                     $ref: '#/responses/nodeLastModifiedResponse'
@@ -1593,7 +1631,7 @@ paths:
                 - https
             summary: Get the server configuration.
             tags:
-                - nodes
+                - server
     /api/server/getserverinfo:
         get:
             operationId: getServerInfo
@@ -1604,7 +1642,7 @@ paths:
                 - https
             summary: Get the server configuration.
             tags:
-                - nodes
+                - server
     /api/server/register:
         post:
             operationId: register
@@ -1622,17 +1660,10 @@ paths:
                 - https
             summary: Registers a client with the server and return the Certificate Authority and certificate.
             tags:
-                - nodes
+                - server
     /api/server/removenetwork/{network}:
         delete:
             operationId: removeNetwork
-            parameters:
-                - description: Network
-                  in: path
-                  name: network
-                  required: true
-                  type: string
-                  x-go-name: Network
             responses:
                 "200":
                     $ref: '#/responses/stringJSONResponse'
@@ -1640,7 +1671,7 @@ paths:
                 - https
             summary: Remove a network from the server.
             tags:
-                - nodes
+                - server
     /api/users:
         get:
             operationId: getUsers
@@ -1651,7 +1682,7 @@ paths:
                 - https
             summary: Get all users.
             tags:
-                - nodes
+                - user
     /api/users/{username}:
         delete:
             operationId: deleteUser
@@ -1669,7 +1700,7 @@ paths:
                 - https
             summary: Delete a user.
             tags:
-                - nodes
+                - user
         get:
             operationId: getUser
             parameters:
@@ -1686,7 +1717,7 @@ paths:
                 - https
             summary: Get an individual user.
             tags:
-                - nodes
+                - user
         post:
             operationId: createUser
             parameters:
@@ -1709,7 +1740,7 @@ paths:
                 - https
             summary: Create a user.
             tags:
-                - nodes
+                - user
         put:
             operationId: updateUser
             parameters:
@@ -1732,7 +1763,7 @@ paths:
                 - https
             summary: Update a user.
             tags:
-                - nodes
+                - user
     /api/users/{username}/adm:
         put:
             operationId: updateUserAdm
@@ -1750,7 +1781,7 @@ paths:
                 - https
             summary: Updates the given admin user's info (as long as the user is an admin).
             tags:
-                - nodes
+                - user
     /api/users/adm/authenticate:
         post:
             operationId: authenticateUser
@@ -1768,7 +1799,7 @@ paths:
                 - https
             summary: Node authenticates using its password and retrieves a JWT for authorization.
             tags:
-                - nodes
+                - user
     /api/users/adm/createadmin:
         post:
             operationId: createAdmin
@@ -1786,7 +1817,7 @@ paths:
                 - https
             summary: Make a user an admin.
             tags:
-                - nodes
+                - user
     /api/users/adm/hasadmin:
         get:
             operationId: hasAdmin
@@ -1797,7 +1828,7 @@ paths:
                 - https
             summary: Checks whether the server has an admin.
             tags:
-                - nodes
+                - user
     /api/users/networks/{username}:
         put:
             operationId: updateUserNetworks
@@ -1821,7 +1852,7 @@ paths:
                 - https
             summary: Updates the networks of the given user.
             tags:
-                - nodes
+                - user
     /meshclient/files/{filename}:
         get:
             operationId: fileServer