Add OpenAPI metadata to Catalog API #568
Open
Conversation
This file contains 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
mikekistler
commented
Oct 14, 2024
| return TypedResults.BadRequest("Id is not valid."); | ||
| var problemDetails = problemDetailsFactory.CreateProblemDetails(httpContext, | ||
| detail: $"Id is not valid", statusCode: StatusCodes.Status400BadRequest); | ||
| httpContext.Response.ContentType = "application/problem+json"; |
There was a problem hiding this comment.
Sadly, the CreateProblemDetails method fails to set the content-type to "application/problem+json". Even worse is that despite adding the explicit "ProducesResponseType" on this method with the correct content-type, this doesn't make it into the OpenAPI document -- probably because the BadRequest overrides it (incorrectly IMHO).
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.
This PR adds OpenAPI metadata to the Catalog API.
It includes the generated OpenAPI doc, starting from the first commit, so that you can easily see how the doc was changed/improved by the app code changes.
I also included a Spectral ruleset file that checks basic structural correctness and adds rules to verify that all operations have both success and error responses defined and all parameters have descriptions.
The motivation for this work was so we could use this in demos of the OpenAPI document generation feature in upcoming conferences.