Support operation field for CPS Temporal Query Output API

[cps/cps-temporal.git] / docs / _static / openapi / swagger / openapi.yml

diff --git a/docs/_static/openapi/swagger/openapi.yml b/docs/_static/openapi/swagger/openapi.yml
index 991d807..a96947b 100644 (file)
--- a/docs/_static/openapi/swagger/openapi.yml
+++ b/docs/_static/openapi/swagger/openapi.yml
@@ -1,5 +1,5 @@
 # ============LICENSE_START=======================================================
-# Copyright (c) 2021 Bell Canada.
+# Copyright (c) 2021-2022 Bell Canada.
 # ================================================================================
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -51,6 +51,7 @@ paths:
           required: true
           schema:
             type: string
+            example: my-anchor
         - $ref: '#/components/parameters/observedTimestampAfter'
         - $ref: '#/components/parameters/simplePayloadFilter'
         - $ref: '#/components/parameters/pointInTime'
@@ -192,18 +193,30 @@ components:
         application/json:
           schema:
             $ref: '#/components/schemas/ErrorMessage'
+          example:
+            status: 400
+            message: Bad request error message
+            details: Bad request error details
     Unauthorized:
       description: Unauthorized
       content:
         application/json:
           schema:
             $ref: '#/components/schemas/ErrorMessage'
+          example:
+            status: 401
+            message: Unauthorized error message
+            details: Unauthorized error details
     Forbidden:
       description: Forbidden
       content:
         application/json:
           schema:
             $ref: '#/components/schemas/ErrorMessage'
+          example:
+            status: 403
+            message: Forbidden error message
+            details: Forbidden error details
   schemas:
     AnchorDetails:
       type: object
@@ -212,6 +225,10 @@ components:
         observedTimestamp:
           type: string
           example: '2021-03-21T00:00:00.000-0000'
+        operation:
+          type: string
+          enum: [CREATE, UPDATE, DELETE]
+          example: UPDATE
         dataspace:
           type: string
           example: 'my-dataspace'