docs(API): Enrich cldr_version field description on project create/update - #1269
Merged
Merged
Conversation
…e/update
The project-level cldr_version field only had a terse description with no
explanation of the legacy/CLDR48 distinction, unlike POST /icu/skeleton's
richer (but search-unreachable) description of the same enum. Mirror that
text on POST /projects and PATCH /projects/{id} so the distinction is
discoverable from the field users actually interact with.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Contributor
API changelog (oasdiff)Doc-only edits (descriptions, examples) do not appear here. |
Sven Dunemann (forelabs)
changed the title
Sven Dunemann (forelabs)
self-requested a review
September 14, 2026 13:18
Sven Dunemann (forelabs)
approved these changes
Sep 14, 2026
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
Enriched the
cldr_versionfield description onPOST /projects(paths/projects/create.yaml) andPATCH /projects/{id}(paths/projects/update.yaml) to explain thelegacyvs. CLDR-version-string (e.g.cldr48) distinction, mirroring the existing (but search-unreachable) explanation already present onPOST /icu/skeleton'scldr_versionfield. The project-level field also now cross-references the ICU skeleton endpoint, since both share the same enum values.Also regenerated
doc/compiled.jsonviamake lint(bundling step), which reflects the same description changes.Why
An Atlas user query about what changes when switching a Strings project's Unicode CLDR version from
LEGACYtoCLDR48was undiscoverable via the Strings OpenAPI search index. The correct explanation existed only onPOST /icu/skeleton'scldr_versionfield description (a nested request-body field, which Atlas's scorer doesn't weight), while the project-levelcldr_versionfield — the one users actually interact with — had only a terse one-line description with no legacy/CLDR48 explanation at all.This surfaces the explanation directly on the project-level field so it's reachable regardless of search-scorer weighting, and is a documentation-only change with no behavioral impact.
Related ticket: STRINGS-3250
How to test
make lintpasses (npx swagger-cli validate main.yaml+ bundle +lint.sh) — verified locally, no validation errors.Co-Authored-By: junior-dev
🤖 Generated with Claude Code