Deploys an API to a Logical Gateway and any configured Nodes for that Gateway. The API deployed is determined by the FDOAP_API_NAME and FDOAP_API_VERSION properties and the optional FDOAP_INP_API_ITERATION input.
This operation can also be used to undeploy, activate or inactivate a deployment depending on the Deploy Action input.
...
Property Name | Property Code | Required | Description |
---|---|---|---|
Oracle API Platform Account | FDOAP_CLOUD_ACCOUNT_CODE | Y | The Oracle API Platform cloud account to use for this operation. |
Oracle API Gateway Id | FDOAP_GATEWAY_ID | Y | The Logical Gateway Id to use for deployments. This is found in the header drawer (3 vertical dots) when inspecting the Logical Gateway in API Platform. |
...
This operation will execute on any one of the selected endpoints and will be random in the determination of which one.
Special Considerations
How to deploy a specific API Iteration
If you want to deploy a specific API Iteration, which I recommend you do, then you have two options:
- If your deploy workflow is not running the ImportAPI step then I recommend you save the output API Iteration from ExportAPI to a file during the build workflow. You can then read that file in during deploy. Check out these build/deploy workflows:
- If you deploy workflow does have the import step prior to deployment then you can simply use the output returned from that step.
Settings the API Status Input
Try setting this based on the FD_ENVIRONMENT_CODE. Switch it to an expression and use something like the following:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
if (FD_ENVIRONMENT_CODE.equals('TEST')){ 'ALPHA' } else if (FD_ENVIRONMENT_CODE.equals('PROD')){ 'RELEASED' } else 'BETA' |
Finding the Gateway Id environment instance property