Skip to content
This repository was archived by the owner on Nov 5, 2019. It is now read-only.

Commit ebcd581

Browse files
committed
Added links to Swagger docs, and route descriptions.
1 parent d0f4cdc commit ebcd581

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,15 @@ The output is cached in [`cache.json`](cache.json). Because this is a large file
3636
## Routes
3737

3838
* `/healthcheck` - server status
39-
* `/repositories` - listing of all data repositories
40-
* `/repositories/:repository_uuid` - details of one data repository
41-
* `/fulltree` -
42-
* `/coverage` -
43-
* `/tree` - alias for `/coverage`
39+
* `/repositories` - list all data repositories [:question:][route-repos]
40+
* `/repositories/:repository_uuid` - get details for a single data repository [:question:][route-repo]
41+
* `/fulltree` - get full coverage tree of url-based resources
42+
* `/tree` - get scope-able coverage tree [:question:][route-coverage]
43+
* `/coverage` - get coverage summary (not currently used)
44+
45+
[route-repos]: http://petstore.swagger.io/?url=https://raw.githubusercontent.com/datatogether/api/master/open_api.yaml#/default/get_repositories
46+
[route-repo]: http://petstore.swagger.io/?url=https://raw.githubusercontent.com/datatogether/api/master/open_api.yaml#/default/get_repository__id_
47+
[route-coverage]: http://petstore.swagger.io/?url=https://raw.githubusercontent.com/datatogether/api/master/open_api.yaml#/default/get_coverage
4448

4549

4650
## Getting Involved
@@ -98,7 +102,6 @@ $GOPATH/bin/coverage
98102
Barring any changes, you may now visit a JSON endpoint at: `http://localhost:8080/repositories`
99103

100104

101-
102105
## Development
103106

104107
Please follow the install instructions above! Inclusion of tests are appreciated!

0 commit comments

Comments
 (0)