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

     1  # ${docGenStepName}
     2  
     3  ## ${docGenDescription}
     4  
     5  ## Prerequisites
     6  
     7  ## ${docGenParameters}
     8  
     9  ## ${docGenConfiguration}
    10  
    11  ## ${docJenkinsPluginDependencies}
    12  
    13  ## Example
    14  
    15  Example configuration for the use in a `Jenkinsfile`.
    16  
    17  ```groovy
    18  apiProxyUpload script: this
    19  ```
    20  
    21  Example for the use in a YAML configuration file (such as `.pipeline/config.yaml`).
    22  
    23  ```yaml
    24  steps:
    25    <...>
    26    apiProxyUpload:
    27      apimApiServiceKeyCredentialsId: 'MY_API_SERVICE_KEY'
    28      filePath: MY_API_PROXY_ZIP_FILE_PATH
    29  ```