Repository navigation
docs: mention word/character count stats in locale report description - #1295
Merged
Merged
Conversation
…scription
GET /projects/{project_id}/report/locales returns per-locale (and,
via the tag parameter, per-job) word/character count and translation
statistics, but the summary/description never mentioned these fields,
making the endpoint unsearchable for queries like "job word count".
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Contributor
API changelog (oasdiff)Doc-only edits (descriptions, examples) do not appear here. |
The compare-output CI check diffs the checked-in doc/compiled.json against a freshly bundled main.yaml. The previous commit updated the summary/description text in paths/reports/locales/index.yaml but did not regenerate the bundle, so the check failed. Regenerate it via `npx swagger-cli bundle -t json -w 300 main.yaml`. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
junior-ai-bot
Bot
changed the title
Sven Dunemann (forelabs)
approved these changes
Sep 24, 2026
Sven Dunemann (forelabs)
requested review from
Sven Dunemann (forelabs)
and removed request for
Stephen Lumenta (sbl)
September 24, 2026 07:17
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
Updated the
summaryanddescriptionforGET /projects/{project_id}/report/localesinpaths/reports/locales/index.yamlto explicitly mention that the endpoint returns word count, character count, and translation completion statistics per locale — and, via the existingtagquery parameter, per job.Why
An Atlas agent session tried 10 distinct search queries (e.g. "word count", "job word count statistics") against the Strings OpenAPI index and concluded the API doesn't expose word counts for jobs, then fell back to a manual workaround. In reality,
GET /projects/{project_id}/report/localesalready returnssource_word_count,word_count,word_count_unverified, andword_count_missingperschemas/locale_report.yaml, and can be scoped to a single job via its job tag (e.g.job-5816D203) using the existingtagparameter. The endpoint's spec text just never mentioned any of "word", "count", "statistics", or "translation", so term-based search scored it 0 against every plausible query.This change adds those terms to the summary/description so the endpoint is discoverable by both human API consumers and term-based search, without changing any request/response schema.
Test plan
python3 -c "import yaml; yaml.safe_load(open('paths/reports/locales/index.yaml'))"— valid YAMLnpx swagger-cli validate main.yaml—main.yaml is validSTRINGS-3520
Co-Authored-By: junior-dev
🤖 Generated with Claude Code