@coscine/api-client

API Client Library

[[TOC]]

📝 Overview

The API Client library for JavaScript clients contains generated API connection classes and their typings based on the Coscine API Swagger definitions, bundling them together for ease of use within Coscine applications. Additionally, the library provides setup functionality to simplify the API connection process and streamline communication with the Coscine API.

📖 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

Testing

• yarn test

Linting

• yarn lint:fix

Links

Bundles the output of CodeGen.

Create API Connectors

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.

📄 License

The current open source repository is licensed under the MIT License, which is a permissive license that allows the software to be used, modified, and distributed for both commercial and non-commercial purposes, with limited restrictions (see LICENSE file)

The MIT License allows for free use, modification, and distribution of the software and its associated documentation, subject to certain conditions. The license requires that the copyright notice and permission notice be included in all copies or substantial portions of the software. The software is provided "as is" without any warranties, and the authors or copyright holders cannot be held liable for any damages or other liability arising from its use.

🆘 Support

• Check the documentation: Before reaching out for support, check the help pages provided by the team at https://docs.coscine.de/en/. This may have the information you need to solve the issue.
• Contact the team: If the documentation does not help you or if you have a specific question, you can reach out to our support team at [e-mail] 📧. Provide a detailed description of the issue you're facing, including any error messages or screenshots if applicable.
• Be patient: Our team will do their best to provide you with the support you need, but keep in mind that they may have a lot of requests to handle. Be patient and wait for their response.
• Provide feedback: If the support provided by our support team helps you solve the issue, let us know! This will help us improve our documentation and support processes for future users.

By following these simple steps, you can get the support you need to use Coscine's services as an external user.

📦 Release & Changelog

External users can find the Releases and Changelog inside each project's repository. The repository contains a section for Releases (Deployments > Releases), where users can find the latest release changelog and source. Withing the Changelog you can find a list of all the changes made in that particular release and version.
By regularly checking for new releases and changes in the Changelog, you can stay up-to-date with the latest improvements and bug fixes by our team and community!