Skip to main content
API Specification is the logical configuration of the API exposed by a deployment. API Specification files are validated at build time.

​
Object Type Identification

  • When populating files from source control management (SCM), FlexDeploy will classify all files with extension of .json or .yaml (case-insensitive) as API Specifications regardless of location.

​
File Extensions

  • .json
  • .yaml

​
Object Type Code

API_SPECIFICATION

​
Suggested SCM Structure

There are a few options available to you:

​
Attributes

Name

Code

Description

Default Value

Supported Values

Compartment Name

COMPARTMENT_NAME

The compartment to deploy this api to. FlexDeploy assume compartment name is unique for the given tenancy as OCID is determined from compartment name.

If the path contains 2 or more slashes, the first segment of the path is used. Otherwise, default value is the target property \{\{FDOAG_COMPARTMENT_NAME\}\}</code></p></td><td class="confluenceTd"><p>&nbsp;<code>{{FDOAG_COMPARTMENT_NAME}}

 

Gateway Name

GATEWAY_NAME

The gateway to deploy this api to. FlexDeploy assumes gateway name is unique in the above compartment as OCID is determined from gateway name.

If the path contains 3 or more slashes, the second segment of the path is used. Otherwise, default value is the target property {{FDOAGGATEWAYNAME}}</code></p></td><tdclass="confluenceTd"><p><code>\{\{FDOAG_GATEWAY_NAME\}\}</code></p></td><td class="confluenceTd"><p><code>{{FDOAG_GATEWAY_NAME}}

 

Path Prefix

PATH_PREFIX

The path on which to deploy all routes contained in the API deployment specification. Path must begin with forward slash.

If the path contains 3 or more slashes, the value is derived from the path.

i.e. if the path is /Compartment/Gateway/A/B/C/openapi.json then the path prefix will be /A/B/C

For more information, see <u>Deploying an API on an API Gateway by Creating an API Deployment</u>.

/

Display Name

DISPLAY_NAME

The user-friendly name to call this api.

fd-apigateway-FILE_NAME

Rollback Source Type

ROLLBACK_SOURCE_TYPE

Where to retrieve file when initiating a rollback deployment.

Project Version

Project Version, SCM Revision, Backup Repository, and Rollback File

SCM Revision and Rollback File options are only available when the project has SCM details configured, and Backup Repository should only be used if the FlexDeploy server and project are configured to take backups.

Rollback File

ROLLBACK_FILE

The associated file to deploy which will roll back this file. Only applicable when Rollback Source Type is Rollback File

Any project file sourced from SCM

​
Considerations

N/A