Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Artifact is a single zip file containing api specification files (JSON or YAML). The specifications contain information about the back-end resources and the methods (for example, GET, PUT, etc..) that can be performed on the each back-end resource.

Target Properties

Property Name

Property Code

Required

Description

Oracle API Gateway Account

FDOAG_CLOUD_ACCOUNT_CODE

No*

OCI account with all the required properties like Tenancy Id, User OCID, and Private Key, etc.

Oracle API Gateway Account will be required on either the plugin input or Target. If a value is set on both then, the plugin input will take precedence.

See Special Considerations below for instructions on how to create an OCI account for Oracle API Gateway.

Compartment Name

FDOAG_COMPARTMENT_NAME

No*

The OCI compartment used to validate the api specification. Useful if you build from a different compartment per environment.

Compartment Name is required if Compartment Name on a file level attribute contains property replacement syntax - Property Replacement Support

...

Property Name

Property Code

Required

Description

Oracle API Gateway Account

FDOAG_INP_CLOUD_ACCOUNT_CODE

No

OCI account with all the required properties like Tenancy Id, User OCID, and Private Key, etc.

Add Tags

FDOAG_INP_ADD_TAGS

No

Add defined tags when an API is created or updated. This is used to linked SCM commits and FlexDeploy build events to API creation or updates. Default is true.

The following defined tags will be added on build:

If Add Tags is enabled, and these tags do not exist, FlexDeploy will automatically create the tag namespace (FlexDeploy) and the tags within it.

Artifacts

This operation produces artifacts that will be stored in the artifacts repository.

...