feat!: add projectDescription to AI prompt completions and remove assistActionAiPromptId#384
Merged
andrii-bodnar merged 1 commit intoJun 9, 2026
Conversation
…istActionAiPromptId Add projectDescription to the AI prompt completion resource, and remove the assistActionAiPromptId field from AiSetting now that the assist AI prompt action is gone. BREAKING CHANGE: AiSetting.assistActionAiPromptId is removed. Closes crowdin#376
There was a problem hiding this comment.
Pull request overview
Updates the Java SDK’s AI prompt completion request model to include the new projectDescription context field, and removes the deprecated assistActionAiPromptId from AiSetting to match the upstream API breaking change described in #376.
Changes:
- Added
projectDescriptiontoAiPromptCompletionRequest.AiPromptResourceand updated the prompt-completion request fixture + test to serialize it. - Removed
assistActionAiPromptIdfromAiSettingand updated AI settings response/request fixtures and tests accordingly.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/main/java/com/crowdin/client/ai/model/AiPromptCompletionRequest.java | Adds projectDescription to the prompt completion resources payload model. |
| src/main/java/com/crowdin/client/ai/model/AiSetting.java | Removes the deprecated assistActionAiPromptId field from the AI settings model. |
| src/test/java/com/crowdin/client/ai/AIApiTest.java | Updates tests to set projectDescription and stop asserting/patching the removed assistActionAiPromptId. |
| src/test/resources/api/ai/promptCompletionRequest.json | Updates request fixture to include projectDescription under resources. |
| src/test/resources/api/ai/getAiSettingResponse.json | Updates response fixture to remove assistActionAiPromptId. |
| src/test/resources/api/ai/editAiSettingRequest.json | Updates patch request fixture to target /editorSuggestionAiPromptId instead of the removed field. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
andrii-bodnar
approved these changes
Jun 9, 2026
andrii-bodnar
left a comment
andrii-bodnar
left a comment
Member
There was a problem hiding this comment.
@GabrielBBaldez thank you for the contribution!
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
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.
Addresses #376 for the Java client, per the discussion on the issue.
projectDescriptionto the AI prompt completion resource (AiPromptCompletionRequest.AiPromptResource).assistActionAiPromptIdfromAiSetting, now that theassistAI prompt action is gone (breaking).The other parts of #376 (the
assistaction enum, override-prompt-values schemas,projectContext/organizationContext) don't require typed changes in this SDK, because the promptaction,config, andoverridePromptValuesare modeled as free-formString/Map<String, Object>(see my earlier note on the issue). The project-levelassistActionAiPromptIdon the Projects resource is left unchanged, as it's outside this issue's scope.Tests
generateAiPromptCompletionTestnow setsprojectDescription;getAiSettingTest/editAiSettingTestupdated for the removed field../gradlew testpasses.Closes #376