Skip to content

Commit

Permalink
remove /v0 from API URLs & add more examples
Browse files Browse the repository at this point in the history
  • Loading branch information
titaniumbones committed Oct 26, 2017
1 parent 8f554ed commit 8636a91
Showing 1 changed file with 17 additions and 6 deletions.
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,23 @@ We use GitHub issues for [tracking bugs and feature requests](https://github.com
- install [docker](https://www.docker.com/) and [docker-compose](https://docs.docker.com/compose/)
- if you are new to docker, you may want to test your install with the [default test case](https://docs.docker.com/compose/gettingstarted/)
- in the project directory, run ``docker-compose build && docker-compose up`
- the API should now be running at `http://localhost:3200/v0`, and the following endpoints should work:
- http://localhost:3200/v0/urls for a list of URL's in the database
- http://localhost:3200/v0/primers for a list of primers
- see below for more information


- the API should now be running at `http://localhost:3200/`, and the following endpoints should work:
- http://localhost:3200/urls for a list of URL's in the database
- http://localhost:3200/urls/{id} for an indivudual URL
- http://localhost:3200/primers for a list of primers
- http://localhost:3200/users for a list of users
- http://localhost:3200/users/{id} for an individual user
- http://localhost:3200/primers for a list of primers
- http://localhost:3200/primers/{id} for an individual primer
- http://localhost:3200/sources for a list of data sources
- http://localhost:3200/sources/{id} for an individual source
- http://localhost:3200/repositories for a list of repositories
- http://localhost:3200/repository/{id} for an in ndividual repository
- http://localhost:3200/coverage for a coverage tree associated with root URLs
- http://localhost:3200/collections for a list of collections
- http://localhost:3200/collections/{id} for an individual collectoin
see below for more information

### Generating Documentation

THe API documentation is OpenAPI/Swagger compliant and is generated by the `spectacle` node module. You will likely want to explore these docs, so you should generate them!
Expand Down

0 comments on commit 8636a91

Please sign in to comment.