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 @@
v3.74.4
v3.79.0
97 changes: 53 additions & 44 deletions README.md

Large diffs are not rendered by default.

30 changes: 30 additions & 0 deletions docs/APIError.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# APIError


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**var_schema** | **str** | A URL to the JSON Schema for this object. | [optional] [readonly]
**error** | [**ErrorBody**](ErrorBody.md) | |

## Example

```python
from revengai.models.api_error import APIError

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

# convert the object into a dict
api_error_dict = api_error_instance.to_dict()
# create an instance of APIError from a dict
api_error_from_dict = APIError.from_dict(api_error_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)


96 changes: 96 additions & 0 deletions docs/AnalysesApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
# revengai.AnalysesApi

All URIs are relative to *https://api.reveng.ai*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_analysis_queue_position**](AnalysesApi.md#get_analysis_queue_position) | **GET** /v2/analyses/{analysis_id}/queue-position | Get the queue position of an analysis


# **get_analysis_queue_position**
> QueuePositionResponse get_analysis_queue_position(analysis_id)

Get the queue position of an analysis

Returns the number of Processing analyses with a lower analysis_id than the given one. Useful for showing the user where they sit in the processing queue while waiting for their analysis to start.

**Error codes:**
- `404` [`NOT_FOUND`](/errors/NOT_FOUND) — Not Found
- `403` [`ACCESS_DENIED`](/errors/ACCESS_DENIED) — Access Denied

### Example

* Api Key Authentication (APIKey):

```python
import revengai
from revengai.models.queue_position_response import QueuePositionResponse
from revengai.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.reveng.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = revengai.Configuration(
host = "https://api.reveng.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: APIKey
configuration.api_key['APIKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['APIKey'] = 'Bearer'

# Enter a context with an instance of the API client
with revengai.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = revengai.AnalysesApi(api_client)
analysis_id = 56 # int | Analysis ID

try:
# Get the queue position of an analysis
api_response = api_instance.get_analysis_queue_position(analysis_id)
print("The response of AnalysesApi->get_analysis_queue_position:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AnalysesApi->get_analysis_queue_position: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**analysis_id** | **int**| Analysis ID |

### Return type

[**QueuePositionResponse**](QueuePositionResponse.md)

### Authorization

[APIKey](../README.md#APIKey)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | OK | - |
**403** | Forbidden | - |
**404** | Not Found | - |
**422** | Unprocessable Entity | - |
**500** | Internal Server Error | - |

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

6 changes: 3 additions & 3 deletions docs/AnalysesCoreApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -758,7 +758,7 @@ Gets the most recent analyses provided a scope, this is then paginated, if pages
import revengai
from revengai.models.app_api_rest_v2_analyses_enums_order_by import AppApiRestV2AnalysesEnumsOrderBy
from revengai.models.base_response_recent import BaseResponseRecent
from revengai.models.dynamic_execution_status_input import DynamicExecutionStatusInput
from revengai.models.dynamic_execution_status import DynamicExecutionStatus
from revengai.models.model_name import ModelName
from revengai.models.order import Order
from revengai.models.status_input import StatusInput
Expand Down Expand Up @@ -791,7 +791,7 @@ with revengai.ApiClient(configuration) as api_client:
workspace = ["personal"] # List[Workspace] | The workspace to be viewed (optional) (default to ["personal"])
status = ["All"] # List[StatusInput] | The status of the analysis (optional) (default to ["All"])
model_name = [revengai.ModelName()] # List[ModelName] | Show analysis belonging to the model (optional)
dynamic_execution_status = revengai.DynamicExecutionStatusInput() # DynamicExecutionStatusInput | Show analysis that have a dynamic execution with the given status (optional)
dynamic_execution_status = revengai.DynamicExecutionStatus() # DynamicExecutionStatus | Show analysis that have a dynamic execution with the given status (optional)
usernames = [] # List[Optional[str]] | Show analysis belonging to the user (optional) (default to [])
sha256_hash = 'sha256_hash_example' # str | (optional)
limit = 20 # int | (optional) (default to 20)
Expand Down Expand Up @@ -819,7 +819,7 @@ Name | Type | Description | Notes
**workspace** | [**List[Workspace]**](Workspace.md)| The workspace to be viewed | [optional] [default to ["personal"]]
**status** | [**List[StatusInput]**](StatusInput.md)| The status of the analysis | [optional] [default to ["All"]]
**model_name** | [**List[ModelName]**](ModelName.md)| Show analysis belonging to the model | [optional]
**dynamic_execution_status** | [**DynamicExecutionStatusInput**](.md)| Show analysis that have a dynamic execution with the given status | [optional]
**dynamic_execution_status** | [**DynamicExecutionStatus**](.md)| Show analysis that have a dynamic execution with the given status | [optional]
**usernames** | [**List[Optional[str]]**](str.md)| Show analysis belonging to the user | [optional] [default to []]
**sha256_hash** | **str**| | [optional]
**limit** | **int**| | [optional] [default to 20]
Expand Down
2 changes: 1 addition & 1 deletion docs/AnalysisRecord.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Name | Type | Description | Notes
**function_boundaries_hash** | **str** | The hash of the function boundaries |
**binary_size** | **int** | The size of the binary |
**username** | **str** | The username of the analysis owner |
**dynamic_execution_status** | [**AppApiRestV2AnalysesEnumsDynamicExecutionStatus**](AppApiRestV2AnalysesEnumsDynamicExecutionStatus.md) | | [optional]
**dynamic_execution_status** | [**DynamicExecutionStatus**](DynamicExecutionStatus.md) | | [optional]
**dynamic_execution_task_id** | **int** | | [optional]
**base_address** | **int** | The base address of the binary |
**tags** | [**List[TagItem]**](TagItem.md) | List of tags associated with the analysis | [optional]
Expand Down
14 changes: 0 additions & 14 deletions docs/AnalysisStage.md

This file was deleted.

16 changes: 0 additions & 16 deletions docs/AnalysisStageStatus.md

This file was deleted.

170 changes: 0 additions & 170 deletions docs/AnalysisStagesApi.md

This file was deleted.

29 changes: 0 additions & 29 deletions docs/AnalysisStagesResponse.md

This file was deleted.

Loading