@coscine/api-client 3.16.0 → 3.18.0

package/README.md

@@ -8,6 +8,20 @@ The API Client library for JavaScript clients contains generated API connection
 
 ## 📖 Usage
 
+### How to generate a new API Client library version
+* Start the API on the branch with the changes you want to see in the API Client library
+* Open the API Client library with SSH (not in a Container) on a new branch
+* Run the shell script generate-api-client.sh (e.g. in bash: `bash generate-api-client.sh`)
+* When you are asked to select an image choose the docker.io image
+    ```
+    Running the OpenAPI generator...
+    ? Please select an image: 
+    ▸ registry.access.redhat.com/openapitools/openapi-generator-cli:latest
+      registry.redhat.io/openapitools/openapi-generator-cli:latest
+      docker.io/openapitools/openapi-generator-cli:latest
+    ```
+* Commit the changes to your branch of the API Client library and use the new generated version in the ui
+
 ### Build
 * `yarn install`
 * `yarn build`
@@ -25,6 +39,8 @@ Bundles the output of [CodeGen](https://git.rwth-aachen.de/coscine/backend/scrip
 
 Use the `generateConnectors.sh` script when in a Coscine environment.
 
+Upon adding or removing any API endpoints, the list of entries in `src/apis.ts` and `src/index.ts` may have to be manually updated.
+
 ## 👥 Contributing
 
 As an open source platform and project, we welcome contributions from our community in any form. You can do so by submitting bug reports or feature requests, or by directly contributing to Coscine's source code. To submit your contribution please follow our [Contributing Guideline](https://git.rwth-aachen.de/coscine/docs/public/wiki/-/blob/master/Contributing%20To%20Coscine.md).