Skip to content

Commit

Permalink
chore(docs): update api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@kannkyo
kannkyo committed Jan 16, 2023
1 parent 373791b commit f9e8fc8
Show file tree
Hide file tree
Showing 39 changed files with 901 additions and 1,599 deletions.
18 changes: 18 additions & 0 deletions docs/apis/CpeMatchOas.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# CpeMatchOas

JSON Schema for NVD CVE Applicability Statement CPE Match API version 2.0

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**results_per_page** | **int** | |
**start_index** | **int** | |
**total_results** | **int** | |
**format** | **str** | |
**version** | **str** | |
**timestamp** | **datetime** | |
**match_strings** | [**[CpeMatchOasMatchStringsInner]**](CpeMatchOasMatchStringsInner.md) | Array of CPE match strings |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


11 changes: 11 additions & 0 deletions docs/apis/CpeMatchOasMatchStringsInner.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# CpeMatchOasMatchStringsInner


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**match_string** | [**CpeMatchOasMatchStringsInnerMatchString**](CpeMatchOasMatchStringsInnerMatchString.md) | |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


22 changes: 22 additions & 0 deletions docs/apis/CpeMatchOasMatchStringsInnerMatchString.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# CpeMatchOasMatchStringsInnerMatchString

CPE match string or range

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**criteria** | **str** | |
**match_criteria_id** | **str** | |
**created** | **datetime** | |
**last_modified** | **datetime** | |
**status** | **str** | |
**version_start_excluding** | **str** | | [optional]
**version_start_including** | **str** | | [optional]
**version_end_excluding** | **str** | | [optional]
**version_end_including** | **str** | | [optional]
**cpe_last_modified** | **datetime** | | [optional]
**matches** | [**[CpeMatchOasMatchStringsInnerMatchStringMatchesInner]**](CpeMatchOasMatchStringsInnerMatchStringMatchesInner.md) | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


12 changes: 12 additions & 0 deletions docs/apis/CpeMatchOasMatchStringsInnerMatchStringMatchesInner.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# CpeMatchOasMatchStringsInnerMatchStringMatchesInner


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**cpe_name** | **str** | |
**cpe_name_id** | **str** | |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


18 changes: 18 additions & 0 deletions docs/apis/CpeOas.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# CpeOas

JSON Schema for NVD Common Product Enumeration (CPE) API version 2.0

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**results_per_page** | **int** | |
**start_index** | **int** | |
**total_results** | **int** | |
**format** | **str** | |
**version** | **str** | |
**timestamp** | **datetime** | |
**products** | [**[CpeOasProductsInner]**](CpeOasProductsInner.md) | NVD feed array of CPE |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


11 changes: 11 additions & 0 deletions docs/apis/CpeOasProductsInner.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# CpeOasProductsInner


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**cpe** | [**CpeOasProductsInnerCpe**](CpeOasProductsInnerCpe.md) | |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


18 changes: 18 additions & 0 deletions docs/apis/CpeOasProductsInnerCpe.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# CpeOasProductsInnerCpe


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**deprecated** | **bool** | |
**cpe_name** | **str** | |
**cpe_name_id** | **str** | |
**created** | **datetime** | |
**last_modified** | **datetime** | |
**titles** | [**[CpeOasProductsInnerCpeTitlesInner]**](CpeOasProductsInnerCpeTitlesInner.md) | | [optional]
**refs** | [**[CpeOasProductsInnerCpeRefsInner]**](CpeOasProductsInnerCpeRefsInner.md) | | [optional]
**deprecated_by** | [**[CpeOasProductsInnerCpeDeprecatedByInner]**](CpeOasProductsInnerCpeDeprecatedByInner.md) | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


13 changes: 13 additions & 0 deletions docs/apis/CpeOasProductsInnerCpeDeprecatedByInner.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# CpeOasProductsInnerCpeDeprecatedByInner


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**cpe_name** | **str** | | [optional]
**cpe_name_id** | **str** | | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


13 changes: 13 additions & 0 deletions docs/apis/CpeOasProductsInnerCpeRefsInner.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# CpeOasProductsInnerCpeRefsInner

Internet resource for CPE

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ref** | **str** | |
**type** | **str** | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


13 changes: 13 additions & 0 deletions docs/apis/CpeOasProductsInnerCpeTitlesInner.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# CpeOasProductsInnerCpeTitlesInner

Human readable title for CPE

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**title** | **str** | |
**lang** | **str** | |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


19 changes: 19 additions & 0 deletions docs/apis/CveHistoryOas.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# CveHistoryOas

JSON Schema for NVD CVE History API version 2.0

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**results_per_page** | **int** | |
**start_index** | **int** | |
**total_results** | **int** | |
**format** | **str** | |
**version** | **str** | |
**timestamp** | **datetime** | |
**cve_changes** | [**[CveHistoryOasCveChangesInner]**](CveHistoryOasCveChangesInner.md) | Array of CVE Changes | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


11 changes: 11 additions & 0 deletions docs/apis/CveHistoryOasCveChangesInner.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# CveHistoryOasCveChangesInner


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**change** | [**CveHistoryOasCveChangesInnerChange**](CveHistoryOasCveChangesInnerChange.md) | |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


16 changes: 16 additions & 0 deletions docs/apis/CveHistoryOasCveChangesInnerChange.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# CveHistoryOasCveChangesInnerChange


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**cve_id** | **str** | |
**event_name** | **str** | |
**cve_change_id** | **str** | |
**source_identifier** | **str** | |
**created** | **datetime** | | [optional]
**details** | [**[CveHistoryOasCveChangesInnerChangeDetailsInner]**](CveHistoryOasCveChangesInnerChangeDetailsInner.md) | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


14 changes: 14 additions & 0 deletions docs/apis/CveHistoryOasCveChangesInnerChangeDetailsInner.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# CveHistoryOasCveChangesInnerChangeDetailsInner


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **str** | |
**action** | **str** | | [optional]
**old_value** | **str** | | [optional]
**new_value** | **str** | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


18 changes: 18 additions & 0 deletions docs/apis/CveOas.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# CveOas

JSON Schema for NVD Vulnerability Data API version 2.0

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**results_per_page** | **int** | |
**start_index** | **int** | |
**total_results** | **int** | |
**format** | **str** | |
**version** | **str** | |
**timestamp** | **datetime** | |
**vulnerabilities** | [**[CveOasVulnerabilitiesInner]**](CveOasVulnerabilitiesInner.md) | NVD feed array of CVE |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


11 changes: 11 additions & 0 deletions docs/apis/CveOasVulnerabilitiesInner.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# CveOasVulnerabilitiesInner


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**cve** | [**CveOasVulnerabilitiesInnerCve**](CveOasVulnerabilitiesInnerCve.md) | |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


28 changes: 28 additions & 0 deletions docs/apis/CveOasVulnerabilitiesInnerCve.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# CveOasVulnerabilitiesInnerCve


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**descriptions** | [**[CveOasVulnerabilitiesInnerCveDescriptionsInner]**](CveOasVulnerabilitiesInnerCveDescriptionsInner.md) | |
**references** | [**[CveOasVulnerabilitiesInnerCveReferencesInner]**](CveOasVulnerabilitiesInnerCveReferencesInner.md) | |
**id** | **str** | | [optional]
**source_identifier** | **str** | | [optional]
**vuln_status** | **str** | | [optional]
**published** | **datetime** | | [optional]
**last_modified** | **datetime** | | [optional]
**evaluator_comment** | **str** | | [optional]
**evaluator_solution** | **str** | | [optional]
**evaluator_impact** | **str** | | [optional]
**cisa_exploit_add** | **date** | | [optional]
**cisa_action_due** | **date** | | [optional]
**cisa_required_action** | **str** | | [optional]
**cisa_vulnerability_name** | **str** | | [optional]
**metrics** | [**CveOasVulnerabilitiesInnerCveMetrics**](CveOasVulnerabilitiesInnerCveMetrics.md) | | [optional]
**weaknesses** | [**[CveOasVulnerabilitiesInnerCveWeaknessesInner]**](CveOasVulnerabilitiesInnerCveWeaknessesInner.md) | | [optional]
**configurations** | [**[CveOasVulnerabilitiesInnerCveConfigurationsInner]**](CveOasVulnerabilitiesInnerCveConfigurationsInner.md) | | [optional]
**vendor_comments** | [**[CveOasVulnerabilitiesInnerCveVendorCommentsInner]**](CveOasVulnerabilitiesInnerCveVendorCommentsInner.md) | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


13 changes: 13 additions & 0 deletions docs/apis/CveOasVulnerabilitiesInnerCveConfigurationsInner.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# CveOasVulnerabilitiesInnerCveConfigurationsInner


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**nodes** | [**[CveOasVulnerabilitiesInnerCveConfigurationsInnerNodesInner]**](CveOasVulnerabilitiesInnerCveConfigurationsInnerNodesInner.md) | |
**operator** | **str** | | [optional]
**negate** | **bool** | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


14 changes: 14 additions & 0 deletions docs/apis/CveOasVulnerabilitiesInnerCveConfigurationsInnerNodesInner.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# CveOasVulnerabilitiesInnerCveConfigurationsInnerNodesInner

Defines a configuration node in an NVD applicability statement.

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**operator** | **str** | |
**cpe_match** | [**[CveOasVulnerabilitiesInnerCveConfigurationsInnerNodesInnerCpeMatchInner]**](CveOasVulnerabilitiesInnerCveConfigurationsInnerNodesInnerCpeMatchInner.md) | |
**negate** | **bool** | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


18 changes: 18 additions & 0 deletions ...apis/CveOasVulnerabilitiesInnerCveConfigurationsInnerNodesInnerCpeMatchInner.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# CveOasVulnerabilitiesInnerCveConfigurationsInnerNodesInnerCpeMatchInner

CPE match string or range

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**vulnerable** | **bool** | |
**criteria** | **str** | |
**match_criteria_id** | **str** | |
**version_start_excluding** | **str** | | [optional]
**version_start_including** | **str** | | [optional]
**version_end_excluding** | **str** | | [optional]
**version_end_including** | **str** | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


12 changes: 12 additions & 0 deletions docs/apis/CveOasVulnerabilitiesInnerCveDescriptionsInner.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# CveOasVulnerabilitiesInnerCveDescriptionsInner


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**lang** | **str** | |
**value** | **str** | |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


14 changes: 14 additions & 0 deletions docs/apis/CveOasVulnerabilitiesInnerCveMetrics.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# CveOasVulnerabilitiesInnerCveMetrics

Metric scores for a vulnerability as found on NVD.

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**cvss_metric_v31** | [**[CveOasVulnerabilitiesInnerCveMetricsCvssMetricV31Inner]**](CveOasVulnerabilitiesInnerCveMetricsCvssMetricV31Inner.md) | CVSS V3.1 score. | [optional]
**cvss_metric_v30** | [**[CveOasVulnerabilitiesInnerCveMetricsCvssMetricV30Inner]**](CveOasVulnerabilitiesInnerCveMetricsCvssMetricV30Inner.md) | CVSS V3.0 score. | [optional]
**cvss_metric_v2** | [**[CveOasVulnerabilitiesInnerCveMetricsCvssMetricV2Inner]**](CveOasVulnerabilitiesInnerCveMetricsCvssMetricV2Inner.md) | CVSS V2.0 score. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


21 changes: 21 additions & 0 deletions docs/apis/CveOasVulnerabilitiesInnerCveMetricsCvssMetricV2Inner.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# CveOasVulnerabilitiesInnerCveMetricsCvssMetricV2Inner


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**source** | **str** | |
**type** | **str** | |
**cvss_data** | [**JSONSchemaForCommonVulnerabilityScoringSystemVersion20**](JSONSchemaForCommonVulnerabilityScoringSystemVersion20.md) | |
**base_severity** | **str** | | [optional]
**exploitability_score** | **float** | CVSS subscore. | [optional]
**impact_score** | **float** | CVSS subscore. | [optional]
**ac_insuf_info** | **bool** | | [optional]
**obtain_all_privilege** | **bool** | | [optional]
**obtain_user_privilege** | **bool** | | [optional]
**obtain_other_privilege** | **bool** | | [optional]
**user_interaction_required** | **bool** | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


15 changes: 15 additions & 0 deletions docs/apis/CveOasVulnerabilitiesInnerCveMetricsCvssMetricV30Inner.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# CveOasVulnerabilitiesInnerCveMetricsCvssMetricV30Inner


## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**source** | **str** | |
**type** | **str** | |
**cvss_data** | [**JSONSchemaForCommonVulnerabilityScoringSystemVersion30**](JSONSchemaForCommonVulnerabilityScoringSystemVersion30.md) | |
**exploitability_score** | **float** | CVSS subscore. | [optional]
**impact_score** | **float** | CVSS subscore. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


Loading

0 comments on commit f9e8fc8

Please sign in to comment.