Open
Conversation
This uses the schema descriptions added in a recent `json-fleece` update to the SwaggerUI so it renders along with the schema. A golden test has been added to show that the descriptions for both an object and its fields are included in the generated OpenAPI document. This was also tested with an external project using `orb` to see that the SwaggerUI page includes the description.
qxjit
requested changes
Mar 3, 2026
| FleeceOpenApi mkErrOrSchemaInfo = FC.schemaInterpreter schema | ||
|
|
||
| schemaInfo <- mkErrOrSchemaInfo [] | ||
| schemaInfo <- applySchemaDescription schema <$> mkErrOrSchemaInfo [] |
Member
There was a problem hiding this comment.
It feels bad that we have to add applySchemaDescription in so many places. Can this be avoided somehow?
Contributor
Author
There was a problem hiding this comment.
I don't see any way to avoid it, but I'm open to discussing it.
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
2 participants
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.
This uses the schema descriptions added in a recent
json-fleeceupdate to the SwaggerUI so it renders along with the schema.A golden test has been added to show that the descriptions for both an object and its fields are included in the generated OpenAPI document. This was also tested with an external project using
orbto see that the SwaggerUI page includes the description.