Add API documentation #381
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
mjgiarlo
reviewed
Sep 10, 2019
README.md
Outdated
| This Ruby application provides a REST API for DOR Services. [View the REST API documentation](https://consul.stanford.edu/display/chimera/REST+mappings+for+dor-services+gem). | ||
|
|
||
| This Ruby application provides a REST API for DOR Services. | ||
| There is a OAS 3.0 spec that documents the API in [openapi.json]. If you clone this repo, you |
There was a problem hiding this comment.
Can you unpack "OAS" and/or link somewhere relevant? (Yeah, I know, OpenAPI.)
|
|
||
|
|
||
|
|
||
| ## Was the API documentation (openapi.json) updated? |
| </style> | ||
| </head> | ||
| <body> | ||
| <redoc spec-url='https://raw.githubusercontent.com/sul-dlss/dor-services-app/master/openapi.json'></redoc> |
This has all of the endpoints, but doesn't yet have all the parameters and responses.
mjgiarlo
approved these changes
Sep 10, 2019
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 has all of the endpoints, but doesn't yet have all the parameters and responses.