From 64769348104c3877b5401a7630d6550a794390fe Mon Sep 17 00:00:00 2001 From: "Chris Baudouin, Jr" Date: Fri, 21 Aug 2020 18:08:14 -0400 Subject: [PATCH 1/5] refactor: Changes "Development" to "Developer" --- website/sidebars.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/sidebars.json b/website/sidebars.json index f030ac1aa..738109490 100755 --- a/website/sidebars.json +++ b/website/sidebars.json @@ -12,6 +12,6 @@ "updating-hm" ], "Guides": ["running-a-hackathon", "questionnaires", "messages", "busses"], - "Development": ["api"] + "Developer": ["api"] } } From c1521af3902605c4482efc33e65bbc8ed8131287 Mon Sep 17 00:00:00 2001 From: "Chris Baudouin, Jr" Date: Fri, 21 Aug 2020 18:13:46 -0400 Subject: [PATCH 2/5] fix(docs): Refactors page titles and makes API pages visible again --- docs/{api-usage.md => api-overview.md} | 4 ++-- docs/{api-setup.md => api-testing-setup.md} | 4 ++-- website/sidebars.json | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) rename docs/{api-usage.md => api-overview.md} (99%) rename docs/{api-setup.md => api-testing-setup.md} (98%) diff --git a/docs/api-usage.md b/docs/api-overview.md similarity index 99% rename from docs/api-usage.md rename to docs/api-overview.md index 374a3cc87..abb9f148f 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: API Overview --- ## Introduction 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..d44064d50 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: API 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 738109490..47b619f52 100755 --- a/website/sidebars.json +++ b/website/sidebars.json @@ -12,6 +12,6 @@ "updating-hm" ], "Guides": ["running-a-hackathon", "questionnaires", "messages", "busses"], - "Developer": ["api"] + "Developer": ["api-overview", "api-testing-setup"] } } From 8a37b069df67de59c033b5528b48479beb806062 Mon Sep 17 00:00:00 2001 From: Peter Kos Date: Tue, 8 Sep 2020 00:46:42 -0400 Subject: [PATCH 3/5] =?UTF-8?q?FIx=20=E2=80=9Ctoo=E2=80=9D=20->=20?= =?UTF-8?q?=E2=80=9Cto=E2=80=9D=20typo?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/api-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-overview.md b/docs/api-overview.md index abb9f148f..d5aa0674e 100644 --- a/docs/api-overview.md +++ b/docs/api-overview.md @@ -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. From 3fa8313ccd362e1635f8e87834768bbe5759983c Mon Sep 17 00:00:00 2001 From: "Chris Baudouin, Jr" Date: Thu, 10 Sep 2020 15:00:09 -0400 Subject: [PATCH 4/5] refactor: Refactors API section --- docs/api-overview.md | 2 +- docs/api-testing-setup.md | 2 +- website/sidebars.json | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api-overview.md b/docs/api-overview.md index abb9f148f..a27be87af 100644 --- a/docs/api-overview.md +++ b/docs/api-overview.md @@ -1,6 +1,6 @@ --- id: api-overview -title: API Overview +title: Overview --- ## Introduction diff --git a/docs/api-testing-setup.md b/docs/api-testing-setup.md index d44064d50..03e33e690 100644 --- a/docs/api-testing-setup.md +++ b/docs/api-testing-setup.md @@ -1,6 +1,6 @@ --- id: api-testing-setup -title: 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 47b619f52..09baa9726 100755 --- a/website/sidebars.json +++ b/website/sidebars.json @@ -12,6 +12,6 @@ "updating-hm" ], "Guides": ["running-a-hackathon", "questionnaires", "messages", "busses"], - "Developer": ["api-overview", "api-testing-setup"] + "API": ["api-overview", "api-testing-setup"] } } From 17180b9fc9637e940a0efb89907a4094b367debc Mon Sep 17 00:00:00 2001 From: "Chris Baudouin, Jr" Date: Sun, 13 Sep 2020 21:45:35 -0400 Subject: [PATCH 5/5] fix: Fixes broken link to API testing page --- docs/api-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api-overview.md b/docs/api-overview.md index 192019b83..da4e24b63 100644 --- a/docs/api-overview.md +++ b/docs/api-overview.md @@ -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.