TCM-6557 Update Strings API and add common schemas to api_common.yaml#328
Merged
Conversation
- Rename path parameter {projectId} to {projectUid} across all four
strings-api paths (both path keys in openapi.yaml and parameter
names in the spec file)
- Add strings.maxItems: 100 and fix strings.items.maxLength type
number -> integer in the create endpoint
- Add uri and authorization fields to the create strings request body
- Add showPlaceholderValues parameter to source-strings and
translations endpoints (GET params and POST body)
- Raise translations limit maximum from 500 to 10,000
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
- Extract LocaleId as a reusable schema in api_common.yaml with type, pattern, and description - Update localeId parameter to reference LocaleId schema and add named examples with summaries - Add summary to projectId example to fix trailing dash in rendered output - Update targetLocaleId fields in strings-api-v2.yaml to reference LocaleId schema Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
….yaml Move CreateStringResponse, CreateStringStatusResponse, CreatedString, StringInfo, StringResponse, Translation, and TranslationResponse schemas to strings-api-v2.yaml since they are only used by the Strings API. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
…lability Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01EVm9PgBYifHQd5yjAKq32p
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01EVm9PgBYifHQd5yjAKq32p
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
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
2 participants
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.
Summary
api_common.yaml(usable by all APIs):DateTime,FileUri,LocaleId,Hashcode,TranslationJobUid,WorkflowUid,WorkflowStepUidoffset,limitprojectId(added regex pattern + examples),localeId(linked toLocaleIdschema + examples)openapi.yamlinto the dedicatedspec/strings/strings-api-v2.yamlstrings-api-v2.yamlpayloads to align with internal spec: improved descriptions, fixed swappedfileUri/keydescriptions inStringInfoandTranslationschemas, clarifiedkeynullabilityTest plan
npm testpasses (pre-existing failures on master are unrelated to this branch)npm run buildproduces a valid bundlehttps://api-reference.smartling.com/preview/tcm-6557-update-strings-api-part-2renders Strings API endpoints correctlyLocaleId,Hashcode, etc.) appear in the Components section🤖 Generated with Claude Code
https://claude.ai/code/session_01EVm9PgBYifHQd5yjAKq32p