Skip to content

feat(API): add name filter query parameter to spaces list #STRINGS-3036 - #1267

Merged
Sven Dunemann (forelabs) merged 1 commit into
mainfrom
openapi-sync/strings-app-pr-18725
Sep 14, 2026
Merged

Sven Dunemann (forelabs) merged 1 commit into
mainfrom
openapi-sync/strings-app-pr-18725

Conversation

@phrase-bot

Copy link
Copy Markdown
Collaborator

This PR was generated by the openapi-apply agent in response to a
/openapi-sync apply request on
Phrase-Engineering/strings-app#18725.

What changed in the API

  • GET /api/v2/accounts/{account_id}/spaces now accepts an optional q query parameter. When set to name:<value>, the response is filtered to spaces whose names begin with <value> (case-sensitive prefix match). When q is absent or does not match the name: prefix, all accessible spaces are returned unchanged.

Source

Notes for reviewers

  • lint.sh (openapi-generator-cli validation) reported java: not found in the CI environment — Java was not available when the agent ran, so the generator validation step was skipped. The swagger-cli validate and make bundle steps both passed cleanly (exit 0). Please verify generator lint locally if needed.
  • Added 401 and 403 responses to paths/spaces/index.yaml which were missing from the existing operation but are documented in the source-of-truth audit (the endpoint requires authorize_user!(scopes: [:read]) and Pundit authorization).

Opened automatically by the openapi-apply agent. Review the spec changes
against the linked strings-app PR; the agent does not vouch for correctness
beyond "the YAML parsed and the documented layout was followed."

@github-actions

Copy link
Copy Markdown
Contributor

API changelog (oasdiff)

Doc-only edits (descriptions, examples) do not appear here.

3 changes: 0 error, 0 warning, 3 info
info	[new-optional-request-parameter] at doc/compiled.json
	in API GET /accounts/{account_id}/spaces
		added the new optional `query` request parameter `q`

info	[response-non-success-status-added] at doc/compiled.json
	in API GET /accounts/{account_id}/spaces
		added the non-success response with the status `401`

info	[response-non-success-status-added] at doc/compiled.json
	in API GET /accounts/{account_id}/spaces
		added the non-success response with the status `403`

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants