Add API related docs + postman collection

rideranton commented

2023-09-14 01:45:06 +00:00

This PR adds some improvements to the documentation, explaining the steps needed to get the API working with a newly deployed instance, and how to create OAuth2 clients as an application developer. In addition, it adds a postman collection and environment for those familiar with Postman to experiment with.

👍 1

rideranton added 1 commit 2023-09-14 01:45:10 +00:00

Kbin CI/CD pipeline / unit-test (pull_request) Successful in 22s Details

Kbin CI/CD pipeline / build (pull_request) Successful in 39s Details

Kbin CI/CD pipeline / fixer-dry-run (pull_request) Successful in 28s Details

18db3bb678 Add some extra information around creating oauth clients, keys, and starting oauth flows

Also add postman collection documenting existing and soon-to-exist APIs

rideranton added 1 commit 2023-09-14 02:52:22 +00:00

Kbin CI/CD pipeline / unit-test (pull_request) Successful in 21s Details

Kbin CI/CD pipeline / build (pull_request) Successful in 38s Details

Kbin CI/CD pipeline / fixer-dry-run (pull_request) Successful in 29s Details

cd00dd41de Examining what you copy/paste is important

rideranton force-pushed feature/api-docs from cd00dd41de to 20e57de96f

2023-09-14 05:51:49 +00:00

Compare

szsz commented

2023-09-14 05:57:10 +00:00

Owner

Why put api doc json for postman in repository when it can be imported from https://localhost/api/doc.json?

rideranton commented

2023-09-14 06:49:18 +00:00

Poster

Why put api doc json for postman in repository when it can be imported from https://localhost/api/doc.json?

The postman collection is different from the OpenAPI 3 spec at /api/doc.json - It has a few scripts that can automate some of OAuth2 client creation (assigning client id and secret to variables, demonstrating how to generate a code verifier for Auth Code with PKCE flows, etc). There are enough useful things with it that its probably worth including in the docs folder

> Why put api doc json for postman in repository when it can be imported from https://localhost/api/doc.json? The postman collection is different from the OpenAPI 3 spec at /api/doc.json - It has a few scripts that can automate some of OAuth2 client creation (assigning client id and secret to variables, demonstrating how to generate a code verifier for Auth Code with PKCE flows, etc). There are enough useful things with it that its probably worth including in the docs folder

ernest merged commit 57c1172c99 into develop

2023-09-15 06:04:58 +00:00

ernest referenced this issue from a commit

2023-09-15 06:04:58 +00:00

Add API related docs + postman collection #1127