Async search error handling (#5597) (#5656)

* async search error handling

* using common class

---------


(cherry picked from commit 025a87b)

Co-authored-by: Laura Trotta <[email protected]>
Co-authored-by: Quentin Pradet <[email protected]>

Author: 3 people

specification/async_search/_types/AsyncSearchResponseBase.ts

@@ -18,6 +18,7 @@
  */
 
 import { Id } from '@_types/common'
+import { ErrorCause } from '@_types/Errors'
 import { DateTime, EpochTime, UnitMillis } from '@_types/Time'
 import { AsyncSearch } from './AsyncSearch'
 
@@ -48,9 +49,23 @@ export class AsyncSearchResponseBase {
    */
   completion_time?: DateTime
   completion_time_in_millis?: EpochTime<UnitMillis>
+  error?: ErrorCause
 }
 export class AsyncSearchDocumentResponseBase<
   TDocument
 > extends AsyncSearchResponseBase {
   response: AsyncSearch<TDocument>
 }
+
+export class AsyncSearchResponseException<TDocument> {
+  is_partial: boolean
+  is_running: boolean
+  expiration_time?: DateTime
+  expiration_time_in_millis: EpochTime<UnitMillis>
+  start_time?: DateTime
+  start_time_in_millis: EpochTime<UnitMillis>
+  completion_time?: DateTime
+  completion_time_in_millis?: EpochTime<UnitMillis>
+  error?: ErrorCause
+  response?: AsyncSearch<TDocument>
+}

specification/async_search/get/AsyncSearchGetResponse.ts

@@ -17,8 +17,17 @@
  * under the License.
  */
 
-import { AsyncSearchDocumentResponseBase } from '@async_search/_types/AsyncSearchResponseBase'
+import {
+  AsyncSearchDocumentResponseBase,
+  AsyncSearchResponseException
+} from '@async_search/_types/AsyncSearchResponseBase'
 
 export class Response<TDocument> {
   body: AsyncSearchDocumentResponseBase<TDocument>
+  exceptions: [
+    {
+      statusCodes: [404, 400, 500, 429]
+      body: AsyncSearchResponseException<TDocument>
+    }
+  ]
 }

specification/async_search/submit/AsyncSearchSubmitResponse.ts

@@ -17,8 +17,17 @@
  * under the License.
  */
 
-import { AsyncSearchDocumentResponseBase } from '@async_search/_types/AsyncSearchResponseBase'
+import {
+  AsyncSearchDocumentResponseBase,
+  AsyncSearchResponseException
+} from '@async_search/_types/AsyncSearchResponseBase'
 
 export class Response<TDocument> {
   body: AsyncSearchDocumentResponseBase<TDocument>
+  exceptions: [
+    {
+      statusCodes: [404, 400, 500, 429]
+      body: AsyncSearchResponseException<TDocument>
+    }
+  ]
 }