FAQ | This is a LIVE service | Changelog

Skip to content
Snippets Groups Projects
Commit 43079354 authored by E. Evstafiev's avatar E. Evstafiev :bulb:
Browse files

feat(docs): add OpenAPI specification generation instructions

parent 11cc102e
No related branches found
No related tags found
1 merge request!52Resolve "Ensure OpenAPI specification is generated correctly"
......@@ -64,10 +64,6 @@ For a fuller description of how to debug follow the
The project is configured with Gitlab AutoDevOps via Gitlab CI using the .gitlab-ci.yml file.
## Copyright License
See the [LICENSE](LICENSE) file for details.
## Session authentication
In order to leverage existing tooling for OAuth2, it was decided that retrieving the access token
......@@ -134,3 +130,17 @@ Pragma: no-cache
```
To authenticate to other API endpoints, we would set the following header: `Authorization: Bearer abcdefg1234567`.
## Generating the OpenAPI Specification
To generate the OpenAPI specification for this project, you can use the configured Poetry task. Run the following command:
```bash
poetry poe generate-schema
```
This command utilizes the `poe` task `generate-schema` to build and run the necessary Docker commands, generating the `openapi.yaml` file which contains the OpenAPI schema for the API.
## Copyright License
See the [LICENSE](LICENSE) file for details.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment