diff --git a/docs/api-usage.md b/docs/api-overview.md similarity index 96% rename from docs/api-usage.md rename to docs/api-overview.md index f7ff37c4f..da4e24b63 100644 --- a/docs/api-usage.md +++ b/docs/api-overview.md @@ -1,6 +1,6 @@ --- -id: api-usage -title: API Usage +id: api-overview +title: Overview --- ## Introduction @@ -29,7 +29,7 @@ For example: | Update tag | `PATCH https://your-hackathon.io/manage/trackable_tags/1.json` (with body parameters) | | Delete tag | `DELETE https://your-hackathon.io/manage/trackable_tags/1.json` | -For a full list of endpoints, run `bin/rails routes` locally. This utility, provided by Ruby on Rails, lists all possible paths you can route too (along with their respective HTTP method). +For a full list of endpoints, run `bin/rails routes` locally. This utility, provided by Ruby on Rails, lists all possible paths you can route to (along with their respective HTTP method). > Note: Datatable endpoints are highly coupled to [Datatables](https://datatables.net) functionality and are not easy to use. @@ -76,7 +76,7 @@ end Authentication is implemented with OAauth 2, provided by the [Doorkeeper](https://github.com/doorkeeper-gem/doorkeeper) gem. For full Doorkeeper endpoints + docs, see the [Doorkeeper wiki](https://github.com/doorkeeper-gem/doorkeeper/wiki/API-endpoint-descriptions-and-examples). -See the [Setup Postman/Paw for API Testing](api-setup.md) page for information on using those tools for testing the API locally. +See the [Setup Postman/Paw for API Testing](api-testing-setup.md) page for information on using those tools for testing the API locally. Once appropriate authentication credentials are retrieved, they should be provided on all API requests. diff --git a/docs/api-setup.md b/docs/api-testing-setup.md similarity index 98% rename from docs/api-setup.md rename to docs/api-testing-setup.md index 64cc522c2..03e33e690 100644 --- a/docs/api-setup.md +++ b/docs/api-testing-setup.md @@ -1,6 +1,6 @@ --- -id: api-setup -title: Setup Postman/Paw for API Testing +id: api-testing-setup +title: Testing Setup --- This page will show you how to simulate API requests with [Postman](https://www.postman.com/) or [Paw](https://paw.cloud/). diff --git a/website/sidebars.json b/website/sidebars.json index 25d431902..614eea1c2 100755 --- a/website/sidebars.json +++ b/website/sidebars.json @@ -12,7 +12,7 @@ "updating-hm" ], "Docs": ["docs-overview", "questionnaires", "messages", "busses"], - "Development": ["api"], + "API": ["api-overview", "api-testing-setup"], "Getting Help": ["resources"] } }