Skip to content

Latest commit

 

History

History
44 lines (37 loc) · 2.59 KB

README.md

File metadata and controls

44 lines (37 loc) · 2.59 KB
Raw

Trellix Intelligent Sandbox (Former: ATD)

The OpenAPI specification for interacting with REST APIs that Trellix Intelligent Sandbox (former: ATD) offers.

How to generate SDKs?

Setting up the OpenAPI Generator in your environment (one time step)

  1. Navigate to: OpenAPI Generator installation
  2. Choose the CLI client that suits your need/integrates with your platform better. (Recommended to use v5.0.1+) For more info please visit: https://openapi-generator.tech
  3. The OpenAPI Generator supports many different integrations and use cases, including (but not limited to):
    • Maven Plugin
    • Gradle Plugin
    • Bazel Plugin
    • SBT Plugin
    • Cake Plugin
    • CLI via Homebrew
    • CLI via Docker
    • CLI via npm
    • Generator SaaS
      For details, see Workflow Integrations

NOTE:
In some cases the cli generator might be named as openapi-generator-cli instead of openapi-generator, please be cautious.

Generating the SDK

  1. Run the following command and make sure you are running version 5.0+. Find the latest version here
    openapi-generator version
  2. For listing out the available languages you can use:
    openapi-generator list
    Alternatively, you can visit: List of client generators for list of supported client SDKs.
  3. For generating the client in the language of your choice, run the following:
    openapi-generator generate -i input_file_name.yaml -g a_language_name_from_list -o /path/to/output_folder

NOTE:
1. If during execution you encounter an error saying "any module/model name" not found, kindly generate the client using the following global property:
openapi-generator generate -i file_name.yaml -g a_language_name_from_list -o /path/to/output_folder --global-property skipFormModel=false

Importing openapi spec in Postman

In order to import the OpenAPI file in postman, please refer to : working with openAPI

Contributing and Code of conduct

For Code of conduct and contribution guidelines please refer to CODE_OF_CONDUCT and CONTRIBUTING respectively.