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.
Updates existing
Swagger-config.yaml
documentation to OpenAPI 3.0 specification.If there is a desire to keep both 2.0 and 3.0 specifications in-place in the repo please let me know.
Tested locally with SwaggerUI / viewer and working.
To test the API YAML:
navigate to: https://cfpb.github.io/ccdb5-api/documentation/index.html
Update the URL at the top of the page to use:
https://raw.githubusercontent.com/cfpb/ccdb5-api/ff1ef1330d158b262061a9dfbddddbf42e765436/swagger-config.yaml
This will not perform some of the changes in layout that are in the index.html, but should provide a working API call with no Format defaulted.