Skip to content

Commit

Permalink
Add link to API spec in quickstart (MarquezProject#846)
Browse files Browse the repository at this point in the history
Signed-off-by: wslulciuc <[email protected]>
  • Loading branch information
wslulciuc authored Nov 21, 2020
1 parent 3b18273 commit 5963d63
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Marquez is an [LF AI & Data Foundation](https://lfaidata.foundation/projects/mar
<img src="./web/docs/demo.gif">
</p>

Marquez provides a simple way to collect dataset and job metadata. The easiest way to get up and running is with Docker. From the base of the Marquez repository run:
The Marquez [API](https://marquezproject.github.io/marquez/openapi.html) provides a simple way to collect dataset and job metadata. The easiest way to get up and running is with Docker. From the base of the Marquez repository run:

```
$ ./docker/up.sh
Expand All @@ -35,7 +35,7 @@ $ ./docker/up.sh
The HTTP API listens on port `5000` for all calls and port `5001` for the admin interface. To verify the HTTP API server is running and listening on localhost browse to http://localhost:5001.

> Note: By default, the HTTP API does not require any form of authentication or authorization.
> **Note:** By default, the HTTP API does not require any form of authentication or authorization.
You can open http://localhost:3000 to begin exploring the web UI.

Expand Down

0 comments on commit 5963d63

Please sign in to comment.