diff --git a/README.md b/README.md index 4a7c5a8..6a14621 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Please email api@ycombinator.com if you find any bugs. ## URI and Versioning -We hope to improve the API over time, and may later enable access to private per-user data using OAuth. The changes won't always be backward compatible, so we're going to use versioning. This first iteration will have URIs prefixed with https://hacker-news.firebaseio.com/v0/ and is structured as described below. There is currently no rate limit. +We hope to improve the API over time, and may later enable access to private per-user data using OAuth. The changes won't always be backward compatible, so we're going to use versioning. This first iteration will have URIs prefixed with `https://hacker-news.firebaseio.com/v0/` and is structured as described below. There is currently no rate limit. For versioning purposes, only removal of a non-optional field or alteration of an existing field will be considered incompatible changes. *Clients should gracefully handle additional fields they don't expect, and simply ignore them.* @@ -22,7 +22,7 @@ I'm not saying this to defend it - It's not the ideal public API, but it's the o ## Items -Stories, comments, jobs, Ask HNs and even polls are just items. They're identified by their ids, which are unique integers, and live under https://hacker-news.firebaseio.com/v0/item/. +Stories, comments, jobs, Ask HNs and even polls are just items. They're identified by their ids, which are unique integers, and live under `/v0/item/`. All items have some of the following properties, with required properties in bold: @@ -139,7 +139,7 @@ and one of its parts: https://hacker-news.firebaseio.com/v0/item/160705.json?pri ## Users -Users are identified by case-sensitive ids, and live under https://hacker-news.firebaseio.com/v0/user/. Only users that have public activity (comments or story submissions) on the site are available through the API. +Users are identified by case-sensitive ids, and live under `/v0/user/`. Only users that have public activity (comments or story submissions) on the site are available through the API. Field | Description ------|------------ @@ -169,7 +169,7 @@ The coolest part of Firebase is its support for change notifications. While you ### Max Item ID -The current largest item id is at https://hacker-news.firebaseio.com/v0/maxitem. You can walk backward from here to discover all items. +The current largest item id is at `/v0/maxitem`. You can walk backward from here to discover all items. Example: https://hacker-news.firebaseio.com/v0/maxitem.json?print=pretty @@ -179,7 +179,7 @@ Example: https://hacker-news.firebaseio.com/v0/maxitem.json?print=pretty ### New, Top and Best Stories -Up to 500 top and new stories are at https://hacker-news.firebaseio.com/v0/topstories and https://hacker-news.firebaseio.com/v0/newstories. Best stories are at https://hacker-news.firebaseio.com/v0/beststories. +Up to 500 top and new stories are at `/v0/topstories` and `/v0/newstories`. Best stories are at `/v0/beststories`. Example: https://hacker-news.firebaseio.com/v0/topstories.json?print=pretty @@ -189,7 +189,7 @@ Example: https://hacker-news.firebaseio.com/v0/topstories.json?print=pretty ### Ask, Show and Job Stories -Up to 200 of the latest Ask HN, Show HN, and Job stories are at https://hacker-news.firebaseio.com/v0/askstories, https://hacker-news.firebaseio.com/v0/showstories, and https://hacker-news.firebaseio.com/v0/jobstories. +Up to 200 of the latest Ask HN, Show HN, and Job stories are at `/v0/askstories`, `/v0/showstories`, and `/v0/jobstories`. Example: https://hacker-news.firebaseio.com/v0/askstories.json?print=pretty @@ -199,7 +199,7 @@ Example: https://hacker-news.firebaseio.com/v0/askstories.json?print=pretty ### Changed Items and Profiles -The item and profile changes are at https://hacker-news.firebaseio.com/v0/updates. +The item and profile changes are at `/v0/updates`. Example: https://hacker-news.firebaseio.com/v0/updates.json?print=pretty