From 95ddf20f837a9578089a71ed94bff4ec3d1a3201 Mon Sep 17 00:00:00 2001
From: Johanna Szepanski <johanna.szepanski@softhouse.se>
Date: Tue, 27 Aug 2024 14:01:17 +0200
Subject: [PATCH] updated read me

---
 README.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/README.md b/README.md
index b352dee9..35494c9c 100644
--- a/README.md
+++ b/README.md
@@ -30,6 +30,15 @@ This project includes private dependencies from Artifactory, so additional confi
 
 Note, we lock dependency versions with _package-lock.json_; please install dependencies with `npm ci` (not npm install) to avoid overwriting the package-lock.
 
+## Updating the API Files
+
+This project uses `@rtk-query/codegen-openapi` to auto-generate the deploy api from its OpenAPI spec. To generate the spec:
+
+1. Run `npm run generate-api` to update the api file; see `openapi-config.json` for path information.
+1. Commit the changed file.
+
+Note: default path to api spec is localhost. To generate a new spec BE must run locally. It is possible to change path to any other swagger environment, but it is preferred to use locally running backend.
+
 ### Proxying to Existing Backends
 
 For being able to run the backend, and frontend application on the same machine (locally) a proxy has been set in the project!
-- 
GitLab