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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .sdk-version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v4.5.0
v4.13.0
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,8 +151,6 @@ Class | Method | HTTP request | Description
*ExternalSourcesApi* | [**create_external_task_vt**](docs/ExternalSourcesApi.md#create_external_task_vt) | **POST** /v2/analysis/{analysis_id}/external/vt | Pulls data from VirusTotal
*ExternalSourcesApi* | [**get_vt_data**](docs/ExternalSourcesApi.md#get_vt_data) | **GET** /v2/analysis/{analysis_id}/external/vt | Get VirusTotal data
*ExternalSourcesApi* | [**get_vt_task_status**](docs/ExternalSourcesApi.md#get_vt_task_status) | **GET** /v2/analysis/{analysis_id}/external/vt/status | Check the status of VirusTotal data retrieval
*FirmwareApi* | [**get_binaries_for_firmware_task**](docs/FirmwareApi.md#get_binaries_for_firmware_task) | **GET** /v2/firmware/get-binaries/{task_id} | Upload firmware for unpacking
*FirmwareApi* | [**upload_firmware**](docs/FirmwareApi.md#upload_firmware) | **POST** /v2/firmware | Upload firmware for unpacking
*FunctionsAIDecompilationApi* | [**create_ai_decompilation**](docs/FunctionsAIDecompilationApi.md#create_ai_decompilation) | **POST** /v3/functions/{function_id}/ai-decompilation | Start AI decompilation
*FunctionsAIDecompilationApi* | [**delete_ai_decompilation_inline_comment**](docs/FunctionsAIDecompilationApi.md#delete_ai_decompilation_inline_comment) | **DELETE** /v3/functions/{function_id}/ai-decompilation/inline-comments/{line} | Delete a single inline comment
*FunctionsAIDecompilationApi* | [**get_ai_decompilation**](docs/FunctionsAIDecompilationApi.md#get_ai_decompilation) | **GET** /v3/functions/{function_id}/ai-decompilation | Get AI decompilation result
Expand Down Expand Up @@ -650,6 +648,7 @@ Class | Method | HTTP request | Description
- [ScheduledTaskEntry](docs/ScheduledTaskEntry.md)
- [ScrapeThirdPartyConfig](docs/ScrapeThirdPartyConfig.md)
- [SectionModel](docs/SectionModel.md)
- [SecurityFinding](docs/SecurityFinding.md)
- [SecurityModel](docs/SecurityModel.md)
- [SecurityScanMetadata](docs/SecurityScanMetadata.md)
- [SecurityScanResult](docs/SecurityScanResult.md)
Expand Down
183 changes: 0 additions & 183 deletions docs/FirmwareApi.md

This file was deleted.

5 changes: 5 additions & 0 deletions docs/GetMatchesStatusOutputBody.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,15 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**messages** | [**List[ProgressMessage]**](ProgressMessage.md) | Log messages emitted during execution |
**percent** | **int** | Overall completion as a percentage, weighted by step duration |
**status** | **str** | Current workflow status |
**step** | **str** | Name of the current step |
**step_index** | **int** | Zero-based index of the current step |
**step_share** | **int** | Percentage points the current step contributes when it completes |
**steps_total** | **int** | Total number of steps in the workflow |
**sub_step** | **str** | Phase within the current step, when the step reports one | [optional]
**sub_step_done** | **int** | Items completed in the current phase | [optional]
**sub_step_total** | **int** | Items the current phase will process, 0 when unknown | [optional]

## Example

Expand Down
40 changes: 40 additions & 0 deletions docs/SecurityFinding.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# SecurityFinding


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**check_id** | **str** | Semgrep rule ID that matched | [optional]
**confidence** | **str** | Semgrep's confidence in the finding | [optional]
**cwe** | **List[str]** | CWE identifiers associated with the finding | [optional]
**end_line** | **int** | Line the finding ends on | [optional]
**function_id** | **int** | ID of the function the finding was reported in | [optional]
**function_name** | **str** | Name of the function the finding was reported in | [optional]
**impact** | **str** | Estimated impact of the finding | [optional]
**message** | **str** | Human-readable description of the finding | [optional]
**severity** | **str** | Severity of the finding | [optional]
**snippet_lines** | **List[str]** | Source lines making up the reported snippet | [optional]
**snippet_start_line** | **int** | Line the reported snippet starts on | [optional]
**start_line** | **int** | Line the finding starts on | [optional]

## Example

```python
from revengai.models.security_finding import SecurityFinding

# TODO update the JSON string below
json = "{}"
# create an instance of SecurityFinding from a JSON string
security_finding_instance = SecurityFinding.from_json(json)
# print the JSON string representation of the object
print(SecurityFinding.to_json())

# convert the object into a dict
security_finding_dict = security_finding_instance.to_dict()
# create an instance of SecurityFinding from a dict
security_finding_from_dict = SecurityFinding.from_dict(security_finding_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


3 changes: 1 addition & 2 deletions docs/SecurityScanResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ Name | Type | Description | Notes
**cancelled** | **bool** | Whether the run was cancelled before it covered every function |
**decompiled** | **int** | Functions successfully decompiled and scanned |
**failed** | **int** | Functions whose decompilation or scan attempt errored |
**security_scan** | **Dict[str, object]** | Raw semgrep findings, keyed by the scanner's own result shape | [optional]
**source** | **str** | Decompiler that produced the source scanned |
**security_scan** | [**List[SecurityFinding]**](SecurityFinding.md) | Shaped semgrep findings, one per result | [optional]
**total** | **int** | Functions the run considered |

## Example
Expand Down
1 change: 1 addition & 0 deletions docs/StartBatchMatchingInputBody.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Name | Type | Description | Notes
**binary_ids** | **List[int]** | Binary IDs to match the analysis against, one workflow per binary. |
**debug_types** | **List[Optional[str]]** | Restrict matches to candidates with these debug source types. Defaults to [\"SYSTEM\"]. | [optional]
**min_similarity** | **float** | Similarity floor as a percentage. Defaults to 90. | [optional]
**no_cache** | **bool** | By default a completed matching run is reused per binary (that binary reports status=COMPLETED, no new run). Set true to force fresh runs for every binary. | [optional]
**results_per_function** | **int** | Max matches returned per source function. Defaults to 1. | [optional]

## Example
Expand Down
5 changes: 5 additions & 0 deletions docs/StartMatchingOutputBody.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,15 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**match_id** | **str** | Opaque token for this matching run. Pass it to the GET/status endpoints' match_id query parameter to fetch this exact run. |
**messages** | [**List[ProgressMessage]**](ProgressMessage.md) | Log messages emitted during execution |
**percent** | **int** | Overall completion as a percentage, weighted by step duration |
**status** | **str** | Current workflow status |
**step** | **str** | Name of the current step |
**step_index** | **int** | Zero-based index of the current step |
**step_share** | **int** | Percentage points the current step contributes when it completes |
**steps_total** | **int** | Total number of steps in the workflow |
**sub_step** | **str** | Phase within the current step, when the step reports one | [optional]
**sub_step_done** | **int** | Items completed in the current phase | [optional]
**sub_step_total** | **int** | Items the current phase will process, 0 when unknown | [optional]

## Example

Expand Down
1 change: 1 addition & 0 deletions docs/SummaryData.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ai_summary** | **str** | Summary with code tags removed |
**predicted_function_name** | **str** | Name the model proposes for this function, produced alongside the summary. | [optional]
**summary** | **str** | Raw summary from the model |
**task_status** | **str** | Task status |

Expand Down
5 changes: 5 additions & 0 deletions docs/WorkflowProgress.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,15 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**messages** | [**List[ProgressMessage]**](ProgressMessage.md) | Log messages emitted during execution |
**percent** | **int** | Overall completion as a percentage, weighted by step duration |
**status** | **str** | Current workflow status |
**step** | **str** | Name of the current step |
**step_index** | **int** | Zero-based index of the current step |
**step_share** | **int** | Percentage points the current step contributes when it completes |
**steps_total** | **int** | Total number of steps in the workflow |
**sub_step** | **str** | Phase within the current step, when the step reports one | [optional]
**sub_step_done** | **int** | Items completed in the current phase | [optional]
**sub_step_total** | **int** | Items the current phase will process, 0 when unknown | [optional]

## Example

Expand Down
6 changes: 3 additions & 3 deletions revengai/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
""" # noqa: E501


__version__ = "v4.5.0"
__version__ = "v4.13.0"

# Define package exports
__all__ = [
Expand All @@ -30,7 +30,6 @@
"ConversationsApi",
"DataTypesApi",
"ExternalSourcesApi",
"FirmwareApi",
"FunctionsAIDecompilationApi",
"FunctionsCoreApi",
"FunctionsRenamingHistoryApi",
Expand Down Expand Up @@ -481,6 +480,7 @@
"ScheduledTaskEntry",
"ScrapeThirdPartyConfig",
"SectionModel",
"SecurityFinding",
"SecurityModel",
"SecurityScanMetadata",
"SecurityScanResult",
Expand Down Expand Up @@ -614,7 +614,6 @@
from revengai.api.conversations_api import ConversationsApi as ConversationsApi
from revengai.api.data_types_api import DataTypesApi as DataTypesApi
from revengai.api.external_sources_api import ExternalSourcesApi as ExternalSourcesApi
from revengai.api.firmware_api import FirmwareApi as FirmwareApi
from revengai.api.functions_ai_decompilation_api import FunctionsAIDecompilationApi as FunctionsAIDecompilationApi
from revengai.api.functions_core_api import FunctionsCoreApi as FunctionsCoreApi
from revengai.api.functions_renaming_history_api import FunctionsRenamingHistoryApi as FunctionsRenamingHistoryApi
Expand Down Expand Up @@ -1069,6 +1068,7 @@
from revengai.models.scheduled_task_entry import ScheduledTaskEntry as ScheduledTaskEntry
from revengai.models.scrape_third_party_config import ScrapeThirdPartyConfig as ScrapeThirdPartyConfig
from revengai.models.section_model import SectionModel as SectionModel
from revengai.models.security_finding import SecurityFinding as SecurityFinding
from revengai.models.security_model import SecurityModel as SecurityModel
from revengai.models.security_scan_metadata import SecurityScanMetadata as SecurityScanMetadata
from revengai.models.security_scan_result import SecurityScanResult as SecurityScanResult
Expand Down
1 change: 0 additions & 1 deletion revengai/api/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
from revengai.api.conversations_api import ConversationsApi
from revengai.api.data_types_api import DataTypesApi
from revengai.api.external_sources_api import ExternalSourcesApi
from revengai.api.firmware_api import FirmwareApi
from revengai.api.functions_ai_decompilation_api import FunctionsAIDecompilationApi
from revengai.api.functions_core_api import FunctionsCoreApi
from revengai.api.functions_renaming_history_api import FunctionsRenamingHistoryApi
Expand Down
Loading