Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
peterkos merged 8 commits into from
Sep 14, 2020
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6476934
refactor: Changes "Development" to "Developer"
cbaudouinjr Aug 21, 2020
c1521af
fix(docs): Refactors page titles and makes API pages visible again
cbaudouinjr Aug 21, 2020
8a37b06
FIx “too” -> “to” typo
peterkos Sep 8, 2020
3fa8313
refactor: Refactors API section
cbaudouinjr Sep 10, 2020
a3e44ac
Merge branch 'hm-319' of github.com:codeRIT/hackathon-manager into hm…
cbaudouinjr Sep 10, 2020
57efa44
Merge branch '2.0' into hm-319
cbaudouinjr Sep 10, 2020
4661619
Merge branch '2.0' into hm-319
cbaudouinjr Sep 14, 2020
17180b9
fix: Fixes broken link to API testing page
cbaudouinjr Sep 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/api-usage.md → docs/api-overview.md
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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"]
}
}