diff --git a/doc/compiled.json b/doc/compiled.json index 3dce7dc36..54c63eec0 100644 --- a/doc/compiled.json +++ b/doc/compiled.json @@ -26657,6 +26657,16 @@ }, { "$ref": "#/components/parameters/per_page" + }, + { + "name": "q", + "in": "query", + "description": "Filter results by name. Supports the prefix-match syntax `name:`, which returns only spaces whose names begin with ``. Other query formats are ignored; omitting `q` returns all accessible spaces.\n", + "required": false, + "schema": { + "type": "string", + "example": "name:Engineering" + } } ], "responses": { @@ -26693,6 +26703,12 @@ "400": { "$ref": "#/components/responses/400" }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, "404": { "$ref": "#/components/responses/404" }, diff --git a/paths/spaces/index.yaml b/paths/spaces/index.yaml index fca3aa53e..b495b4e55 100644 --- a/paths/spaces/index.yaml +++ b/paths/spaces/index.yaml @@ -9,6 +9,16 @@ parameters: - "$ref": "../../parameters.yaml#/account_id" - "$ref": "../../parameters.yaml#/page" - "$ref": "../../parameters.yaml#/per_page" +- name: q + in: query + description: > + Filter results by name. Supports the prefix-match syntax `name:`, + which returns only spaces whose names begin with ``. + Other query formats are ignored; omitting `q` returns all accessible spaces. + required: false + schema: + type: string + example: "name:Engineering" responses: '200': description: OK @@ -31,6 +41,10 @@ responses: "$ref": "../../headers.yaml#/Pagination" '400': "$ref": "../../responses.yaml#/400" + '401': + "$ref": "../../responses.yaml#/401" + '403': + "$ref": "../../responses.yaml#/403" '404': "$ref": "../../responses.yaml#/404" '429':