Bug fix for Entity description not surfaced in GraphQL.#3732
Bug fix for Entity description not surfaced in GraphQL.#3732anushakolan wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
✅ Ready to approve
The change is small, targeted, and includes a regression unit test that directly validates the reported behavior.
Note: this review does not count toward required approvals for merging.
Pull request overview
This PR fixes GraphQL schema documentation for stored-procedure execute* fields by using the configured entity description (when provided) instead of always emitting a hardcoded description string, aligning schema docs with runtime config and the GraphQL description spec.
Changes:
- Updated stored-procedure GraphQL field generation to prefer
entity.Description, with the previous hardcoded text as a fallback. - Added a unit test to prevent regressions by asserting the
execute*field description matches the configured entity description.
File summaries
| File | Description |
|---|---|
| src/Service.GraphQLBuilder/GraphQLStoredProcedureBuilder.cs | Uses entity.Description for the stored-procedure execute* field description, falling back to the previous hardcoded text when absent. |
| src/Service.Tests/GraphQLBuilder/Sql/StoredProcedureBuilderTests.cs | Adds a regression test validating the execute* field description uses the entity-level description from config. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 0
- Review effort level: Low
Note
Your feedback helps us improve the quality of this feature.
Please use 👍 or 👎 to tell us whether this assessment is correct.
RubenCerna2079
left a comment
There was a problem hiding this comment.
LGTM! Just a question to address
| entityName: "SpDescription", | ||
| entityDescription: entityDescription); | ||
|
|
||
| Assert.AreEqual(entityDescription, field.Description?.Value); |
There was a problem hiding this comment.
Is there already a test that checks if the entityDescription is null it will use the hard coded value?
Why make this change?
What is this change?
entity.Descriptionwhen present, with the existing hardcoded text retained as a fallback.How was this tested?
Sample Request(s)
dab start --config "dab-config.json"