mirror of
https://github.com/SAP/jenkins-library.git
synced 2025-04-15 11:56:45 +02:00
31 lines
535 B
Markdown
31 lines
535 B
Markdown
|
# ${docGenStepName}
|
||
|
|
||
|
## ${docGenDescription}
|
||
|
|
||
|
## Prerequisites
|
||
|
|
||
|
## ${docGenParameters}
|
||
|
|
||
|
## ${docGenConfiguration}
|
||
|
|
||
|
## ${docJenkinsPluginDependencies}
|
||
|
|
||
|
## Example
|
||
|
|
||
|
Example configuration for the use in a `Jenkinsfile`.
|
||
|
|
||
|
```groovy
|
||
|
apiProxyDownload script: this
|
||
|
```
|
||
|
|
||
|
Example for the use in a YAML configuration file (such as `.pipeline/config.yaml`).
|
||
|
|
||
|
```yaml
|
||
|
steps:
|
||
|
<...>
|
||
|
apiProxyDownload:
|
||
|
apimApiServiceKeyCredentialsId: 'MY_API_SERVICE_KEY'
|
||
|
apiProxyName: 'MY_API_PROXY_NAME'
|
||
|
downloadPath: MY_API_PROXY_DOWNLOAD_PATH
|
||
|
```
|