nginx-proxy-manager-zh/backend/schema/paths/nginx/streams/streamID/get.json
Jamie Curnow 4572b205c9
Openapi Schema improvements
- Return proper booleans in api responses
- Update jsonschemavalidation to latest draft
2024-10-10 15:53:11 +10:00

55 lines
1020 B
JSON

{
"operationId": "getStream",
"summary": "Get a Stream",
"tags": ["Streams"],
"security": [
{
"BearerAuth": ["streams"]
}
],
"parameters": [
{
"in": "path",
"name": "streamID",
"schema": {
"type": "integer",
"minimum": 1
},
"required": true,
"example": 2
}
],
"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": true,
"udp_forwarding": false,
"meta": {
"nginx_online": true,
"nginx_err": null
},
"enabled": true
}
}
},
"schema": {
"$ref": "../../../../components/stream-object.json"
}
}
}
}
}
}