importAPI
Imports an API from the FlexDeploy Artifact Repository into Oracle API Platform.
This operation will look for a single file called flexApi.json in the Artifact Repository to use. If no flexApi.json file is found then it will fallback to any file with a .json extension. If an API with the same name and version already exist on the server then that API will be updated otherwise the API will be created. The API Id and API Iteration will be returned as outputs at the end of execution.
Environment/Instance Properties
| 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. |
Project Properties
| Property Name | Property Code | Required | Description |
|---|---|---|---|
| Oracle API Name | FDOAP_API_NAME | Y | Name of the API being managed |
| Oracle API Version | FDOAP_API_VERSION | Y | Version of the API being managed |
| API Entitlements | FDOAP_API_ENTITLEMENTS | N | CSV list of Plan names to entitle the API with during import. If the plan doesn't exist a warning will be logged during execution. This should only be used when multiple API Platform instances are being used. |
Inputs
| Input Name | Input Code | Required | Description |
|---|---|---|---|
Smart Import | FDOAP_INP_SMART_IMPORT | N | Import will only take place if changes are detected in the implementation or publication of the API. This prevents unnecessary API iteration increases. |
| API Grants | FDOAP_INP_API_GRANTS | N | Multiselect list of grants to grant to the group(s) specified in the Grantee Groups input |
| Grantee Groups | FDOAP_INP_GROUPS | N | Groups or Users are required if API Grants are specified. Oracle Paas group to receive API Grants. If multiple then separate with a comma. Group1,Group2 |
| Grantee Users | FDOAP_INP_USERS | N | Groups or Users are required if API Grants are specified. Oracle users to receive API Grants. |
| Update References | FDOAP_INP_UPDATE_REFERENCES | N | Will query target environment for reference ids and replace them before importing.
See ExportAPI Special Considerations for more information on replacing references. |
| Apiary Token @since 5.5.0.3 | FDOAP_INP_APIARY_TOKEN | N | Refresh token for Apiary. If you have apiary documentation linked in any APIs then this should be set. See Generating an Apiary Token below. If the import process detects Apiary Documentation and no Token is set your API import will still succeed but the documentation may not be linked properly and you will see a warning in the logs. |
Outputs
| Output Name | Description |
|---|---|
| FDOAP_OUT_API_ITERATION | The API iteration after importing |
| FDOAP_OUT_API_ID | The API id after importing. If the API already exists it will not change the id. |
Artifacts
This operation consumes artifacts that will be stored in the artifacts repository.
Endpoint Selection
This operation will select all available endpoints associated to the environment/instance.
Endpoint Execution
This operation will execute on any one of the selected endpoints and will be random in the determination of which one.
Generating an Apiary Token
In order for Apiary documentation to be linked adequately in your API you should provide an Apiary Token during import. This token is long living and does not need to be updated.
To generate the token:
- Open https://login.apiary.io/tokens in a browser
- Log in, if prompted
- Click the Generate New Token button
- Copy and paste the generated token into the FlexDeploy Plugin input for Apiary Token
- style