Skip to content

FunctionsDataTypesApi.md

Latest commit

 

History

History
406 lines (264 loc) · 11.4 KB

FunctionsDataTypesApi.md

File metadata and controls

406 lines (264 loc) · 11.4 KB

.FunctionsDataTypesApi

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

Method HTTP request Description
generateFunctionDataTypesForAnalysis POST /v2/analyses/{analysis_id}/functions/data_types Generate Function Data Types
generateFunctionDataTypesForFunctions POST /v2/functions/data_types Generate Function Data Types for an arbitrary list of functions
getFunctionDataTypes GET /v2/analyses/{analysis_id}/functions/{function_id}/data_types Get Function Data Types
listFunctionDataTypesForAnalysis GET /v2/analyses/{analysis_id}/functions/data_types List Function Data Types
listFunctionDataTypesForFunctions GET /v2/functions/data_types List Function Data Types
updateFunctionDataTypes PUT /v2/analyses/{analysis_id}/functions/{function_id}/data_types Update Function Data Types

generateFunctionDataTypesForAnalysis

BaseResponseGenerateFunctionDataTypes generateFunctionDataTypesForAnalysis(functionDataTypesParams)

Submits a request to generate the function data types

Example

import { createConfiguration, FunctionsDataTypesApi } from '@revengai/sdk';
import type { FunctionsDataTypesApiGenerateFunctionDataTypesForAnalysisRequest } from '@revengai/sdk';

const configuration = createConfiguration();
const apiInstance = new FunctionsDataTypesApi(configuration);

const request: FunctionsDataTypesApiGenerateFunctionDataTypesForAnalysisRequest = {
  
  analysisId: 1,
  
  functionDataTypesParams: {
    functionIds: [
      1,
    ],
  },
};

const data = await apiInstance.generateFunctionDataTypesForAnalysis(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
functionDataTypesParams FunctionDataTypesParams
analysisId [number] defaults to undefined

Return type

BaseResponseGenerateFunctionDataTypes

Authorization

APIKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Successful Response -
422 Invalid request parameters -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

generateFunctionDataTypesForFunctions

BaseResponseGenerationStatusList generateFunctionDataTypesForFunctions(functionDataTypesParams)

Submits a request to generate the function data types

Example

import { createConfiguration, FunctionsDataTypesApi } from '@revengai/sdk';
import type { FunctionsDataTypesApiGenerateFunctionDataTypesForFunctionsRequest } from '@revengai/sdk';

const configuration = createConfiguration();
const apiInstance = new FunctionsDataTypesApi(configuration);

const request: FunctionsDataTypesApiGenerateFunctionDataTypesForFunctionsRequest = {
  
  functionDataTypesParams: {
    functionIds: [
      1,
    ],
  },
};

const data = await apiInstance.generateFunctionDataTypesForFunctions(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
functionDataTypesParams FunctionDataTypesParams

Return type

BaseResponseGenerationStatusList

Authorization

APIKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Successful Response -
422 Invalid request parameters -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getFunctionDataTypes

BaseResponseFunctionDataTypes getFunctionDataTypes()

Polling endpoint which returns the current status of function generation and once completed the data type information

Example

import { createConfiguration, FunctionsDataTypesApi } from '@revengai/sdk';
import type { FunctionsDataTypesApiGetFunctionDataTypesRequest } from '@revengai/sdk';

const configuration = createConfiguration();
const apiInstance = new FunctionsDataTypesApi(configuration);

const request: FunctionsDataTypesApiGetFunctionDataTypesRequest = {
  
  analysisId: 1,
  
  functionId: 1,
};

const data = await apiInstance.getFunctionDataTypes(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
analysisId [number] defaults to undefined
functionId [number] defaults to undefined

Return type

BaseResponseFunctionDataTypes

Authorization

APIKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listFunctionDataTypesForAnalysis

BaseResponseFunctionDataTypesList listFunctionDataTypesForAnalysis()

Returns data types for multiple functions with optional function ID filtering

Example

import { createConfiguration, FunctionsDataTypesApi } from '@revengai/sdk';
import type { FunctionsDataTypesApiListFunctionDataTypesForAnalysisRequest } from '@revengai/sdk';

const configuration = createConfiguration();
const apiInstance = new FunctionsDataTypesApi(configuration);

const request: FunctionsDataTypesApiListFunctionDataTypesForAnalysisRequest = {
  
  analysisId: 1,
  
  functionIds: [
    1,
  ],
};

const data = await apiInstance.listFunctionDataTypesForAnalysis(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
analysisId [number] defaults to undefined
functionIds Array<number> (optional) defaults to undefined

Return type

BaseResponseFunctionDataTypesList

Authorization

APIKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listFunctionDataTypesForFunctions

BaseResponseFunctionDataTypesList listFunctionDataTypesForFunctions()

Returns data types for multiple function IDs

Example

import { createConfiguration, FunctionsDataTypesApi } from '@revengai/sdk';
import type { FunctionsDataTypesApiListFunctionDataTypesForFunctionsRequest } from '@revengai/sdk';

const configuration = createConfiguration();
const apiInstance = new FunctionsDataTypesApi(configuration);

const request: FunctionsDataTypesApiListFunctionDataTypesForFunctionsRequest = {
  
  functionIds: [
    1,
  ],
};

const data = await apiInstance.listFunctionDataTypesForFunctions(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
functionIds Array<number> (optional) defaults to undefined

Return type

BaseResponseFunctionDataTypesList

Authorization

APIKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateFunctionDataTypes

BaseResponseFunctionDataTypes updateFunctionDataTypes(updateFunctionDataTypes)

Updates the function data types for a given function

Example

import { createConfiguration, FunctionsDataTypesApi } from '@revengai/sdk';
import type { FunctionsDataTypesApiUpdateFunctionDataTypesRequest } from '@revengai/sdk';

const configuration = createConfiguration();
const apiInstance = new FunctionsDataTypesApi(configuration);

const request: FunctionsDataTypesApiUpdateFunctionDataTypesRequest = {
  
  analysisId: 1,
  
  functionId: 1,
  
  updateFunctionDataTypes: {
    dataTypesVersion: 1,
    dataTypes: {
      funcTypes: {
        lastChange: "lastChange_example",
        addr: 1,
        size: 1,
        header: {
          lastChange: "lastChange_example",
          name: "name_example",
          addr: 1,
          type: "type_example",
          args: {
            "key": {
              lastChange: "lastChange_example",
              offset: 1,
              name: "name_example",
              type: "type_example",
              size: 1,
            },
          },
        },
        stackVars: {
          "key": {
            lastChange: "lastChange_example",
            offset: 1,
            name: "name_example",
            type: "type_example",
            size: 1,
            addr: 1,
          },
        },
        name: "name_example",
        type: "type_example",
        artifactType: "Function",
      },
      funcDeps: [
        null,
      ],
    },
  },
};

const data = await apiInstance.updateFunctionDataTypes(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name Type Description Notes
updateFunctionDataTypes UpdateFunctionDataTypes
analysisId [number] defaults to undefined
functionId [number] defaults to undefined

Return type

BaseResponseFunctionDataTypes

Authorization

APIKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
422 Invalid request parameters -

[Back to top] [Back to API list] [Back to Model list] [Back to README]