Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Bring the VulnCheck API to your Python applications.
- [Indices](#indices)
- [Pagination](#pagination)
- [PURL](#purl)
- [Proxy Support](#proxy-support)
- [Contributing](#contributing)
- [Security](#security)
- [Sponsorship](#sponsorship)
Expand Down Expand Up @@ -787,6 +788,35 @@ if __name__ == "__main__":

</details>

## Proxy Support

The SDK supports the standard proxy environment variables.

- `HTTPS_PROXY` / `https_proxy` - the proxy to use, matched against the API's `https` scheme
- `ALL_PROXY` / `all_proxy` - used when no scheme-specific variable is set
- `NO_PROXY` / `no_proxy` - comma-separated hosts to bypass: an exact host, a
`.suffix`, a CIDR range, or `*` for everything

If you have a proxy configured for other tooling and don't want VulnCheck
traffic going through it, exempt the API host:

```python
configuration = vulncheck_sdk.Configuration(no_proxy="api.vulncheck.com")
```

A proxy can also be set explicitly:

```python
configuration = vulncheck_sdk.Configuration(proxy="http://proxy:3128")
```

Or disabled entirely:

```python
configuration = vulncheck_sdk.Configuration()
configuration.proxy = None # note: Configuration(proxy=None) will not work
```

## Contributing

Please see [CONTRIBUTING](./.github/CONTRIBUTING.md) for details.
Expand Down
30 changes: 30 additions & 0 deletions README.template
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Bring the VulnCheck API to your Python applications.
- [Indices](#indices)
- [Pagination](#pagination)
- [PURL](#purl)
- [Proxy Support](#proxy-support)
- [Contributing](#contributing)
- [Security](#security)
- [Sponsorship](#sponsorship)
Expand Down Expand Up @@ -242,6 +243,35 @@ with open("./tests/purl_aio.py", 'r') as f:

</details>

## Proxy Support

The SDK supports the standard proxy environment variables.

- `HTTPS_PROXY` / `https_proxy` - the proxy to use, matched against the API's `https` scheme
- `ALL_PROXY` / `all_proxy` - used when no scheme-specific variable is set
- `NO_PROXY` / `no_proxy` - comma-separated hosts to bypass: an exact host, a
`.suffix`, a CIDR range, or `*` for everything

If you have a proxy configured for other tooling and don't want VulnCheck
traffic going through it, exempt the API host:

```python
configuration = vulncheck_sdk.Configuration(no_proxy="api.vulncheck.com")
```

A proxy can also be set explicitly:

```python
configuration = vulncheck_sdk.Configuration(proxy="http://proxy:3128")
```

Or disabled entirely:

```python
configuration = vulncheck_sdk.Configuration()
configuration.proxy = None # note: Configuration(proxy=None) will not work
```

## Contributing

Please see [CONTRIBUTING](./.github/CONTRIBUTING.md) for details.
Expand Down
4 changes: 2 additions & 2 deletions docs/AdvisoryAffected.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ advisory.Affected

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**database_specific** | **object** | | [optional]
**ecosystem_specific** | **object** | | [optional]
**database_specific** | **object** | The meaning of the values within the object is entirely defined by the database | [optional]
**ecosystem_specific** | **object** | The meaning of the values within the object is entirely defined by the ecosystem | [optional]
**package** | [**AdvisoryOSVPackage**](AdvisoryOSVPackage.md) | | [optional]
**ranges** | [**List[AdvisoryRange]**](AdvisoryRange.md) | | [optional]
**severity** | [**List[AdvisorySeverity]**](AdvisorySeverity.md) | | [optional]
Expand Down
4 changes: 2 additions & 2 deletions docs/AdvisoryCycle.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Name | Type | Description | Notes
**codename** | **str** | | [optional]
**cycle** | **str** | | [optional]
**discontinued** | **object** | | [optional]
**eol** | **object** | | [optional]
**eol** | **object** | this Eol field is typically assigned either a boolean value, when the date is not known, or a date string when it is. | [optional]
**eol_date** | **str** | | [optional]
**extended_support** | **object** | | [optional]
**extended_support** | **object** | these interface fields are likewise assigned either true, false, or a datestring in the format \&quot;2006-01-02\&quot; | [optional]
**is_eol** | **bool** | | [optional]
**latest** | **str** | | [optional]
**latest_release_date** | **str** | | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/AdvisoryLolAdvs.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Name | Type | Description | Notes
**date_added** | **str** | | [optional]
**description** | **str** | | [optional]
**id** | **str** | | [optional]
**lol_json** | **Dict[str, object]** | | [optional]
**lol_json** | **Dict[str, Optional[object]]** | | [optional]
**mitre_id** | **str** | | [optional]
**references** | **List[str]** | | [optional]
**updated_at** | **str** | | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/AdvisoryProduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | | [optional]
**product_id** | **str** | | [optional]
**product_identification_helper** | **Dict[str, object]** | advisory.IdentificationHelper | [optional]
**product_identification_helper** | **Dict[str, Optional[object]]** | advisory.IdentificationHelper | [optional]

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/AdvisorySigmaRuleRule.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Name | Type | Description | Notes
**author** | **str** | | [optional]
**var_date** | **str** | | [optional]
**description** | **str** | | [optional]
**detection** | **Dict[str, object]** | | [optional]
**detection** | **Dict[str, Optional[object]]** | | [optional]
**false_positives** | **List[str]** | | [optional]
**fields** | **List[str]** | | [optional]
**id** | **str** | | [optional]
Expand Down
4 changes: 2 additions & 2 deletions docs/EndpointsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -415,7 +415,7 @@ This endpoint does not need any parameter.
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **openapi_get**
> Dict[str, object] openapi_get()
> Dict[str, Optional[object]] openapi_get()

Return OpenAPI specification

Expand Down Expand Up @@ -469,7 +469,7 @@ This endpoint does not need any parameter.

### Return type

**Dict[str, object]**
**Dict[str, Optional[object]]**

### Authorization

Expand Down
Loading