docs(STRINGS-3041): Document supported placeholder_styles values - #1251
Open
Łukasz Ciesielski (lookasc) wants to merge 2 commits into
Open
docs(STRINGS-3041): Document supported placeholder_styles values#1251Łukasz Ciesielski (lookasc) wants to merge 2 commits into
Łukasz Ciesielski (lookasc) wants to merge 2 commits into
Conversation
Add an enum of supported placeholder style keys for the placeholder_styles field on projects (create/update/response schemas), so API clients can discover valid values instead of guessing.
Contributor
API changelog (oasdiff)Doc-only edits (descriptions, examples) do not appear here. |
A plain enum flags the property as newly type-constrained from the API consumer's perspective, which the breaking-change check treats as a breaking change on the request side, and any future style addition would flag as breaking on the response side. Document the known values via x-extensible-enum instead, which supports listing/growing known values without breaking existing or future clients.
Łukasz Ciesielski (lookasc)
marked this pull request as ready for review
September 3, 2026 07:40
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.
Purpose
placeholder_stylesfield on projects (used when creating or updating a project, and returned in project responses) previously had no documented set of valid values, so API clients had no way to know which style keys were accepted.https://phrase.atlassian.net/browse/STRINGS-3041