This is a Go Client SDK leveraging the DCT APIGW.

For SDK usage, please refer to OPENAPI-README.md file

This is a guide on generation of the client SDK in Go Lang for the DCT Orbital APIGW.

The reources for code generation are present in the 'generation-scripts' directory. The script codegen.sh generates a GO Client SDK using the openapi-generator-cli tool. It generates the SDK, initializes the SDK and runs a test go function.

Java needs to be installed to run the jar file. And Golang >= 1.17 needs to be installed in the machine where the script is run.

This repository houses the Go Client SDK for Delphix Control Tower APIs ( Multi Cloud Version).

To be added.

Also the script requires an API Spec file for the DCT-APIGW. A sample file is present in the directory. For the latest spec, please download it from https://raw.githubusercontent.com/delphix/orbital-api-gateway/main/app/src/main/resources/api.yaml

As mentioned above the script requires a spec file.

Run the script as follows

sh codegen.sh api.yaml

On successful run, following tasks will result:

1. Generation of client SDK
2. Initialize the SDK module
3. Run the Test Go file, input the API key and hostname of the Delphix Engine and display list of Engines added to the APIGW

The test.go file executes a get all engines operation on the configured DCT-APIGW. To run the test on your delphix engine, provide the API key and Hostname of the engine when prompted.

The test essentially tests if the client SDK is functional and should be run before raising a PR. The result of the test will be available at the end of the script as follows.

List of engines are:
my-host.domain.co

If in any case, the test fails, we will be getting a 'test failed' message in the end.

Once successful generation of client SDK and the test succeeds, we are ready to raise a PR.

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

• Dephix Engineering - Company

This project is licensed under the Apache License 2.0. Full license is available here.

We use SemVer for versioning. For the versions available, see the tags on this repository.