nginx-proxy-manager-zh/backend/schema/paths/nginx/streams/get.json
Jamie Curnow dfe2588523
Refactor API Schema and validation
- /schema now returns full openapi/swagger schema
- That schema is used to validate incoming requests
- And used as a contract in future integration tests
- Moved route files up one level
- Fixed incorrect 404 reponses when getting objects
- Fixed saving new objects and passing jsonschemavalidation
2024-10-09 18:05:15 +10:00

56 lines
1.0 KiB
JSON

{
"operationId": "getStreams",
"summary": "Get all streams",
"tags": ["Streams"],
"security": [
{
"BearerAuth": ["streams"]
}
],
"parameters": [
{
"in": "query",
"name": "expand",
"description": "Expansions",
"schema": {
"type": "string",
"enum": ["access_list", "owner", "certificate"]
}
}
],
"responses": {
"200": {
"description": "200 response",
"content": {
"application/json": {
"examples": {
"default": {
"value": [
{
"id": 1,
"created_on": "2024-10-09T02:33:45.000Z",
"modified_on": "2024-10-09T02:33:45.000Z",
"owner_user_id": 1,
"incoming_port": 9090,
"forwarding_host": "router.internal",
"forwarding_port": 80,
"tcp_forwarding": 0,
"udp_forwarding": 0,
"meta": {
"nginx_online": true,
"nginx_err": null
},
"enabled": 1
}
]
}
},
"schema": {
"$ref": "../../../components/stream-list.json"
}
}
}
}
}
}