Skip to content

Commit

Permalink
Small change in developer-api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bgalartza committed Aug 27, 2024
1 parent f7e7ffe commit d37fd75
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/Reference guides/developer-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ You can interact with the Biotz platform using the Developer API.

### API reference

The API is documented in the [OpenAPI][] v3.0 format. You can browse the
reference using [Biotz's Swagger][].

The API endpoints are documented in the [OpenAPI][] v3.0 format. You
can load and browse the [API specification][] from your tool of
choice, or use our [Swagger UI][].

### Authentication

Expand Down Expand Up @@ -51,7 +51,8 @@ The id token has to be sent in every API request using the [HTTP Authorization r
Authorization: Bearer <id-token>
```

[API specification]: https://api.biotz.io/docs/specification/developer-api.yaml
[Swagger UI]: https://api.biotz.io/docs/ui/index.html#/
[OpenAuth Password Grant Flow]: https://www.oauth.com/oauth2-servers/access-tokens/password-grant/
[OpenAPI]: https://swagger.io/resources/open-api/
[Biotz's Swagger]: https://api.biotz.io/docs/ui/index.html#/
[HTTP Authorization request header]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Authorization

0 comments on commit d37fd75

Please sign in to comment.