diff --git a/README.md b/README.md index 91ecd03d7f6a3969f8d75d372d577d47387ff90c..e0ea600e2c04d760522972c45a452d1d225857c0 100644 --- a/README.md +++ b/README.md @@ -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.