Skip to content

Commit

Permalink
fixup! 📝(users) describe authentication and authorization
Browse files Browse the repository at this point in the history
  • Loading branch information
jmaupetit committed Jun 4, 2024
1 parent 7efcf84 commit 7c088a6
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/user/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ use it in your developments.

### Ressources

:book: QualiCharge OpenAPI schema:
:book: QualiCharge OpenAPI schema (staging):
[https://staging.qualicharge.incubateur.net/api/v1/openapi.json](https://staging.qualicharge.incubateur.net/api/v1/openapi.json)

:gear: QualiCharge API root URL (staging):
Expand Down
10 changes: 5 additions & 5 deletions docs/user/auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ You'll receive your API credentials shortly (_e.g._ 1 or 2 business days).

We've integrated a OAuth2 password flow to authenticate to QualiCharge API.
Before digging into the code, you can test sent credentials by using the Swagger
UI at `https://{{ QUALICHARGE_API_ROOT_URL }}/docs`. Here is a screencast of
what it should look like:
UI at `{{ QUALICHARGE_API_ROOT_URL }}/docs`. Here is a screencast of what it
should look like:

![Swagger UI login screencast](../img/QualiCharge-Swagger-auth.gif "Swagger UI login")

Expand All @@ -98,8 +98,8 @@ your browser! Happy face :sunglasses:
> [Postman](https://www.postman.com) or the excellent
> [HTTPie](https://httpie.io) :heart:. When dealing with
> [JSON](https://en.wikipedia.org/wiki/JSON) response, we may also use the
> [`jq`](https://jqlang.github.io/jq/) command from a terminal. Again, feel free
> to install/use it, it's an amazing tool!
> [`jq`](https://jqlang.github.io/jq/) command from a terminal. Feel free to
> install and use it, it's an amazing tool!
From your terminal, post your `username` and `password` to the
`/api/v1/auth/token`:
Expand Down Expand Up @@ -152,7 +152,7 @@ header for further authenticated requests. We invite you to test it with the
`/auth/whoami` API endpoint:

```bash
# Make our first query using this access token:
# Make our first query using this access token
curl -X GET \
"{{ QUALICHARGE_API_ROOT_URL }}/auth/whoami" \
-H "accept: application/json" \
Expand Down

0 comments on commit 7c088a6

Please sign in to comment.