Skip to content

docs(API): improve POST /icu/skeleton documentation#1174

Open
Stephen Lumenta (sbl) wants to merge 1 commit into
mainfrom
devex-117-icu-build-icu-skeletons
Open

docs(API): improve POST /icu/skeleton documentation#1174
Stephen Lumenta (sbl) wants to merge 1 commit into
mainfrom
devex-117-icu-build-icu-skeletons

Conversation

@sbl

@sbl Stephen Lumenta (sbl) commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Improves the documentation for POST /icu/skeleton (ICU skeleton builder).

Changes

  • Adds conceptual description: what the endpoint does, why/when to use it, the ICU/CLDR model, and pitfalls
  • Expands ICU (International Components for Unicode) and CLDR (Common Locale Data Repository) abbreviations at first use
  • Documents 401 and 422 responses with causes and remediation text
  • Improves 403 description with remediation guidance
  • Adds enum constraint for cldr_version parameter (legacy | cldr_41)
  • Improves all parameter descriptions for clarity
  • Adds response example to the 200 response

All changes are spec-layer only (paths/icu/skeleton.yaml + compiled bundle). No Ruby source edits.

Part of DEVEX-117.

Drafted with AI assistance and grounded in the strings-app source. Please review for technical accuracy before merging; nothing is merged automatically.

🤖 Generated with Claude Code

Adds conceptual description (why/model/pitfalls), expands ICU/CLDR
abbreviations at first use, documents 401/403/422 responses with causes
and remediation, adds enum for cldr_version parameter, adds response
example, and improves all parameter descriptions.

Part of DEVEX-117.

🤖 Generated with Claude Code (claude-sonnet-4-6)
@sbl Stephen Lumenta (sbl) added the developer-hub-api-quality API doc quality fix from the API Grader label Jun 10, 2026
Comment thread paths/icu/skeleton.yaml
- ICU
parameters:
- "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
requestBody:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm kinde torn when it comes to moving the existing sections around. While it's cleaner to have requestBody here rather than on the bottom, it makes (human) reviewing harder and it results with the same (human centric) reference document at the end.

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

Labels

developer-hub-api-quality API doc quality fix from the API Grader

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants