github.com/jaylevin/jenkins-library@v1.230.4/resources/metadata/apiProviderDownload.yaml (about)

     1  metadata:
     2    name: apiProviderDownload
     3    description: Download a specific API Provider from the API Portal
     4    longDescription: |
     5      With this step you can download a specific API Provider from the API Portal, which returns a JSON file with the api provider contents in to current workspace using the OData API. Learn more about the SAP API Management API for downloading an api provider artifact [here](https://api.sap.com/api/APIPortal_CF/overview).
     6  
     7  spec:
     8    inputs:
     9      secrets:
    10        - name: apimApiServiceKeyCredentialsId
    11          description: Jenkins secret text credential ID containing the service key to the API Management Runtime service instance of plan 'api'
    12          type: jenkins
    13      params:
    14        - name: apiServiceKey
    15          type: string
    16          description: Service key JSON string to access the API Management Runtime service instance of plan 'api'
    17          scope:
    18            - PARAMETERS
    19          mandatory: true
    20          secret: true
    21          resourceRef:
    22            - name: apimApiServiceKeyCredentialsId
    23              type: secret
    24              param: apiServiceKey
    25        - name: apiProviderName
    26          type: string
    27          description: Specifies the name of the API Provider.
    28          scope:
    29            - PARAMETERS
    30            - STAGES
    31            - STEPS
    32          mandatory: true
    33        - name: downloadPath
    34          type: string
    35          description: Specifies api provider download directory location. The file name must not be included in the path.
    36          scope:
    37            - PARAMETERS
    38            - STAGES
    39            - STEPS
    40          mandatory: true