feat: support operation descriptions#42
Merged
Nicholas Wiersma (nrwiersma) merged 1 commit intoGameFabric:mainfrom Apr 30, 2026
Merged
feat: support operation descriptions#42Nicholas Wiersma (nrwiersma) merged 1 commit intoGameFabric:mainfrom
Nicholas Wiersma (nrwiersma) merged 1 commit intoGameFabric:mainfrom
Conversation
Copilot started reviewing on behalf of
Carl Kittelberger (icedream)
April 30, 2026 11:17
View session
Nicholas Wiersma (nrwiersma)
approved these changes
Apr 30, 2026
There was a problem hiding this comment.
Pull request overview
Adds first-class support for OpenAPI operation Description (long-form text) alongside the existing Summary support via Doc().
Changes:
- Extend
Operation/ merge logic to carry a newdescriptionfield and expose it viaOpBuilder.Describe(). - Emit OpenAPI
descriptionwhen generatingkin.Operationobjects. - Add an example and a unit test covering description propagation.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
op.go |
Adds description to Operation, merges it, and exposes OpBuilder.Describe() to set it. |
gen.go |
Maps Operation.description into the generated OpenAPI Description field. |
gen_test.go |
Adds a test intended to validate description behavior (currently contains compile/runtime issues). |
example_test.go |
Adds an example demonstrating Describe() usage. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Carl Kittelberger (icedream)
force-pushed
the
feat/description
branch
2 times, most recently
from
18a5d98 to
3995ea2
Compare
Carl Kittelberger (icedream)
force-pushed
the
feat/description
branch
from
3995ea2 to
35aafef
Compare
Contributor
Author
|
Test & example fixed up, should be fine now. |
Copilot started reviewing on behalf of
Carl Kittelberger (icedream)
April 30, 2026 11:41
View session
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Nicholas Wiersma (nrwiersma)
approved these changes
Apr 30, 2026
Christian R (antiphp)
approved these changes
Apr 30, 2026
Contributor
Christian R (antiphp)
left a comment
Christian R (antiphp)
left a comment
There was a problem hiding this comment.
Nice work!
Nicholas Wiersma (nrwiersma)
merged commit 24e88b1
into
GameFabric:main
16 of 18 checks passed
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.
Adds
Describe()method toOpBuilderfor setting the operation's long description, complementing the existingDoc()method for settingSummary.Closes #31