From daf8c98468cebab3e62575760b6a5f9d9d66689e Mon Sep 17 00:00:00 2001 From: Jeremy Long Date: Sat, 25 Nov 2023 08:53:16 -0500 Subject: [PATCH] docs: add default values to documentation for the NVD API Delay (#6135) --- ant/src/site/markdown/config-update.md | 2 +- ant/src/site/markdown/configuration.md | 2 +- cli/src/site/markdown/arguments.md | 2 +- maven/src/site/markdown/configuration.md | 2 +- .../markdown/dependency-check-gradle/configuration-aggregate.md | 2 +- .../markdown/dependency-check-gradle/configuration-update.md | 2 +- src/site/markdown/dependency-check-gradle/configuration.md | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/ant/src/site/markdown/config-update.md b/ant/src/site/markdown/config-update.md index 3cb7b0d7bdf..b5cc2f76f0d 100644 --- a/ant/src/site/markdown/config-update.md +++ b/ant/src/site/markdown/config-update.md @@ -35,7 +35,7 @@ The following properties can be configured in the plugin. However, they are less Property | Description | Default Value ---------------------|----------------------------------------------------------------------------------------------------------------------|------------------ nvdApiKey | The API Key to access the NVD API; obtained from https://nvd.nist.gov/developers/request-an-api-key |   -nvdApiDelay | The number of milliseconds to wait between calls to the NVD API. |   +nvdApiDelay | The number of milliseconds to wait between calls to the NVD API. | 2000 with an NVD API Key or 8000 without an API Key nvdDatafeedUrl | The URL for the NVD API Data feed that can be generated using https://github.com/jeremylong/Open-Vulnerability-Project/tree/main/vulnz#caching-the-nvd-cve-data - example value `https://internal.server/cache/nvdcve-{0}.json.gz` |   nvdUser | Credentials used for basic authentication for the NVD API Data feed. |   nvdPassword | Credentials used for basic authentication for the NVD API Data feed. |   diff --git a/ant/src/site/markdown/configuration.md b/ant/src/site/markdown/configuration.md index 7910d1d76e9..c399dd33b94 100644 --- a/ant/src/site/markdown/configuration.md +++ b/ant/src/site/markdown/configuration.md @@ -144,7 +144,7 @@ The following properties can be configured in the plugin. However, they are less Property | Description | Default Value ---------------------|--------------------------------------------------------------------------------------------------------------|------------------ nvdApiKey | The API Key to access the NVD API; obtained from https://nvd.nist.gov/developers/request-an-api-key |   -nvdApiDelay | The number of milliseconds to wait between calls to the NVD API. |   +nvdApiDelay | The number of milliseconds to wait between calls to the NVD API. | 2000 with an NVD API Key or 8000 without an API Key nvdDatafeedUrl | The URL for the NVD API Data feed that can be generated using https://github.com/jeremylong/Open-Vulnerability-Project/tree/main/vulnz#caching-the-nvd-cve-data - example value `https://internal.server/cache/nvdcve-{0}.json.gz` |   nvdUser | Credentials used for basic authentication for the NVD API Data feed. |   nvdPassword | Credentials used for basic authentication for the NVD API Data feed. |   diff --git a/cli/src/site/markdown/arguments.md b/cli/src/site/markdown/arguments.md index ffebc003254..b695ad17070 100644 --- a/cli/src/site/markdown/arguments.md +++ b/cli/src/site/markdown/arguments.md @@ -28,7 +28,7 @@ Advanced Options | Short | Argument Name | Parameter | Description | Default Value | |-------|---------------------------------------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| | | \-\-nvdApiKey | \ | The API Key to access the NVD API; obtained from https://nvd.nist.gov/developers/request-an-api-key |   | -| | \-\-nvdApiDelay | \| The number of milliseconds to wait between calls to the NVD API. |   | +| | \-\-nvdApiDelay | \| The number of milliseconds to wait between calls to the NVD API. | 2000 with an NVD API Key or 8000 without an API Key | | | \-\-nvdDatafeed | \ | The URL for the NVD API Data feed that can be generated using https://github.com/jeremylong/Open-Vulnerability-Project/tree/main/vulnz#caching-the-nvd-cve-data - example value `https://internal.server/cache/nvdcve-{0}.json.gz` |   | | | \-\-nvdUser | \ | Credentials used for basic authentication for the NVD API Data feed. |   | | | \-\-nvdPassword | \ | Credentials used for basic authentication for the NVD API Data feed. |   | diff --git a/maven/src/site/markdown/configuration.md b/maven/src/site/markdown/configuration.md index 40ff923a225..b87ae80e5fa 100644 --- a/maven/src/site/markdown/configuration.md +++ b/maven/src/site/markdown/configuration.md @@ -144,7 +144,7 @@ Property | Description -------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------| nvdApiKey | The API Key to access the NVD API; obtained from https://nvd.nist.gov/developers/request-an-api-key |   | nvdApiServerId | The id of a server defined in the settings.xml that configures the credentials (password is used as ApiKey) for accessing the NVD API. |   | -nvdApiDelay | The number of milliseconds to wait between calls to the NVD API. |   | +nvdApiDelay | The number of milliseconds to wait between calls to the NVD API. | 2000 with an NVD API Key or 8000 without an API Key . | nvdDatafeedUrl | The URL for the NVD API Data feed that can be generated using https://github.com/jeremylong/Open-Vulnerability-Project/tree/main/vulnz#caching-the-nvd-cve-data - example value `https://internal.server/cache/nvdcve-{0}.json.gz` |   | nvdDatafeedServerId | The id of a server defined in the settings.xml that configures the credentials (username and password) for accessing the NVD API Data feed.|   | nvdUser | Credentials used for basic authentication for the NVD API Data feed. |   | diff --git a/src/site/markdown/dependency-check-gradle/configuration-aggregate.md b/src/site/markdown/dependency-check-gradle/configuration-aggregate.md index 355377959e4..83b99121787 100644 --- a/src/site/markdown/dependency-check-gradle/configuration-aggregate.md +++ b/src/site/markdown/dependency-check-gradle/configuration-aggregate.md @@ -86,7 +86,7 @@ Note, if ANY of the cve configuration group are set - they should all be set to Config Group | Property | Description | Default Value | -------------|-------------------|--------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------| nvd | apiKey | The API Key to access the NVD API; obtained from https://nvd.nist.gov/developers/request-an-api-key |   | -nvd | delay | The number of milliseconds to wait between calls to the NVD API. |   | +nvd | delay | The number of milliseconds to wait between calls to the NVD API. | 2000 with an NVD API Key or 8000 without an API Key | nvd | datafeedUrl | The URL for the NVD API Data feed that can be generated using https://github.com/jeremylong/Open-Vulnerability-Project/tree/main/vulnz#caching-the-nvd-cve-data |   | nvd | datafeedUser | Credentials used for basic authentication for the NVD API Data feed. |   | nvd | datafeedPassword | Credentials used for basic authentication for the NVD API Data feed. |   | diff --git a/src/site/markdown/dependency-check-gradle/configuration-update.md b/src/site/markdown/dependency-check-gradle/configuration-update.md index 2d88f314a15..4a5630a1bf3 100644 --- a/src/site/markdown/dependency-check-gradle/configuration-update.md +++ b/src/site/markdown/dependency-check-gradle/configuration-update.md @@ -63,7 +63,7 @@ The following properties can be configured in the dependencyCheck task. However, Config Group | Property | Description | Default Value | -------------|-------------------|--------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------| nvd | apiKey | The API Key to access the NVD API; obtained from https://nvd.nist.gov/developers/request-an-api-key |   | -nvd | delay | The number of milliseconds to wait between calls to the NVD API. |   | +nvd | delay | The number of milliseconds to wait between calls to the NVD API. | 2000 with an NVD API Key or 8000 without an API Key . | nvd | datafeedUrl | The URL for the NVD API Data feed that can be generated using https://github.com/jeremylong/Open-Vulnerability-Project/tree/main/vulnz#caching-the-nvd-cve-data |   | nvd | datafeedUser | Credentials used for basic authentication for the NVD API Data feed. |   | nvd | datafeedPassword | Credentials used for basic authentication for the NVD API Data feed. |   | diff --git a/src/site/markdown/dependency-check-gradle/configuration.md b/src/site/markdown/dependency-check-gradle/configuration.md index 6f21fe27194..e660594e4cc 100644 --- a/src/site/markdown/dependency-check-gradle/configuration.md +++ b/src/site/markdown/dependency-check-gradle/configuration.md @@ -68,7 +68,7 @@ The following properties can be configured in the dependencyCheck task. However, Config Group | Property | Description | Default Value -------------|-------------------|----------------------------------------------------------------------------------------------------------------------|------------------ nvd | apiKey | The API Key to access the NVD API; obtained from https://nvd.nist.gov/developers/request-an-api-key |   | -nvd | delay | The number of milliseconds to wait between calls to the NVD API. |   | +nvd | delay | The number of milliseconds to wait between calls to the NVD API. | 2000 with an NVD API Key or 8000 without an API Key | nvd | datafeedUrl | The URL for the NVD API Data feed that can be generated using https://github.com/jeremylong/Open-Vulnerability-Project/tree/main/vulnz#caching-the-nvd-cve-data |   | nvd | datafeedUser | Credentials used for basic authentication for the NVD API Data feed. |   | nvd | datafeedPassword | Credentials used for basic authentication for the NVD API Data feed. |   |