| Recipes by Topic | Recipes by Author | Request Enhancement | Report a bug | Fix documentation |
 |
Sunny Kapoor |
|---|
This CICD Jenkins job allows you to checkout the configured API Provider from the source code repository and either update or create the artefact on the API Portal tenant.
Instructions to consume the CICD Jenkins file
Configure the following environment variables before executing the Jenkins Job
| Name | Example | Description |
|---|---|---|
| APIProviderName | "Northwind_APIs" |
The name of the API Provider that needs to be uploaded to the API Portal tenant |
| IsDeleteRequired | "Yes" "No" |
Assign "Yes", in case the artefact has to be deleted from the API Portal before uploading the artefact from Git. Else set it to "No". In case you set it to "No" and if configured API Provider exists on the API portal, then the job will fail |
| APIPortalHost | "${env.API_HOST}" "eu20apiportal.cfapps.eu20.hana.ondemand.com" |
The hostname (without HTTPS) of your API Portal tenant |
| AuthType | "OAuth" "Basic" |
The Authentication Type to be used to connect to the API Portal Tenant. Values can be "OAuth" or "Basic" |
| APIPortalBasicAuth | "${env.API_BasicAuth_CRED}" "API_BasicAuth_Credentials" |
The alias of the Basic credentials for the API Portal tenant which is deployed on your build server (like Jenkins) |
| APIPortalOAuthHost | "${env.API_OAUTH_HOST}" "xxxxxx.authentication.eu20.hana.ondemand.com" |
The hostname (without HTTPS) of the OAuth token server of your API Portal tenant |
| APIPortalOAuthCredentials | ${env.API_OAUTH_CRED}" "API_OAuth_Credentials" |
The alias of the OAuth credentials for the API Portal tenant which is deployed on your build server (like Jenkins) |
| GITRepositoryURL | "${env.GIT_REPOSITORY_URL}" "github.com/CICD/integrations.git" |
The full URL of the source code repository without HTTPS |
| GITCredentials | "${env.GIT_CRED}" "GIT_Credentials" |
The alias of the source code repository credentials which is deployed on your build server (like Jenkins) |
| GITBranch | "${env.GIT_BRANCH_NAME}" "refs/heads/master" |
Specify the source code repository branch that you want to work with |
| GITFolder | "IntegrationContent/API" |
Specify the folder structure in your source code repository from where you like to read the API Provider |