Add OpenAPI metadata to Catalog API endpoints #631
Merged
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
jamesmontemagno
approved these changes
Nov 27, 2024
captainsafia
approved these changes
Dec 10, 2024
| .WithDescription("Get a list of catalog items for the specified brand") | ||
| .WithTags("Brands"); | ||
| api.MapGet("/catalogtypes", | ||
| [ProducesResponseType<ProblemDetails>(StatusCodes.Status400BadRequest, "application/problem+json")] |
There was a problem hiding this comment.
Remind me again why we're not using .ProducesProblem(StatusCodes.Status400BadRequest, "application/problem+json")?
| public record PaginationRequest( | ||
| [property: Description("Number of items to return in a single page of results")] | ||
| [property: DefaultValue(10)] | ||
| int PageSize = 10, |
There was a problem hiding this comment.
Hmmm....we should probably support default parameter values instead of relying on the attribute as well. 🤔
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 summaries, descriptions, and tags to the Catalog API endpoints and descriptions on all parameters and properties.