STRINGS-3195 - Document account-wide (cross-project) translation search endpoint - #1266
Closed
junior-ai-bot[bot] wants to merge 1 commit into
Closed
junior-ai-bot[bot] wants to merge 1 commit into
junior-ai-bot[bot] wants to merge 1 commit into
Conversation
Move POST /accounts/{account_id}/search into the Translations section
next to Search translations, correct its request params to match what
the controller actually forwards (query string params, not a JSON
body), and fix the response to be an array of search results.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Contributor
API changelog (oasdiff)Doc-only edits (descriptions, examples) do not appear here. |
Member
|
already documented |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Documents
POST /accounts/{account_id}/search(Api::V2::SearchController#index) — the account-wide, cross-project translation/key search endpoint — properly in the spec:POST /projects/{project_id}/translations/search), both inpaths.yamlordering and via theTranslationstag. Removed the now-unused "Search" tag frommain.yaml.Accounts::AccountLevelSearchService:query,locale_code,project_ids,page,per_page— documented as query-string parameters (the controller does not read a JSON body for this action). Removed the previousrequestBodydocumentation, which didn't reflect this.200response to be a JSON array of search result objects (SearchResponseSerializeroutput), matchingkeys/searchandtranslations/search's array response shape, instead of a single object.use_ordinal_rulesto thekeyobject examples inschemas/account_search_result.yamlto match thekey_previewschema, and fixed a stray typo (state":→state:) in one of the nested translation examples.403description and code samples to reflect the corrected query-string request shape.Per the ticket, sorting, branching, and
custom_metadata(accepted by the underlying service but not exposed by the controller) are intentionally not documented.Why
An Atlas agent session found no cross-project search was documented, so a user fanned out per-project search calls across 18 projects to find translations account-wide — the capability already existed but wasn't discoverable in the docs. See STRINGS-3195.
Test plan
npm run lint(swagger-cli validate+ bundle +lint.sh) passes with no validation errors.doc/compiled.jsondiff to confirm the operation renders underTranslationswith the corrected parameters/response shape.Co-Authored-By: junior-dev
🤖 Generated with Claude Code