From 43079354c9c01805d88637a1d858fcd44487740e Mon Sep 17 00:00:00 2001
From: "E. Evstafiev" <ee345@cam.ac.uk>
Date: Mon, 25 Nov 2024 16:36:37 +0000
Subject: [PATCH] feat(docs): add OpenAPI specification generation instructions

---
 README.md | 18 ++++++++++++++----
 1 file changed, 14 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 91ecd03..e0ea600 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.
-- 
GitLab