This operation creates an api deployment for each specification file to an API Gateway for the OCI Tenancy. The apiDeploy operation can only be used with a FlexDeploy package-based deployment project of type Oracle API Gateway. On deploy execution, file level attributes compartment name, gateway name, and path prefix determine if the api deployment should be created new or update an existing deployment the content of the specification file. That means path prefix must be unique for the given compartment-gateway combination for a new api deployment to be created.
Artifact is a single zip file containing api specification files (JSON or YAML).
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. |
Project Properties
Property Name | Property Code | Required | Description |
---|---|---|---|
Root Compartment Id | FDOAG_ROOT_COMPARTMENT_ID | Yes | Root or parent compartment Id used to find sub-compartments. i.e. ocid1.tenancy.oc1..<OCID> This can be sub-compartment as well, but root is suggested. |
Inputs
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. |
Artifacts
This operation produces artifacts that will be stored in the artifacts repository.
Endpoint Selection
This operation will select all available endpoints associated to the Target.
Endpoint Execution
This operation will execute on any one of the selected endpoints and will be random in the determination of which one.
Special Considerations
N/A