Skip to content

docs(v3-languages): document latest API changes#332

Merged
daniel-jones-dev merged 4 commits intomainfrom
v3-langs/ga-v3-languages-updates
May 5, 2026
Merged

docs(v3-languages): document latest API changes#332
daniel-jones-dev merged 4 commits intomainfrom
v3-langs/ga-v3-languages-updates

Conversation

@daniel-jones-dev
Copy link
Copy Markdown
Member

@daniel-jones-dev daniel-jones-dev commented May 3, 2026

Summary

Applies all 5 planned changes to the v3/languages endpoints shipping approx May 5 2026.

  • Rename productresource: query param on GET /v3/languages, endpoint /v3/languages/products/v3/languages/resources
  • features array → object: language features is now a dict keyed by feature name, value {status: string}
  • Language status field: new required field on every language object (stable, beta, early_access)
  • include query param: GET /v3/languages now accepts ?include=beta and ?include=external (composable)
  • Rename custom_instructions feature → style_rules: affects feature keys returned per language and GET /v3/languages/resources; the custom_instructions translate endpoint parameter is unchanged

Updates: openapi.yaml + regenerated openapi.json, overview, use-cases pseudocode, migration guide, changelog (planned changes moved to dated entries, Planned section removed), nav group renamed.

Test plan

  • Verify GET /v3/languages?resource=translate_text renders correctly in Mintlify preview
  • Verify GET /v3/languages/resources renders correctly
  • Check feature table in overview — style_rules row present, custom_instructions gone
  • Check include param section renders
  • Verify changelog shows May 5 entries, no Planned section
  • Check migration guide examples use ?resource= and dict features format
  • Run mint broken-links --check-anchors

🤖 Generated with Claude Code

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 3, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
deepl-c950b784 🟢 Ready View Preview May 3, 2026, 9:56 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Applies all 5 planned changes shipping at GA:

- Rename `product` → `resource` (query param + /products → /resources endpoint)
- Replace `features` array with object (keys = feature names, values = {status})
- Add `status` field to language objects (stable/beta/early_access)
- Add `include` query param (beta, external)
- Rename `custom_instructions` feature → `style_rules`

Updates changelog, overview, use-cases, migration guide, nav group name.
openapi.json is regenerated by CI.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Bold table headers, trim <Info> callout to 2 sentences, fix json->text
on commented code block, replace -- with period, update descriptions to
action-oriented form, fix future tense in changelog intro.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@daniel-jones-dev daniel-jones-dev changed the title docs(v3-languages): (BETA) apply API changes docs(v3-languages): document latest API changes May 5, 2026
Rename retrieve-{supported-,}languages-by-product.mdx to -by-resource,
update all internal links, and add redirects in docs.json.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@daniel-jones-dev daniel-jones-dev force-pushed the v3-langs/ga-v3-languages-updates branch from 1f31c51 to 41f9a1f Compare May 5, 2026 12:50
@daniel-jones-dev daniel-jones-dev merged commit d666fc4 into main May 5, 2026
2 checks passed
@daniel-jones-dev daniel-jones-dev deleted the v3-langs/ga-v3-languages-updates branch May 5, 2026 12:53
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.

1 participant