doc(QTDI-3156): Improve docs for CreateConnection service#1251
Merged
dmytro-sylaiev merged 5 commits intoJul 9, 2026
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the documentation around the @CreateConnection service behavior (notably for Studio integration) by clarifying how the value/@Option naming impacts UI features like @ActiveIf.
Changes:
- Added a note to the “creating dataset/datastore” documentation describing the naming constraint between
@Optionand the runtime class constructor parameter. - Extended the
@CreateConnectionannotation@Documentationtext to include the same constraint for consumers of the API.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| documentation/src/main/antora/modules/ROOT/pages/creating-dataset-datastore.adoc | Adds an explanatory note about @CreateConnection / @Option naming requirements. |
| component-api/src/main/java/org/talend/sdk/component/api/service/connection/CreateConnection.java | Adds additional descriptive text to the annotation documentation for Studio UI behavior (@ActiveIf). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
thboileau
reviewed
Jul 9, 2026
| @Retention(RUNTIME) | ||
| @Documentation("Mark an action works for creating runtime connection, returning a runtime connection object like jdbc connection if database family. " | ||
| + "Its parameter MUST be a datastore. Datastore is configuration type annotated with @DataStore. " | ||
| + "The `value` parameter must match the runtime class constructor parameter name of the component configuration class to correctly apply `@ActiveIf` in the Studio UI. " |
Contributor
There was a problem hiding this comment.
I'm afraid that in this this context there could be a confusion between:
valueparameter of the@CreateConnectionannotationvalueparameter of the@Optionannotation of the method annotated@CreateConnection
Is something like this clearer?
Mark a method as returning a runtime connection object like jdbc connection if database family.
The method's parameter MUST be a datastore annotated `@Option`.
The `value` parameter of `@Option` must match the runtime class constructor parameter name of the component configuration class to correctly apply `@ActiveIf` in the Studio UI.
thboileau
previously approved these changes
Jul 9, 2026
* Fix checkstyle issue
thboileau
approved these changes
Jul 9, 2026
|
0 New Issues
0 Fixed Issues
0 Accepted Issues
No data about coverage (0.00% Estimated after merge)
dmytro-sylaiev
deleted the
dsylaiev/QTDI-3156_improve_doc_createconnection
branch
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.
Requirements
Why this PR is needed?
What does this PR adds (design/code thoughts)?
AI generated code
https://internal.qlik.dev/general/ways-of-working/code-reviews/#guidelines-for-ai-generated-code