Use config parameter descriptions in GraphQL stored procedure args#3733
Open
anushakolan wants to merge 3 commits into
Open
Use config parameter descriptions in GraphQL stored procedure args#3733anushakolan wants to merge 3 commits into
anushakolan wants to merge 3 commits into
Conversation
anushakolan
requested review from
Alekhya-Polavarapu,
Aniruddh25,
JerryNixon,
RubenCerna2079,
aaronburtle,
rusamant,
sourabh1007,
souvikghosh04,
stuartpa and
vadeveka
as code owners
July 21, 2026 20:57
Contributor
There was a problem hiding this comment.
Pull request overview
Updates GraphQL stored-procedure argument description generation so schema docs prefer runtime config parameter descriptions, improving introspection/docs quality for API consumers (per #3500).
Changes:
- Updated
GraphQLStoredProcedureBuilderto resolve argument descriptions with precedence: config description → DB/definition description → default fallback text. - Added unit tests validating config-description precedence and DB-description fallback for stored-procedure args.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/Service.GraphQLBuilder/GraphQLStoredProcedureBuilder.cs | Applies new description precedence logic when building stored-procedure GraphQL argument definitions. |
| src/Service.Tests/GraphQLBuilder/Sql/StoredProcedureBuilderTests.cs | Adds regression tests for config-vs-DB description precedence on stored-procedure arguments. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.
Why make this change?
What is this change?
source.parameters[].descriptionfrom runtime config (when present)parameters for <stored-procedure> stored-procedure)How was this tested?
Focused unit test run:
Sample Request(s)