Skip to content

AnalysesCommentsApi.md

Latest commit

 

History

History
322 lines (201 loc) · 9.72 KB

AnalysesCommentsApi.md

File metadata and controls

322 lines (201 loc) · 9.72 KB

.AnalysesCommentsApi

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

Method HTTP request Description
createAnalysisComment POST /v2/analyses/{analysis_id}/comments Create a comment for this analysis
deleteAnalysisComment DELETE /v2/analyses/{analysis_id}/comments/{comment_id} Delete a comment
getAnalysisComments GET /v2/analyses/{analysis_id}/comments Get comments for this analysis
updateAnalysisComment PATCH /v2/analyses/{analysis_id}/comments/{comment_id} Update a comment

createAnalysisComment

BaseResponseCommentResponse createAnalysisComment(commentBase)

Creates a comment associated with a specified analysis).

Example

import { createConfiguration, AnalysesCommentsApi } from '@revengai/sdk';
import type { AnalysesCommentsApiCreateAnalysisCommentRequest } from '@revengai/sdk';

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

const request: AnalysesCommentsApiCreateAnalysisCommentRequest = {
  
  analysisId: 1,
  
  commentBase: {
    content: "content_example",
  },
  
  endpointUrl: "endpoint_url_example",
  
  localCacheDir: "local_cache_dir_example",
  
  localCacheMaxSizeMb: 1,
  
  customerSamplesBucket: "customer_samples_bucket_example",
  
  firmwareSamplesBucket: "firmware_samples_bucket_example",
  
  maxRetryAttempts: 5,
};

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

Parameters

Name Type Description Notes
commentBase CommentBase
analysisId [number] defaults to undefined
endpointUrl [string] (optional) defaults to undefined
localCacheDir [string] (optional) defaults to undefined
localCacheMaxSizeMb [number] (optional) defaults to undefined
customerSamplesBucket [string] (optional) defaults to undefined
firmwareSamplesBucket [string] (optional) defaults to undefined
maxRetryAttempts [number] (optional) defaults to 5

Return type

BaseResponseCommentResponse

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 -
400 Bad Request -

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

deleteAnalysisComment

BaseResponseBool deleteAnalysisComment()

Deletes an existing comment. Users can only delete their own comments.

Example

import { createConfiguration, AnalysesCommentsApi } from '@revengai/sdk';
import type { AnalysesCommentsApiDeleteAnalysisCommentRequest } from '@revengai/sdk';

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

const request: AnalysesCommentsApiDeleteAnalysisCommentRequest = {
  
  commentId: 1,
  
  analysisId: 1,
  
  endpointUrl: "endpoint_url_example",
  
  localCacheDir: "local_cache_dir_example",
  
  localCacheMaxSizeMb: 1,
  
  customerSamplesBucket: "customer_samples_bucket_example",
  
  firmwareSamplesBucket: "firmware_samples_bucket_example",
  
  maxRetryAttempts: 5,
};

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

Parameters

Name Type Description Notes
commentId [number] defaults to undefined
analysisId [number] defaults to undefined
endpointUrl [string] (optional) defaults to undefined
localCacheDir [string] (optional) defaults to undefined
localCacheMaxSizeMb [number] (optional) defaults to undefined
customerSamplesBucket [string] (optional) defaults to undefined
firmwareSamplesBucket [string] (optional) defaults to undefined
maxRetryAttempts [number] (optional) defaults to 5

Return type

BaseResponseBool

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 -
403 You can only delete your own comments -
400 Bad Request -

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

getAnalysisComments

BaseResponseListCommentResponse getAnalysisComments()

Retrieves all comments created for a specific analysis. Only returns comments for resources the requesting user has access to.

Example

import { createConfiguration, AnalysesCommentsApi } from '@revengai/sdk';
import type { AnalysesCommentsApiGetAnalysisCommentsRequest } from '@revengai/sdk';

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

const request: AnalysesCommentsApiGetAnalysisCommentsRequest = {
  
  analysisId: 1,
  
  endpointUrl: "endpoint_url_example",
  
  localCacheDir: "local_cache_dir_example",
  
  localCacheMaxSizeMb: 1,
  
  customerSamplesBucket: "customer_samples_bucket_example",
  
  firmwareSamplesBucket: "firmware_samples_bucket_example",
  
  maxRetryAttempts: 5,
};

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

Parameters

Name Type Description Notes
analysisId [number] defaults to undefined
endpointUrl [string] (optional) defaults to undefined
localCacheDir [string] (optional) defaults to undefined
localCacheMaxSizeMb [number] (optional) defaults to undefined
customerSamplesBucket [string] (optional) defaults to undefined
firmwareSamplesBucket [string] (optional) defaults to undefined
maxRetryAttempts [number] (optional) defaults to 5

Return type

BaseResponseListCommentResponse

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]

updateAnalysisComment

BaseResponseCommentResponse updateAnalysisComment(commentUpdateRequest)

Updates the content of an existing comment. Users can only update their own comments.

Example

import { createConfiguration, AnalysesCommentsApi } from '@revengai/sdk';
import type { AnalysesCommentsApiUpdateAnalysisCommentRequest } from '@revengai/sdk';

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

const request: AnalysesCommentsApiUpdateAnalysisCommentRequest = {
  
  commentId: 1,
  
  analysisId: 1,
  
  commentUpdateRequest: {
    content: "content_example",
  },
  
  endpointUrl: "endpoint_url_example",
  
  localCacheDir: "local_cache_dir_example",
  
  localCacheMaxSizeMb: 1,
  
  customerSamplesBucket: "customer_samples_bucket_example",
  
  firmwareSamplesBucket: "firmware_samples_bucket_example",
  
  maxRetryAttempts: 5,
};

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

Parameters

Name Type Description Notes
commentUpdateRequest CommentUpdateRequest
commentId [number] defaults to undefined
analysisId [number] defaults to undefined
endpointUrl [string] (optional) defaults to undefined
localCacheDir [string] (optional) defaults to undefined
localCacheMaxSizeMb [number] (optional) defaults to undefined
customerSamplesBucket [string] (optional) defaults to undefined
firmwareSamplesBucket [string] (optional) defaults to undefined
maxRetryAttempts [number] (optional) defaults to 5

Return type

BaseResponseCommentResponse

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 -
403 You can only update your own comments -
400 Bad Request -

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