소스 검색

Add new error to API docs

Commit cc493a52a46271df82dbebea26038502b85788b9 added
a constraint to network connect/disconnect operations
on "Swarm scoped" networks.

This adds those errors to the API documentation. Also
changes the error to lowercase for consistency.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Sebastiaan van Stijn 9 년 전
부모
커밋
b0089e4827
3개의 변경된 파일6개의 추가작업 그리고 2개의 파일을 삭제
  1. 2 2
      api/server/router/network/network_routes.go
  2. 2 0
      docs/reference/api/docker_remote_api_v1.24.md
  3. 2 0
      docs/reference/api/docker_remote_api_v1.25.md

+ 2 - 2
api/server/router/network/network_routes.go

@@ -121,7 +121,7 @@ func (n *networkRouter) postNetworkConnect(ctx context.Context, w http.ResponseW
 	}
 
 	if nw.Info().Dynamic() {
-		return newNetworkForbiddenError("Operation not supported for swarm scoped networks")
+		return newNetworkForbiddenError("operation not supported for swarm scoped networks")
 	}
 
 	return n.backend.ConnectContainerToNetwork(connect.Container, nw.Name(), connect.EndpointConfig)
@@ -147,7 +147,7 @@ func (n *networkRouter) postNetworkDisconnect(ctx context.Context, w http.Respon
 	}
 
 	if nw.Info().Dynamic() {
-		return newNetworkForbiddenError("Operation not supported for swarm scoped networks")
+		return newNetworkForbiddenError("operation not supported for swarm scoped networks")
 	}
 
 	return n.backend.DisconnectContainerFromNetwork(disconnect.Container, nw, disconnect.Force)

+ 2 - 0
docs/reference/api/docker_remote_api_v1.24.md

@@ -3259,6 +3259,7 @@ Content-Type: application/json
 **Status codes**:
 
 - **200** - no error
+- **403** - operation not supported for swarm scoped networks
 - **404** - network or container is not found
 - **500** - Internal Server Error
 
@@ -3291,6 +3292,7 @@ Content-Type: application/json
 **Status codes**:
 
 - **200** - no error
+- **403** - operation not supported for swarm scoped networks
 - **404** - network or container not found
 - **500** - Internal Server Error
 

+ 2 - 0
docs/reference/api/docker_remote_api_v1.25.md

@@ -3260,6 +3260,7 @@ Content-Type: application/json
 **Status codes**:
 
 - **200** - no error
+- **403** - operation not supported for swarm scoped networks
 - **404** - network or container is not found
 - **500** - Internal Server Error
 
@@ -3292,6 +3293,7 @@ Content-Type: application/json
 **Status codes**:
 
 - **200** - no error
+- **403** - operation not supported for swarm scoped networks
 - **404** - network or container not found
 - **500** - Internal Server Error