/h1-generators

Primary LanguageTypeScriptMIT LicenseMIT

H1-Generators

This repository contains code responsible for automatically generating client libraries for HyperOne API using OpenAPI generator and GitHub Actions.

Usage

This library is designed to work using GitHub Actions on Linux based operating system. To run it under your own namespace fork this repository, replace repositories containing generated code in generate.yaml and add required environment variables:

PUSH_TOKEN- Personal Access Token (PAT) allowing you to push code to other repositories.

PASSPORT_FILE- HyperOne passport file content, used to perform end-to-end tests with HyperOne v2 API using HyperOne credential libraries.

Generating client on personal machine

You are able to generate client library using any PC with Linux based operating system with installed bash and yarn. To do that install all dependencies:

yarn

and start generator for choosen language:

yarn start $LANG

for example:

yarn start ts

Important: building the application and running it with node binary is not the recommended way to use this application, since it may lead to errors caused by incorrect paths from __dirname resolving.