anti/DECNET
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix(api): document 400 on topology read endpoints for schemathesis contract

Browse Source 
DECNET's app-level RequestValidationError handler remaps structural
422→400, including query/path constraint violations (limit bounds,
the next-subnet base pattern, etc.).  Schemathesis fuzzing will drive
those code paths and fail response_schema_conformance unless 400 is
declared in responses={}.  Adds the entry to every phase-3 read route.
This commit is contained in:
anti
2026-04-20 18:30:32 -04:00
parent f182c98ffa
commit 38db76dd14
3 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
decnet/web/router/topology/api_catalog.py
View File

@@ -30,6 +30,7 @@ router = APIRouter()
tags=["MazeNET Topologies"], tags=["MazeNET Topologies"],
response_model=ServiceCatalogResponse, response_model=ServiceCatalogResponse,
responses={ responses={
400: {"description": "Malformed query parameters"},
401: {"description": "Missing or invalid credentials"}, 401: {"description": "Missing or invalid credentials"},
403: {"description": "Insufficient permissions"}, 403: {"description": "Insufficient permissions"},
}, },
@@ -70,6 +71,7 @@ async def api_next_subnet(
tags=["MazeNET Topologies"], tags=["MazeNET Topologies"],
response_model=NextIPResponse, response_model=NextIPResponse,
responses={ responses={
400: {"description": "Malformed path parameters"},
401: {"description": "Missing or invalid credentials"}, 401: {"description": "Missing or invalid credentials"},
403: {"description": "Insufficient permissions"}, 403: {"description": "Insufficient permissions"},
404: {"description": "Topology or LAN not found"}, 404: {"description": "Topology or LAN not found"},

2
decnet/web/router/topology/api_get_topology.py
View File

@@ -23,6 +23,7 @@ router = APIRouter()
tags=["MazeNET Topologies"], tags=["MazeNET Topologies"],
response_model=TopologyDetail, response_model=TopologyDetail,
responses={ responses={
400: {"description": "Malformed path parameters"},
401: {"description": "Missing or invalid credentials"}, 401: {"description": "Missing or invalid credentials"},
403: {"description": "Insufficient permissions"}, 403: {"description": "Insufficient permissions"},
404: {"description": "Topology not found"}, 404: {"description": "Topology not found"},
@@ -49,6 +50,7 @@ async def api_get_topology(
tags=["MazeNET Topologies"], tags=["MazeNET Topologies"],
response_model=list[TopologyStatusEventRow], response_model=list[TopologyStatusEventRow],
responses={ responses={
400: {"description": "Malformed query parameters"},
401: {"description": "Missing or invalid credentials"}, 401: {"description": "Missing or invalid credentials"},
403: {"description": "Insufficient permissions"}, 403: {"description": "Insufficient permissions"},
404: {"description": "Topology not found"}, 404: {"description": "Topology not found"},

1
decnet/web/router/topology/api_list_topologies.py
View File

@@ -17,6 +17,7 @@ router = APIRouter()
tags=["MazeNET Topologies"], tags=["MazeNET Topologies"],
response_model=TopologyListResponse, response_model=TopologyListResponse,
responses={ responses={
400: {"description": "Malformed query parameters"},
401: {"description": "Missing or invalid credentials"}, 401: {"description": "Missing or invalid credentials"},
403: {"description": "Insufficient permissions"}, 403: {"description": "Insufficient permissions"},
}, },