opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-06-24 03:08:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(API): Fix compat network (dis-)connect

Browse Source 
The endpoints to (dis-)connect networks from/to a container are
no longer no-ops. Furthermore, the 403 error handled since #20365
has been documented

Signed-off-by: Philipp Fruck <dev@p-fruck.de>
This commit is contained in:
Philipp Fruck
2023-10-24 17:16:41 +02:00
parent ed58ea7849
commit 0a2aae119e
2 changed files with 11 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
pkg/api/handlers/swagger/errors.go
View File

@ -28,6 +28,13 @@ type networkNotFound struct {
Body errorhandling.ErrorModel
}
// Network is already connected and container is running or transitioning to the running state ('initialized')
// swagger:response
type networkConnectedError struct {
// in:body
Body errorhandling.ErrorModel
}
// No such exec instance
// swagger:response
type execSessionNotFound struct {

6
pkg/api/server/register_networks.go
View File

@ -125,7 +125,7 @@ func (s *APIServer) registerNetworkHandlers(r *mux.Router) error {
// tags:
// - networks (compat)
// summary: Connect container to network
// description: Connect a container to a network. This endpoint is current a no-op
// description: Connect a container to a network
// produces:
// - application/json
// parameters:
@ -144,6 +144,8 @@ func (s *APIServer) registerNetworkHandlers(r *mux.Router) error {
// description: OK
// 400:
// $ref: "#/responses/badParamError"
// 403:
// $ref: "#/responses/networkConnectedError"
// 500:
// $ref: "#/responses/internalError"
r.HandleFunc(VersionedPath("/networks/{name}/connect"), s.APIHandler(compat.Connect)).Methods(http.MethodPost)
@ -153,7 +155,7 @@ func (s *APIServer) registerNetworkHandlers(r *mux.Router) error {
// tags:
// - networks (compat)
// summary: Disconnect container from network
// description: Disconnect a container from a network. This endpoint is current a no-op
// description: Disconnect a container from a network
// produces:
// - application/json
// parameters: