Skip to content

Commit

Permalink
fix(docs): Refactors page titles and makes API pages visible again (#320
Browse files Browse the repository at this point in the history
)

* refactor: Changes "Development" to "Developer"

* fix(docs): Refactors page titles and makes API pages visible again

* FIx “too” -> “to” typo

* refactor: Refactors API section

* fix: Fixes broken link to API testing page

Co-authored-by: Peter Kos <pkos91@icloud.com>
  • Loading branch information
cbaudouinjr and peterkos authored Sep 14, 2020
1 parent 7c3cc0a commit 8617981
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
8 changes: 4 additions & 4 deletions docs/api-usage.md → docs/api-overview.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: api-usage
title: API Usage
id: api-overview
title: Overview
---

## Introduction
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions docs/api-setup.md → docs/api-testing-setup.md
Original file line number Diff line number Diff line change
@@ -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/).
Expand Down
2 changes: 1 addition & 1 deletion website/sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"updating-hm"
],
"Guides": ["running-a-hackathon", "questionnaires", "messages", "busses"],
"Development": ["api"],
"API": ["api-overview", "api-testing-setup"],
"Getting Help": ["resources"]
}
}

0 comments on commit 8617981

Please sign in to comment.