fixed(api): documentation
This commit is contained in:
@@ -30,8 +30,11 @@ api_router = APIRouter(
|
|||||||
# require_* Depends or by the global auth middleware). Document 401/403
|
# require_* Depends or by the global auth middleware). Document 401/403
|
||||||
# here so the OpenAPI schema reflects reality for contract tests.
|
# here so the OpenAPI schema reflects reality for contract tests.
|
||||||
responses={
|
responses={
|
||||||
|
400: {"description": "Malformed request body"},
|
||||||
401: {"description": "Missing or invalid credentials"},
|
401: {"description": "Missing or invalid credentials"},
|
||||||
403: {"description": "Authenticated but not authorized"},
|
403: {"description": "Authenticated but not authorized"},
|
||||||
|
404: {"description": "Referenced resource does not exist"},
|
||||||
|
409: {"description": "Conflict with existing resource"},
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|||||||
@@ -26,7 +26,8 @@ router = APIRouter()
|
|||||||
403: {"description": "Insufficient permissions"},
|
403: {"description": "Insufficient permissions"},
|
||||||
409: {"description": "Configuration conflict (e.g. invalid IP allocation or network mismatch)"},
|
409: {"description": "Configuration conflict (e.g. invalid IP allocation or network mismatch)"},
|
||||||
422: {"description": "Invalid INI config or schema validation error"},
|
422: {"description": "Invalid INI config or schema validation error"},
|
||||||
500: {"description": "Deployment failed"}
|
500: {"description": "Deployment failed"},
|
||||||
|
502: {"description": "Partial swarm deploy failure — one or more worker hosts returned an error"},
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
@_traced("api.deploy_deckies")
|
@_traced("api.deploy_deckies")
|
||||||
|
|||||||
Reference in New Issue
Block a user