github.com/jaylevin/jenkins-library@v1.230.4/documentation/docs/steps/apiProviderDownload.md (about)

     1  # ${docGenStepName}
     2  
     3  ## ${docGenDescription}
     4  
     5  * API Provider defines the connection details for services running on specific hosts.
     6  * This function returns the APIProvider entity and stores it in the file system.
     7  
     8  ## Prerequisites
     9  
    10  API Provider artifact to be downloaded should exist in the API Portal.
    11  
    12  ## ${docGenParameters}
    13  
    14  ## ${docGenConfiguration}
    15  
    16  ## ${docJenkinsPluginDependencies}
    17  
    18  ## Example
    19  
    20  Example configuration for the use in a `Jenkinsfile`.
    21  
    22  ```groovy
    23  apiProviderDownload script: this
    24  ```
    25  
    26  Example for the use in a YAML configuration file (such as `.pipeline/config.yaml`).
    27  
    28  ```yaml
    29  steps:
    30    <...>
    31    apiProviderDownload:
    32      apimApiServiceKeyCredentialsId: 'MY_API_SERVICE_KEY'
    33      apiProviderName: 'MY_API_PROVIDER_NAME'
    34      downloadPath: MY_API_PROVIDER_JSON_FILE_DOWNLOAD_PATH
    35  ```