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

API_SPECIFICATION

Name	Code	Description	Default Value	Supported Values

Name	Code	Description	Default Value
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 path length is sufficient, then Compartment Name is set to `FILE_PATH[1]`. Otherwise, default value is the target property `${{FDOAG_COMPARTMENT_NAME}}`	`${{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 path length is sufficient, then Gateway Name is set to `FILE_PATH[2]` after splitting by '/'. Otherwise, default value is the target property `${{FDOAG_GATEWAY_NAME}}`	`${{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. Default Value is the entire path after the third part, but before file name. i.e. /Compartment/Gateway/A/B/C/openapi.json → /A/B/C For more information, see Deploying an API on an API Gateway by Creating an API Deployment.	`/`
Display Name	`DISPLAY_NAME`	The user-friendly name to call this api.	`fd-apigateway-FILE_NAME`

N/A