[ACS-8037] Add new endpoint to confirm/reject prediction (#9746)

* [ACS-8037] Add new endpoint to confirm/reject prediction

* [ACS-8037] Fix prediction api docs
This commit is contained in:
MichalKinas
2024-05-31 12:34:32 +02:00
committed by GitHub
parent 6bdfd83dac
commit 8dc1a9bed0
4 changed files with 64 additions and 4 deletions

View File

@@ -17,7 +17,7 @@
import { BaseApi } from './base.api';
import { throwIfNotDefined } from '../../../assert';
import { PredictionPaging } from '../model';
import { PredictionPaging, ReviewStatus } from '../model';
export class PredictionsApi extends BaseApi {
/**
@@ -39,4 +39,27 @@ export class PredictionsApi extends BaseApi {
returnType: PredictionPaging
});
}
/**
* Confirm or reject a prediction
*
* @param predictionId The identifier of a prediction.
* @param reviewStatus New status to apply for prediction. Can be either 'confirmed' or 'rejected'.
* @returns Promise<void>
*/
reviewPrediction(predictionId: string, reviewStatus: ReviewStatus): Promise<void> {
throwIfNotDefined(predictionId, 'predictionId');
throwIfNotDefined(reviewStatus, 'reviewStatus');
const pathParams = {
predictionId,
reviewStatus
};
return this.post({
path: '/predictions/{predictionId}/review',
pathParams,
returnType: Promise<void>
});
}
}

View File

@@ -5,6 +5,7 @@ All URIs are relative to *https://localhost/alfresco/api/-default-/private/hxi/v
Method | HTTP request | Description
------------- | ------------- | -------------
[**getPredictions**](PredictionsApi.md#getPredictions) | **GET** /nodes/{nodeId}/predictions | Get predictions for node.
[**reviewPrediction**](PredictionsApi.md#reviewPrediction) | **POST** /predictions/{predictionId}/review | Reject or confirm prediction.
<a name="getPredictions"></a>
# **getPredictions**
@@ -16,8 +17,26 @@ Get predictions for a node.
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**nodeId** | **string**| The identifier of a node. |
**nodeId** | **string** | The identifier of a node. |
### Return type
[**PredictionPaging**](PredictionPaging.md)
<a name="reviewPrediction"></a>
# **reviewPrediction**
> Promise\<void\> reviewPrediction(predictionId, reviewStatus)
Confirm or reject a prediction.
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**predictionId** | **string** | The identifier of a prediction. |
**reviewStatus** | **ReviewStatus** | Review status for prediction. Can be confirmed or rejected. |
### Return type
**Promise\<void\>**