Skip to content

docs(STRINGS-3241): Document fallback_for_unverified_translations project setting - #1245

Open
Łukasz Ciesielski (lookasc) wants to merge 2 commits into
mainfrom
docs/STRINGS-3241-fallback-for-unverified-translations-project-setting
Open

docs(STRINGS-3241): Document fallback_for_unverified_translations project setting#1245
Łukasz Ciesielski (lookasc) wants to merge 2 commits into
mainfrom
docs/STRINGS-3241-fallback-for-unverified-translations-project-setting

Conversation

@lookasc

Copy link
Copy Markdown
Contributor
  • Expose project setting fallback_for_unverified_translations in API docs
  • The fallback_for_unverified_translations project setting was already live and returned by the API, but customers had no way to discover or use it since it wasn't documented.
  • Added it to the Create/Update Project request parameters and the Project response schema, with a description matching the behavior already documented for the equivalent locale-download query parameter.

…ject setting

Adds the already-implemented project-level fallback_for_unverified_translations
setting to the Create/Update Project request bodies and the shared project
details response schema (used by Show/Create/Update). The setting was fully
wired up in strings-app but missing from the public API reference.
@github-actions

github-actions Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

API changelog (oasdiff)

Doc-only edits (descriptions, examples) do not appear here.

9 changes: 0 error, 0 warning, 9 info
info	[new-optional-request-property] at doc/compiled.json
	in API POST /projects
		added the new optional request property `fallback_for_unverified_translations`

info	[new-optional-request-property] at doc/compiled.json
	in API POST /projects
		added the new optional request property `term_base_ids`

info	[new-optional-request-property] at doc/compiled.json
	in API POST /projects
		added the new optional request property `tm_ids`

info	[response-optional-property-added] at doc/compiled.json
	in API POST /projects
		added the optional property `allOf[subschema #2: project_details]/fallback_for_unverified_translations` to the response with the `201` status

info	[response-optional-property-added] at doc/compiled.json
	in API GET /projects/{id}
		added the optional property `allOf[subschema #2: project_details]/fallback_for_unverified_translations` to the response with the `200` status

info	[new-optional-request-property] at doc/compiled.json
	in API PATCH /projects/{id}
		added the new optional request property `fallback_for_unverified_translations`

info	[new-optional-request-property] at doc/compiled.json
	in API PATCH /projects/{id}
		added the new optional request property `term_base_ids`

info	[new-optional-request-property] at doc/compiled.json
	in API PATCH /projects/{id}
		added the new optional request property `tm_ids`

info	[response-optional-property-added] at doc/compiled.json
	in API PATCH /projects/{id}
		added the optional property `allOf[subschema #2: project_details]/fallback_for_unverified_translations` to the response with the `200` status

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Documents the already-live fallback_for_unverified_translations project setting in the OpenAPI spec so API consumers can discover it in the Project schema and use it via Create/Update Project.

Changes:

  • Added fallback_for_unverified_translations to the project_details response schema (including the example payload).
  • Exposed fallback_for_unverified_translations as an optional request parameter on Create Project and Update Project.
  • Updated the compiled documentation artifact to reflect the spec changes.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
schemas/project_details.yaml Adds the new project setting to the Project details schema + example.
paths/projects/update.yaml Documents the new optional update parameter for projects.
paths/projects/create.yaml Documents the new optional create parameter for projects.
doc/compiled.json Regenerates compiled docs to include the new field in schema/requests.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread paths/projects/create.yaml
Comment thread paths/projects/update.yaml
Use the description text specified verbatim in STRINGS-3241 instead of
a reworded version.
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.

2 participants