Skip to content
This repository has been archived by the owner on Nov 8, 2022. It is now read-only.

Commit

Permalink
added unauthorized response code to the rest api v2
Browse files Browse the repository at this point in the history
  • Loading branch information
@candysmurf
candysmurf committed Jun 9, 2017
1 parent c823d36 commit c1a0e5c
Show file tree
Hide file tree
Showing 3 changed files with 59 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc.go
View file
Expand Up @@ -28,9 +28,9 @@
// - basicAuth: [] // - basicAuth: []
// //
// SecurityDefinitions: // SecurityDefinitions:
// - basicAuth: // basicAuth:
// type: basic // type: basic
// description: HTTP basic authentication. // description: HTTP basic authentication.
// //
// swagger:meta // swagger:meta
package main package main
14 changes: 14 additions & 0 deletions mgmt/rest/v2/api.go
View file
Expand Up @@ -69,6 +69,7 @@ func (s *apiV2) GetRoutes() []api.Route {
// //
// Responses: // Responses:
// 200: PluginsResponse // 200: PluginsResponse
// 401: ErrorResponse
api.Route{Method: "GET", Path: prefix + "/plugins", Handle: s.getPlugins}, api.Route{Method: "GET", Path: prefix + "/plugins", Handle: s.getPlugins},
// swagger:route GET /plugins/{ptype}/{pname}/{pversion} plugins getPlugin // swagger:route GET /plugins/{ptype}/{pname}/{pversion} plugins getPlugin
// //
Expand All @@ -86,6 +87,7 @@ func (s *apiV2) GetRoutes() []api.Route {
// 400: ErrorResponse // 400: ErrorResponse
// 404: ErrorResponse // 404: ErrorResponse
// 500: ErrorResponse // 500: ErrorResponse
// 401: ErrorResponse
api.Route{Method: "GET", Path: prefix + "/plugins/:type/:name/:version", Handle: s.getPlugin}, api.Route{Method: "GET", Path: prefix + "/plugins/:type/:name/:version", Handle: s.getPlugin},
// swagger:route POST /plugins plugins loadPlugin // swagger:route POST /plugins plugins loadPlugin
// //
Expand All @@ -107,6 +109,7 @@ func (s *apiV2) GetRoutes() []api.Route {
// 409: ErrorResponse // 409: ErrorResponse
// 415: ErrorResponse // 415: ErrorResponse
// 500: ErrorResponse // 500: ErrorResponse
// 401: ErrorResponse
api.Route{Method: "POST", Path: prefix + "/plugins", Handle: s.loadPlugin}, api.Route{Method: "POST", Path: prefix + "/plugins", Handle: s.loadPlugin},
// swagger:route DELETE /plugins/{ptype}/{pname}/{pversion} plugins unloadPlugin // swagger:route DELETE /plugins/{ptype}/{pname}/{pversion} plugins unloadPlugin
// //
Expand All @@ -125,6 +128,7 @@ func (s *apiV2) GetRoutes() []api.Route {
// 404: ErrorResponse // 404: ErrorResponse
// 409: ErrorResponse // 409: ErrorResponse
// 500: ErrorResponse // 500: ErrorResponse
// 401: ErrorResponse
api.Route{Method: "DELETE", Path: prefix + "/plugins/:type/:name/:version", Handle: s.unloadPlugin}, api.Route{Method: "DELETE", Path: prefix + "/plugins/:type/:name/:version", Handle: s.unloadPlugin},
// swagger:route GET /plugins/{ptype}/{pname}/{pversion}/config plugins getPluginConfigItem // swagger:route GET /plugins/{ptype}/{pname}/{pversion}/config plugins getPluginConfigItem
// //
Expand All @@ -140,6 +144,7 @@ func (s *apiV2) GetRoutes() []api.Route {
// Responses: // Responses:
// 200: PluginConfigResponse // 200: PluginConfigResponse
// 400: ErrorResponse // 400: ErrorResponse
// 401: ErrorResponse
api.Route{Method: "GET", Path: prefix + "/plugins/:type/:name/:version/config", Handle: s.getPluginConfigItem}, api.Route{Method: "GET", Path: prefix + "/plugins/:type/:name/:version/config", Handle: s.getPluginConfigItem},
// swagger:route PUT /plugins/{ptype}/{pname}/{pversion}/config plugins setPluginConfigItem // swagger:route PUT /plugins/{ptype}/{pname}/{pversion}/config plugins setPluginConfigItem
// //
Expand All @@ -158,6 +163,7 @@ func (s *apiV2) GetRoutes() []api.Route {
// Responses: // Responses:
// 200: PluginConfigResponse // 200: PluginConfigResponse
// 400: ErrorResponse // 400: ErrorResponse
// 401: ErrorResponse
api.Route{Method: "PUT", Path: prefix + "/plugins/:type/:name/:version/config", Handle: s.setPluginConfigItem}, api.Route{Method: "PUT", Path: prefix + "/plugins/:type/:name/:version/config", Handle: s.setPluginConfigItem},
// swagger:route DELETE /plugins/{ptype}/{pname}/{pversion}/config plugins deletePluginConfigItem // swagger:route DELETE /plugins/{ptype}/{pname}/{pversion}/config plugins deletePluginConfigItem
// //
Expand All @@ -176,6 +182,7 @@ func (s *apiV2) GetRoutes() []api.Route {
// Responses: // Responses:
// 200: PluginConfigResponse // 200: PluginConfigResponse
// 400: ErrorResponse // 400: ErrorResponse
// 401: ErrorResponse
api.Route{Method: "DELETE", Path: prefix + "/plugins/:type/:name/:version/config", Handle: s.deletePluginConfigItem}, api.Route{Method: "DELETE", Path: prefix + "/plugins/:type/:name/:version/config", Handle: s.deletePluginConfigItem},
// swagger:route GET /metrics plugins getMetrics // swagger:route GET /metrics plugins getMetrics
// //
Expand All @@ -192,6 +199,7 @@ func (s *apiV2) GetRoutes() []api.Route {
// 200: MetricsResponse // 200: MetricsResponse
// 404: ErrorResponse // 404: ErrorResponse
// 500: ErrorResponse // 500: ErrorResponse
// 401: ErrorResponse
api.Route{Method: "GET", Path: prefix + "/metrics", Handle: s.getMetrics}, api.Route{Method: "GET", Path: prefix + "/metrics", Handle: s.getMetrics},
// swagger:route GET /tasks tasks getTasks // swagger:route GET /tasks tasks getTasks
// //
Expand All @@ -206,6 +214,7 @@ func (s *apiV2) GetRoutes() []api.Route {
// //
// Responses: // Responses:
// 200: TasksResponse // 200: TasksResponse
// 401: ErrorResponse
api.Route{Method: "GET", Path: prefix + "/tasks", Handle: s.getTasks}, api.Route{Method: "GET", Path: prefix + "/tasks", Handle: s.getTasks},
// swagger:route GET /tasks/{id} tasks getTask // swagger:route GET /tasks/{id} tasks getTask
// //
Expand All @@ -221,6 +230,7 @@ func (s *apiV2) GetRoutes() []api.Route {
// Responses: // Responses:
// 200: TaskResponse // 200: TaskResponse
// 404: ErrorResponse // 404: ErrorResponse
// 401: ErrorResponse
api.Route{Method: "GET", Path: prefix + "/tasks/:id", Handle: s.getTask}, api.Route{Method: "GET", Path: prefix + "/tasks/:id", Handle: s.getTask},
// swagger:route GET /tasks/{id}/watch tasks watchTask // swagger:route GET /tasks/{id}/watch tasks watchTask
// //
Expand All @@ -237,6 +247,7 @@ func (s *apiV2) GetRoutes() []api.Route {
// 200: TaskWatchResponse // 200: TaskWatchResponse
// 404: ErrorResponse // 404: ErrorResponse
// 500: ErrorResponse // 500: ErrorResponse
// 401: ErrorResponse
api.Route{Method: "GET", Path: prefix + "/tasks/:id/watch", Handle: s.watchTask}, api.Route{Method: "GET", Path: prefix + "/tasks/:id/watch", Handle: s.watchTask},
// swagger:route POST /tasks tasks addTask // swagger:route POST /tasks tasks addTask
// //
Expand All @@ -255,6 +266,7 @@ func (s *apiV2) GetRoutes() []api.Route {
// Responses: // Responses:
// 201: TaskResponse // 201: TaskResponse
// 500: ErrorResponse // 500: ErrorResponse
// 401: ErrorResponse
api.Route{Method: "POST", Path: prefix + "/tasks", Handle: s.addTask}, api.Route{Method: "POST", Path: prefix + "/tasks", Handle: s.addTask},
// swagger:route PUT /tasks/{id} tasks updateTaskState // swagger:route PUT /tasks/{id} tasks updateTaskState
// //
Expand All @@ -275,6 +287,7 @@ func (s *apiV2) GetRoutes() []api.Route {
// 400: ErrorResponse // 400: ErrorResponse
// 409: ErrorResponse // 409: ErrorResponse
// 500: ErrorResponse // 500: ErrorResponse
// 401: ErrorResponse
api.Route{Method: "PUT", Path: prefix + "/tasks/:id", Handle: s.updateTaskState}, api.Route{Method: "PUT", Path: prefix + "/tasks/:id", Handle: s.updateTaskState},
// swagger:route DELETE /tasks/{id} tasks removeTask // swagger:route DELETE /tasks/{id} tasks removeTask
// //
Expand All @@ -291,6 +304,7 @@ func (s *apiV2) GetRoutes() []api.Route {
// 204: TaskResponse // 204: TaskResponse
// 404: ErrorResponse // 404: ErrorResponse
// 500: TaskErrorResponse // 500: TaskErrorResponse
// 401: ErrorResponse
api.Route{Method: "DELETE", Path: prefix + "/tasks/:id", Handle: s.removeTask}, api.Route{Method: "DELETE", Path: prefix + "/tasks/:id", Handle: s.removeTask},
} }
return routes return routes
Expand Down
42 changes: 42 additions & 0 deletions swagger.json
View file
Expand Up @@ -62,6 +62,9 @@
"200": { "200": {
"$ref": "#/responses/MetricsResponse" "$ref": "#/responses/MetricsResponse"
}, },
"401": {
"$ref": "#/responses/ErrorResponse"
},
"404": { "404": {
"$ref": "#/responses/ErrorResponse" "$ref": "#/responses/ErrorResponse"
}, },
Expand Down Expand Up @@ -114,6 +117,9 @@
"responses": { "responses": {
"200": { "200": {
"$ref": "#/responses/PluginsResponse" "$ref": "#/responses/PluginsResponse"
},
"401": {
"$ref": "#/responses/ErrorResponse"
} }
} }
}, },
Expand Down Expand Up @@ -150,6 +156,9 @@
"400": { "400": {
"$ref": "#/responses/ErrorResponse" "$ref": "#/responses/ErrorResponse"
}, },
"401": {
"$ref": "#/responses/ErrorResponse"
},
"409": { "409": {
"$ref": "#/responses/ErrorResponse" "$ref": "#/responses/ErrorResponse"
}, },
Expand Down Expand Up @@ -213,6 +222,9 @@
"400": { "400": {
"$ref": "#/responses/ErrorResponse" "$ref": "#/responses/ErrorResponse"
}, },
"401": {
"$ref": "#/responses/ErrorResponse"
},
"404": { "404": {
"$ref": "#/responses/ErrorResponse" "$ref": "#/responses/ErrorResponse"
}, },
Expand Down Expand Up @@ -271,6 +283,9 @@
"400": { "400": {
"$ref": "#/responses/ErrorResponse" "$ref": "#/responses/ErrorResponse"
}, },
"401": {
"$ref": "#/responses/ErrorResponse"
},
"404": { "404": {
"$ref": "#/responses/ErrorResponse" "$ref": "#/responses/ErrorResponse"
}, },
Expand Down Expand Up @@ -333,6 +348,9 @@
}, },
"400": { "400": {
"$ref": "#/responses/ErrorResponse" "$ref": "#/responses/ErrorResponse"
},
"401": {
"$ref": "#/responses/ErrorResponse"
} }
} }
}, },
Expand Down Expand Up @@ -399,6 +417,9 @@
}, },
"400": { "400": {
"$ref": "#/responses/ErrorResponse" "$ref": "#/responses/ErrorResponse"
},
"401": {
"$ref": "#/responses/ErrorResponse"
} }
} }
}, },
Expand Down Expand Up @@ -466,6 +487,9 @@
}, },
"400": { "400": {
"$ref": "#/responses/ErrorResponse" "$ref": "#/responses/ErrorResponse"
},
"401": {
"$ref": "#/responses/ErrorResponse"
} }
} }
} }
Expand All @@ -488,6 +512,9 @@
"responses": { "responses": {
"200": { "200": {
"$ref": "#/responses/TasksResponse" "$ref": "#/responses/TasksResponse"
},
"401": {
"$ref": "#/responses/ErrorResponse"
} }
} }
}, },
Expand Down Expand Up @@ -524,6 +551,9 @@
"201": { "201": {
"$ref": "#/responses/TaskResponse" "$ref": "#/responses/TaskResponse"
}, },
"401": {
"$ref": "#/responses/ErrorResponse"
},
"500": { "500": {
"$ref": "#/responses/ErrorResponse" "$ref": "#/responses/ErrorResponse"
} }
Expand Down Expand Up @@ -558,6 +588,9 @@
"200": { "200": {
"$ref": "#/responses/TaskResponse" "$ref": "#/responses/TaskResponse"
}, },
"401": {
"$ref": "#/responses/ErrorResponse"
},
"404": { "404": {
"$ref": "#/responses/ErrorResponse" "$ref": "#/responses/ErrorResponse"
} }
Expand Down Expand Up @@ -604,6 +637,9 @@
"400": { "400": {
"$ref": "#/responses/ErrorResponse" "$ref": "#/responses/ErrorResponse"
}, },
"401": {
"$ref": "#/responses/ErrorResponse"
},
"409": { "409": {
"$ref": "#/responses/ErrorResponse" "$ref": "#/responses/ErrorResponse"
}, },
Expand Down Expand Up @@ -639,6 +675,9 @@
"204": { "204": {
"$ref": "#/responses/TaskResponse" "$ref": "#/responses/TaskResponse"
}, },
"401": {
"$ref": "#/responses/ErrorResponse"
},
"404": { "404": {
"$ref": "#/responses/ErrorResponse" "$ref": "#/responses/ErrorResponse"
}, },
Expand Down Expand Up @@ -676,6 +715,9 @@
"200": { "200": {
"$ref": "#/responses/TaskWatchResponse" "$ref": "#/responses/TaskWatchResponse"
}, },
"401": {
"$ref": "#/responses/ErrorResponse"
},
"404": { "404": {
"$ref": "#/responses/ErrorResponse" "$ref": "#/responses/ErrorResponse"
}, },
Expand Down

0 comments on commit c1a0e5c

Please sign in to comment.