EES-5057 Add missing public API Swagger docs for required properties and error responses #4749
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
jack-hive
approved these changes
Apr 16, 2024
…operties This fixes the Swagger docs currently not being generated with required properties. This meant that the docs were previously incomplete as we specify if properties are required or not in the generated public API docs.
This fixes various issues that were causing incorrect Swagger docs to be generated for problem detail error responses. Tins includes: - Adding a `ErrorViewModelSchemaFilter` that fixes `code` and `message` properties to be required and non-nullable for `ErrorViewModel`. - Including doc blocks from `Common` view models for Swagger docs. - Using our own `ProblemDetailsViewModel` to control what Swagger docs are generated (rather than .NET's `ProblemDetails`). - Specifying various problem detail view models for 400s and 404s.
Previously, .NET would not output a response body for a 403 Forbidden as they leave it up to you do what you want with such a response (e.g. redirect the browser to a login page). However, this isn't helpful in the context of a REST API, so we've now fixed this to return a default `ProblemDetails` response.
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 the following to the public API Swagger docs:
ProblemDetailsViewModelorValidationProblemViewModelin these cases.Note that rather than try and extend Common's
ErrorViewModelfor the public API to make some of its properties required (e.g.codeandmessage), we've just created anErrorViewModelSchemaFilterthat modifies the OpenAPI schema instead.Several attempts were made, but trying to extend Common's
ErrorViewModelprovided a bit too difficult and intrusive in terms of code changes.Related changes
Other changes
ContentApiClient.