Add Swagger API documentation for linked data API #175
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
elrayle
force-pushed
the
swagger_api_doc
branch
2 times, most recently
from
467bb01
to
bc9e4c2
Compare
elrayle
changed the title
elrayle
changed the title
elrayle
force-pushed
the
swagger_api_doc
branch
from
bc9e4c2
to
38ccf4e
Compare
elrayle
changed the title
…g qa Generator copies Swagger UI files and linked data API config to public/qa/apidoc. View API docs at https://YOUR_APP_HOST/qa/apidoc/
elrayle
force-pushed
the
swagger_api_doc
branch
from
38ccf4e
to
8ad172b
Compare
afred
approved these changes
Oct 1, 2018
There was a problem hiding this comment.
👍
Coveralls is warning about a 2.8% decrease in coverage. This is due to an added Generator that does not have tests, and Hyrax (for better or worse) does not have tests for its generators.
While QA has some coverage issues that need to be addressed, after discussion with @elrayle on Slack, we decided to not let those issues block this PR. Additional tickets can be made for improving coverage.
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.
Adds an installer to add swagger API docs for the linked data module. The doc is installed in
public/apidocdirectory of the app including QA.To view what the apidoc installer will do: (from the app including QA >= 2.1.2)
To run the apidoc installer: (from the app including QA >= 2.1.2)
This will install the docs in your app at...
public/qa/apidocTo view the API documentation:
NOTE: The trailing / is required.