Fix issues with openapi spec#9429
Open
tylerjmchugh wants to merge 1 commit into
Open
Conversation
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.
Some API endpoints currently use
HttpStatusas their response body type even though they do not return a response body. This causes OpenAPI to interpretHttpStatusas response content and generate an enum schema containing the possible status values.The harvester reindex endpoint is also currently documented with both
200and204success responses, even though it returns204.In addition, the DOI server and mapserver delete endpoints currently have conflicting generated operation IDs. This causes the generated
_1suffix to switch between the endpoints depending on their order in the OpenAPI specification, resulting in unstable generated client method names.This PR aims to fix these issues by:
ResponseEntity<HttpStatus>andHttpEntity<HttpStatus>withResponseEntity<Void>for endpoints that do not return a response body. The response status continues to be set through theResponseEntity, whileVoidcorrectly indicates to OpenAPI that the response does not contain content.@ResponseStatus(HttpStatus.OK)from the harvester reindex endpoint so that204is the only documented success response.deleteDoiServeranddeleteMapserveroperation IDs to prevent conflicts and keep the generated method names stable.Checklist
mainbranch, backports managed with labelREADME.mdfilespom.xmldependency management. Update build documentation with intended library use and library tutorials or documentation