Connectors and Connections

Back Next

Swagger specification file in a serverless runtime environment

To configure a swagger file in a serverless runtime environment, be sure to complete the prerequisites.

In the serverless runtime environment, you can configure a swagger file in one of the following ways:

Provide the swagger file public hosted URL in the

Swagger File Path

connection property. Ensure that the URL must return the content of the file without prompting for further authentication and redirection.

Place the swagger file in the serverless agent directory.

To configure a swagger file in a serverless runtime environment, complete the following prerequisite tasks to add the swagger file to the serverless runtime location:

Create the following structure for the serverless agent configuration in AWS or Azure:

<Supplementary file location>/serverless_agent_config

Add the swagger specification file in the Amazon S3 bucket or Azure container in the following location in your AWS or Azure account:

<Supplementary file location>/serverless_agent_config/restv2

Copy the following code snippet to a text editor:

version: 1
agent:
  dataIntegrationServer:
    autoApply:
      restv2:
        swaggers:
          - fileCopy:
              sourcePath: restv2/<swagger_file_name1>.json
          - fileCopy:            
              sourcePath: restv2/<swagger_file_name2>.json

where the source path is the directory path of the swagger files in AWS or Azure.

Ensure that the syntax and indentations are valid, and then save the file as

serverlessUserAgentConfig.yml

in the following AWS or Azure location:

<Supplementary file location>/serverless_agent_config

When the .yml file runs, the SSL certificates are copied from the AWS or Azure location to the serverless agent directory.

In the REST V2 connection properties, specify the following swagger path in the serverless agent directory in the

Swagger File Path

field:

/home/cldagnt/SystemAgent/serverless/configurations/restv2/<swagger_file_name>.json

For more information about how to configure and use the serverless runtime environment, see

Serverless Runtime Environments