This repository has been archived by the owner on Jun 13, 2019. It is now read-only.
Chore/152398223/api documentation #8
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
oahray
force-pushed
the
chore/152398223/api-documentation
branch
from
740cd72
to
91643b1
Compare
- change API package to restivus - add restivus-swagger meteor package - Add documentation URL to README [Finishes #152398223]
oahray
force-pushed
the
chore/152398223/api-documentation
branch
from
91643b1
to
bc95331
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
What does this PR do?
Protect the RESTful API endpoints such that only authenticated users can access them, and admin routes cannot be accessed by users who do not have admin roles. Adds a link to generated docs in README
Description of Task to be completed?
How should this be manually tested?
Click the API Docs link in the readme, you should be taken to the auto-generated API docs.
Any background context you want to provide?
Reading documentation is one awesome way to learn to use a new technology.
What are the relevant pivotal tracker stories?
Finishes #152398223
Screenshots (if appropriate)