docs(API): Add workflow/autotranslate/MT vocab in description in /projects/{id} - #1265
Merged
Merged
Conversation
…ects/{id}
Expand the description on PATCH /projects/{id} to mention review
workflow, pre-translation/autotranslate rules, and machine-translation
configuration so keyword search tools (e.g. Atlas) can surface this
endpoint for related queries.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Contributor
API changelog (oasdiff)Doc-only edits (descriptions, examples) do not appear here. |
Sven Dunemann (forelabs)
changed the title
Sven Dunemann (forelabs)
approved these changes
Sep 14, 2026
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.
What changed
Expanded the
descriptiononPATCH /projects/{id}(paths/projects/update.yaml) to explicitly mention the endpoint's project-configuration vocabulary: review workflow, pre-translation/autotranslate rules, and machine-translation configuration. Also regenerateddoc/compiled.jsonto pick up the updated description.Why
Keyword-based search/indexing tools (e.g. Atlas) score endpoints against
summary/description/tags, not the fullrequestBodyfield text. The previous description ("Update an existing project.") shared no vocabulary with queries like "enable pre-translation with machine translation only", so the endpoint scored zero and was excluded from search results even though its request body includesworkflow,machine_translation_enabled, and theautotranslate_*fields.This is a documentation-only change with no functional/behavioral impact.
How to test
make lintpasses (swagger-cli validate, bundle, andopenapi-generator-cli validateall succeed).doc/compiled.jsonshows only the description text change for thepatchoperation on/projects/{project_id}.