nginx-proxy-manager/backend/embed/api_docs/paths/streams/get.json

{
	"operationId": "getStreams",
	"summary": "Get a list of Streams",
	"tags": [
		"Streams"
	],
	"parameters": [
		{
			"in": "query",
			"name": "offset",
			"schema": {
				"type": "number"
			},
			"description": "The pagination row offset, default 0",
			"example": 0
		},
		{
			"in": "query",
			"name": "limit",
			"schema": {
				"type": "number"
			},
			"description": "The pagination row limit, default 10",
			"example": 10
		},
		{
			"in": "query",
			"name": "sort",
			"schema": {
				"type": "string"
			},
			"description": "The sorting of the list",
			"example": "id,name.asc,value.desc"
		}
	],
	"responses": {
		"200": {
			"description": "200 response",
			"content": {
				"application/json": {
					"schema": {
						"required": [
							"result"
						],
						"properties": {
							"result": {
								"$ref": "#/components/schemas/StreamList"
							}
						}
					},
					"examples": {
						"default": {
							"value": {
								"result": {
									"total": 1,
									"offset": 0,
									"limit": 10,
									"sort": [
										{
											"field": "name",
											"direction": "ASC"
										}
									],
									"items": [
										"TODO"
									]
								}
							}
						}
					}
				}
			}
		}
	}
}