Skip to content

Commit d7b3580

Browse files
Update Python SDK (#101)
[bot](2025-12-09 12:07:33) Sync SDK with OpenAPI spec Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 355d9e6 commit d7b3580

30 files changed

Lines changed: 1010 additions & 14 deletions

.openapi-generator/FILES

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -847,6 +847,7 @@ docs/PaginateParam.md
847847
docs/ParamsIndexBackup.md
848848
docs/ParamsIndexBackupList.md
849849
docs/ParamsIndexList.md
850+
docs/PurlBatchVulnFinding.md
850851
docs/PurlPackageURLJSON.md
851852
docs/PurlQualifierJSON.md
852853
docs/PurlsPurlResponse.md
@@ -1312,9 +1313,11 @@ docs/RenderResponseWithMetadataArrayPurlsPurlResponsePaginatePagination.md
13121313
docs/RenderResponseWithMetadataArrayStringV3controllersResponseMetadata.md
13131314
docs/RenderResponseWithMetadataV3controllersBackupResponseDataV3controllersBackupResponseMetadata.md
13141315
docs/RenderResponseWithMetadataV3controllersPurlResponseDataV3controllersPurlResponseMetadata.md
1316+
docs/RenderResponseWithMetadataV3controllersPurlsResponseDataV3controllersPurlsResponseMetadata.md
13151317
docs/V3controllersBackupResponseMetadata.md
13161318
docs/V3controllersPurlResponseData.md
13171319
docs/V3controllersPurlResponseMetadata.md
1320+
docs/V3controllersPurlsResponseMetadata.md
13181321
docs/V3controllersResponseMetadata.md
13191322
pyproject.toml
13201323
requirements.txt
@@ -2170,6 +2173,7 @@ test/test_paginate_param.py
21702173
test/test_params_index_backup.py
21712174
test/test_params_index_backup_list.py
21722175
test/test_params_index_list.py
2176+
test/test_purl_batch_vuln_finding.py
21732177
test/test_purl_package_urljson.py
21742178
test/test_purl_qualifier_json.py
21752179
test/test_purls_purl_response.py
@@ -2635,9 +2639,11 @@ test/test_render_response_with_metadata_array_purls_purl_response_paginate_pagin
26352639
test/test_render_response_with_metadata_array_string_v3controllers_response_metadata.py
26362640
test/test_render_response_with_metadata_v3controllers_backup_response_data_v3controllers_backup_response_metadata.py
26372641
test/test_render_response_with_metadata_v3controllers_purl_response_data_v3controllers_purl_response_metadata.py
2642+
test/test_render_response_with_metadata_v3controllers_purls_response_data_v3controllers_purls_response_metadata.py
26382643
test/test_v3controllers_backup_response_metadata.py
26392644
test/test_v3controllers_purl_response_data.py
26402645
test/test_v3controllers_purl_response_metadata.py
2646+
test/test_v3controllers_purls_response_metadata.py
26412647
test/test_v3controllers_response_metadata.py
26422648
vulncheck_sdk/__init__.py
26432649
vulncheck_sdk/api/__init__.py
@@ -3494,6 +3500,7 @@ vulncheck_sdk/models/paginate_param.py
34943500
vulncheck_sdk/models/params_index_backup.py
34953501
vulncheck_sdk/models/params_index_backup_list.py
34963502
vulncheck_sdk/models/params_index_list.py
3503+
vulncheck_sdk/models/purl_batch_vuln_finding.py
34973504
vulncheck_sdk/models/purl_package_urljson.py
34983505
vulncheck_sdk/models/purl_qualifier_json.py
34993506
vulncheck_sdk/models/purls_purl_response.py
@@ -3959,9 +3966,11 @@ vulncheck_sdk/models/render_response_with_metadata_array_purls_purl_response_pag
39593966
vulncheck_sdk/models/render_response_with_metadata_array_string_v3controllers_response_metadata.py
39603967
vulncheck_sdk/models/render_response_with_metadata_v3controllers_backup_response_data_v3controllers_backup_response_metadata.py
39613968
vulncheck_sdk/models/render_response_with_metadata_v3controllers_purl_response_data_v3controllers_purl_response_metadata.py
3969+
vulncheck_sdk/models/render_response_with_metadata_v3controllers_purls_response_data_v3controllers_purls_response_metadata.py
39623970
vulncheck_sdk/models/v3controllers_backup_response_metadata.py
39633971
vulncheck_sdk/models/v3controllers_purl_response_data.py
39643972
vulncheck_sdk/models/v3controllers_purl_response_metadata.py
3973+
vulncheck_sdk/models/v3controllers_purls_response_metadata.py
39653974
vulncheck_sdk/models/v3controllers_response_metadata.py
39663975
vulncheck_sdk/py.typed
39673976
vulncheck_sdk/rest.py

docs/AdvisoryAppleAdvisory.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
99
**cve** | **List[str]** | | [optional]
1010
**date_added** | **str** | | [optional]
1111
**name** | **str** | | [optional]
12+
**updated_at** | **str** | | [optional]
1213
**url** | **str** | | [optional]
1314

1415
## Example

docs/AdvisoryFortinetAdvisory.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
1616
**solutions** | **List[str]** | | [optional]
1717
**summary** | **str** | | [optional]
1818
**title** | **str** | | [optional]
19+
**updated_at** | **str** | | [optional]
1920

2021
## Example
2122

docs/EndpointsApi.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Method | HTTP request | Description
1212
[**openapi_get**](EndpointsApi.md#openapi_get) | **GET** /openapi | Return OpenAPI specification
1313
[**pdns_vulncheck_c2_get**](EndpointsApi.md#pdns_vulncheck_c2_get) | **GET** /pdns/vulncheck-c2 | Retrieve a list of C2 Hostnames
1414
[**purl_get**](EndpointsApi.md#purl_get) | **GET** /purl | Request vulnerabilities related to a PURL
15+
[**purls_post**](EndpointsApi.md#purls_post) | **POST** /purls | Request vulnerabilities related to a list of PURLs
1516
[**rules_initial_access_type_get**](EndpointsApi.md#rules_initial_access_type_get) | **GET** /rules/initial-access/{type} | Retrieve set of initial-access detection rules
1617
[**tags_vulncheck_c2_get**](EndpointsApi.md#tags_vulncheck_c2_get) | **GET** /tags/vulncheck-c2 | Retrieve a list of C2 IP addresses
1718

@@ -647,6 +648,87 @@ Name | Type | Description | Notes
647648

648649
[[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)
649650

651+
# **purls_post**
652+
> RenderResponseWithMetadataV3controllersPurlsResponseDataV3controllersPurlsResponseMetadata purls_post(purls)
653+
654+
Request vulnerabilities related to a list of PURLs
655+
656+
Accepts a JSON array of PURLs in the request body and returns a list of vulnerabilities
657+
658+
### Example
659+
660+
* Api Key Authentication (Bearer):
661+
662+
```python
663+
import vulncheck_sdk
664+
from vulncheck_sdk.models.render_response_with_metadata_v3controllers_purls_response_data_v3controllers_purls_response_metadata import RenderResponseWithMetadataV3controllersPurlsResponseDataV3controllersPurlsResponseMetadata
665+
from vulncheck_sdk.rest import ApiException
666+
from pprint import pprint
667+
668+
# Defining the host is optional and defaults to /v3
669+
# See configuration.py for a list of all supported configuration parameters.
670+
configuration = vulncheck_sdk.Configuration(
671+
host = "/v3"
672+
)
673+
674+
# The client must configure the authentication and authorization parameters
675+
# in accordance with the API server security policy.
676+
# Examples for each auth method are provided below, use the example that
677+
# satisfies your auth use case.
678+
679+
# Configure API key authorization: Bearer
680+
configuration.api_key['Bearer'] = os.environ["API_KEY"]
681+
682+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
683+
# configuration.api_key_prefix['Bearer'] = 'Bearer'
684+
685+
# Enter a context with an instance of the API client
686+
with vulncheck_sdk.ApiClient(configuration) as api_client:
687+
# Create an instance of the API class
688+
api_instance = vulncheck_sdk.EndpointsApi(api_client)
689+
purls = ['purls_example'] # List[str] | PURL strings used to identify and locate software packages
690+
691+
try:
692+
# Request vulnerabilities related to a list of PURLs
693+
api_response = api_instance.purls_post(purls)
694+
print("The response of EndpointsApi->purls_post:\n")
695+
pprint(api_response)
696+
except Exception as e:
697+
print("Exception when calling EndpointsApi->purls_post: %s\n" % e)
698+
```
699+
700+
701+
702+
### Parameters
703+
704+
705+
Name | Type | Description | Notes
706+
------------- | ------------- | ------------- | -------------
707+
**purls** | [**List[str]**](str.md)| PURL strings used to identify and locate software packages |
708+
709+
### Return type
710+
711+
[**RenderResponseWithMetadataV3controllersPurlsResponseDataV3controllersPurlsResponseMetadata**](RenderResponseWithMetadataV3controllersPurlsResponseDataV3controllersPurlsResponseMetadata.md)
712+
713+
### Authorization
714+
715+
[Bearer](../README.md#Bearer)
716+
717+
### HTTP request headers
718+
719+
- **Content-Type**: Not defined
720+
- **Accept**: application/json
721+
722+
### HTTP response details
723+
724+
| Status code | Description | Response headers |
725+
|-------------|-------------|------------------|
726+
**200** | OK | - |
727+
**404** | Not Found | - |
728+
**500** | Internal Server Error | - |
729+
730+
[[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)
731+
650732
# **rules_initial_access_type_get**
651733
> str rules_initial_access_type_get(type)
652734

docs/PurlBatchVulnFinding.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# PurlBatchVulnFinding
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**cves** | **List[str]** | list of associated CVE &#39;s | [optional]
9+
**purl** | **str** | the purl, ex. hex/coherence@0.1.2 | [optional]
10+
**purl_struct** | [**PurlPackageURLJSON**](PurlPackageURLJSON.md) | meta-data about the purl | [optional]
11+
**research_attributes** | [**ApiOSSPackageResearchAttributes**](ApiOSSPackageResearchAttributes.md) | | [optional]
12+
**vulnerabilities** | [**List[ApiOSSPackageVulnerability]**](ApiOSSPackageVulnerability.md) | list of associated vulnerabilities | [optional]
13+
14+
## Example
15+
16+
```python
17+
from vulncheck_sdk.models.purl_batch_vuln_finding import PurlBatchVulnFinding
18+
19+
# TODO update the JSON string below
20+
json = "{}"
21+
# create an instance of PurlBatchVulnFinding from a JSON string
22+
purl_batch_vuln_finding_instance = PurlBatchVulnFinding.from_json(json)
23+
# print the JSON string representation of the object
24+
print(PurlBatchVulnFinding.to_json())
25+
26+
# convert the object into a dict
27+
purl_batch_vuln_finding_dict = purl_batch_vuln_finding_instance.to_dict()
28+
# create an instance of PurlBatchVulnFinding from a dict
29+
purl_batch_vuln_finding_from_dict = PurlBatchVulnFinding.from_dict(purl_batch_vuln_finding_dict)
30+
```
31+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
32+
33+
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# RenderResponseWithMetadataV3controllersPurlsResponseDataV3controllersPurlsResponseMetadata
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**benchmark** | **float** | | [optional]
9+
**meta** | [**V3controllersPurlsResponseMetadata**](V3controllersPurlsResponseMetadata.md) | | [optional]
10+
**data** | [**List[PurlBatchVulnFinding]**](PurlBatchVulnFinding.md) | | [optional]
11+
12+
## Example
13+
14+
```python
15+
from vulncheck_sdk.models.render_response_with_metadata_v3controllers_purls_response_data_v3controllers_purls_response_metadata import RenderResponseWithMetadataV3controllersPurlsResponseDataV3controllersPurlsResponseMetadata
16+
17+
# TODO update the JSON string below
18+
json = "{}"
19+
# create an instance of RenderResponseWithMetadataV3controllersPurlsResponseDataV3controllersPurlsResponseMetadata from a JSON string
20+
render_response_with_metadata_v3controllers_purls_response_data_v3controllers_purls_response_metadata_instance = RenderResponseWithMetadataV3controllersPurlsResponseDataV3controllersPurlsResponseMetadata.from_json(json)
21+
# print the JSON string representation of the object
22+
print(RenderResponseWithMetadataV3controllersPurlsResponseDataV3controllersPurlsResponseMetadata.to_json())
23+
24+
# convert the object into a dict
25+
render_response_with_metadata_v3controllers_purls_response_data_v3controllers_purls_response_metadata_dict = render_response_with_metadata_v3controllers_purls_response_data_v3controllers_purls_response_metadata_instance.to_dict()
26+
# create an instance of RenderResponseWithMetadataV3controllersPurlsResponseDataV3controllersPurlsResponseMetadata from a dict
27+
render_response_with_metadata_v3controllers_purls_response_data_v3controllers_purls_response_metadata_from_dict = RenderResponseWithMetadataV3controllersPurlsResponseDataV3controllersPurlsResponseMetadata.from_dict(render_response_with_metadata_v3controllers_purls_response_data_v3controllers_purls_response_metadata_dict)
28+
```
29+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
30+
31+
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# V3controllersPurlsResponseMetadata
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**timestamp** | **str** | time of the transaction | [optional]
9+
**total_documents** | **int** | number of results found | [optional]
10+
11+
## Example
12+
13+
```python
14+
from vulncheck_sdk.models.v3controllers_purls_response_metadata import V3controllersPurlsResponseMetadata
15+
16+
# TODO update the JSON string below
17+
json = "{}"
18+
# create an instance of V3controllersPurlsResponseMetadata from a JSON string
19+
v3controllers_purls_response_metadata_instance = V3controllersPurlsResponseMetadata.from_json(json)
20+
# print the JSON string representation of the object
21+
print(V3controllersPurlsResponseMetadata.to_json())
22+
23+
# convert the object into a dict
24+
v3controllers_purls_response_metadata_dict = v3controllers_purls_response_metadata_instance.to_dict()
25+
# create an instance of V3controllersPurlsResponseMetadata from a dict
26+
v3controllers_purls_response_metadata_from_dict = V3controllersPurlsResponseMetadata.from_dict(v3controllers_purls_response_metadata_dict)
27+
```
28+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
29+
30+

openapi.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "vulncheck_sdk"
3-
version = "0.0.34"
3+
version = "0.0.35"
44
description = "VulnCheck API"
55
authors = [
66
{name = "VulnCheck API Support",email = "support@vulncheck.com"},

python-generator-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@ additionalProperties:
22
projectName: "vulncheck-sdk"
33
packageName: "vulncheck_sdk"
44
packageUrl: "https://github.com/vulncheck-oss/sdk-python/tree/main"
5-
packageVersion: "0.0.34"
5+
packageVersion: "0.0.35"

0 commit comments

Comments
 (0)