metadata:
  name: apiProxyDownload
  description: Download a specific API Proxy from the API Portal
  longDescription: |
    With this step you can download a specific API Proxy from the API Portal, which returns a zip file with the api proxy contents in to current workspace using the OData API. Learn more about the SAP API Management API for downloading an api proxy artifact [here](https://help.sap.com/viewer/66d066d903c2473f81ec33acfe2ccdb4/Cloud/en-US/e26b3320cd534ae4bc743af8013a8abb.html).

spec:
  inputs:
    secrets:
      - name: apimApiServiceKeyCredentialsId
        description: Jenkins secret text credential ID containing the service key to the API Management Runtime service instance of plan 'api'
        type: jenkins
    params:
      - name: apiServiceKey
        type: string
        description: Service key JSON string to access the API Management Runtime service instance of plan 'api'
        scope:
          - PARAMETERS
        mandatory: true
        secret: true
        resourceRef:
          - name: apimApiServiceKeyCredentialsId
            type: secret
            param: apiServiceKey
      - name: apiProxyName
        type: string
        description: Specifies the name of the API Proxy.
        scope:
          - PARAMETERS
          - STAGES
          - STEPS
        mandatory: true
      - name: downloadPath
        type: string
        description: Specifies api proxy download directory location. The file name should not be included in the path.
        scope:
          - PARAMETERS
          - STAGES
          - STEPS
        mandatory: true