This operation builds api specification file(s) from a SCM repository and validates the file contents. The apiBuild operation can only be used with a FlexDeploy package-based deployment project of type Oracle Api Gateway.
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.
Oracle API Gateway Account
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.
The OCI compartment used to validate the api specification. Useful if you build from a different compartment per environment.
If Add Tags is enabled, and these tags do not exist, FlexDeploy will automatically create the tag namespace (FlexDeploy) and the tags within it.
This operation produces artifacts that will be stored in the artifacts repository.
This operation will select all available endpoints associated to the Target.
This operation will execute on any one of the selected endpoints and will be random in the determination of which one.
Artifact file(s) can be .yaml or .json and in 2 formats:
Openapi 3.x - In this case, the file(s) are validated by OCI SDK. This means for each api specification an api on OCI is created or updated with the contents of the api specification artifact file. The display name of the api on OCI is set to display name attribute on the file. If that is not set, then FlexDeploy will auto generate an api display name for you in the format fd-apigateway-<FILE_NAME>