1
0
mirror of https://github.com/SAP/jenkins-library.git synced 2024-12-12 10:55:20 +02:00
sap-jenkins-library/resources/metadata/integrationArtifactDownload.yaml
Oliver Feldmann 9e22251c8d
CPI - Improve serviceKey parameter name and description (#2958)
* Make credential id name more descriptive

* Improve serviceKey description

* Change descriptions to add word service

Co-authored-by: Linda Siebert <linda.siebert@sap.com>
2021-07-01 10:07:57 +02:00

50 lines
1.8 KiB
YAML

metadata:
name: integrationArtifactDownload
description: Download integration flow runtime artefact
longDescription: |
With this step you can download a integration flow runtime artifact, which returns a zip file with the integration flow contents in to current workspace using the OData API. Learn more about the SAP Cloud Integration remote API for downloading an integration flow artifact [here](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/d1679a80543f46509a7329243b595bdb.html).
spec:
inputs:
secrets:
- name: cpiApiServiceKeyCredentialsId
description: Jenkins secret text credential ID containing the service key to the Process Integration Runtime service instance of plan 'api'
type: jenkins
params:
- name: apiServiceKey
type: string
description: Service key JSON string to access the Process Integration Runtime service instance of plan 'api'
scope:
- PARAMETERS
mandatory: true
secret: true
resourceRef:
- name: cpiApiServiceKeyCredentialsId
type: secret
param: apiServiceKey
- name: integrationFlowId
type: string
description: Specifies the ID of the Integration Flow artifact
scope:
- PARAMETERS
- STAGES
- STEPS
mandatory: true
- name: integrationFlowVersion
type: string
description: Specifies the version of the Integration Flow artifact
scope:
- PARAMETERS
- GENERAL
- STAGES
- STEPS
mandatory: true
- name: downloadPath
type: string
description: Specifies integration artifact download location.
scope:
- PARAMETERS
- STAGES
- STEPS
mandatory: true