feat(API): document tm_ids and term_base_ids params on projects API #STRINGS-3249 - #1234
Closed
junior-ai-bot[bot] wants to merge 1 commit into
Closed
feat(API): document tm_ids and term_base_ids params on projects API #STRINGS-3249#1234junior-ai-bot[bot] wants to merge 1 commit into
junior-ai-bot[bot] wants to merge 1 commit into
Conversation
Contributor
API changelog (oasdiff)Doc-only edits (descriptions, examples) do not appear here. |
junior-ai-bot
Bot
changed the title
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
Documents two new optional array params on the Projects
createandupdateAPI endpoints:tm_ids— list of translation memory IDs to assign to the project.term_base_ids— list of term base IDs to assign to the project.These correspond to the "Translation memories" and "Term bases" selectors shown in the strings-app Project Settings → AI translation agent tab, which are used (in addition to the TM/TBs automatically associated with the project) as reference material for AI translation agent requests.
Why
STRINGS-3249 asks for the already-supported
tm_ids/term_base_idsproject params to be documented in the OpenAPI spec forprojects#createandprojects#update.How to test
npx swagger-cli validate main.yamlpasses.bash ./lint.sh(openapi-generator-cli validate against the bundled spec) reports no validation errors.Co-Authored-By: junior-dev