@@ -8,34 +8,18 @@ CodeGen is an executable script, that generates TypeScript classes for Coscine's
## ⚙️ Configuration
Before you can run and use the API, you need to ensure that the following dependencies and prerequisites are in place:
Before you can run and use the script, you need to ensure that the following dependencies and prerequisites are in place:
1. A Coscine database instance must be running. If you haven't set up a Coscine database instance yet, please refer to the [Coscine documentation]() for instructions on how to do so.
2. The Consul service should be correctly set up as a Key-Value store. If you haven't set up Consul yet, please refer to the [Consul documentation]() for instructions on how to do so.
3. The project's referenced .NET SDK(s) must be installed. Please refer to the project's source code for information on which .NET SDK(s) are required.
4. Your user account has the necessary access rights.
1. The project's referenced .NET SDK(s) must be installed. Please refer to the project's source code for information on which .NET SDK(s) are required.
Once you have all the necessary dependencies and prerequisites in place, you should be able to run and use the API with the appropriate authentication credentials.
Once you have all the necessary dependencies and prerequisites in place, you should be able to run and use this script.
## 📖 Usage
This project is built using .NET SDK. In order to build or modify the script, you will need the necessary SDK installed on your system.
To get started with this project, you will need to ensure you have configured and built it correctly.
* Execute the built CodeGen executable
* You should find the output client definitions in the specified output folder (default: `./Output`)
## 📚 API Reference
To get started with this project, you will need to ensure you have configured it correctly. Please refer to the configuration guide above. Once the project is running, you can access the API through the following Swagger endpoint:
To authenticate in Swagger with a Bearer JWT token, you will need to generate a token in Coscine under your _User Profile_. Once you have your token, you can open the Swagger documentation for the API you want to authenticate with and click on the "Authorize" button. In the "Authorization Value" field, you should enter `Bearer` followed by a space and then your Bearer JWT token. Click on the "Authorize" button to authenticate, and you should now be able to make authenticated requests to the API.
> :bulb: Make sure to keep your Bearer JWT token secure, as it grants access to your account and API resources. If you suspect that your token has been compromised, you should generate a new one and invalidate all existing ones immediately.
For detailed information about each endpoint and the parameters they accept, please refer to the [API Swagger documentation](https://coscine.rwth-aachen.de/coscine/api/Coscine.Api.Admin/swagger/index.html).
1. Execute the built CodeGen executable (`.exe`)
2. You should find the output client definitions in the specified output folder (default: `./Output`, found in where the `.exe` is located)
