Updata the api definition of checkpoint API

Change-Id: I66bdcbf4ba8f2f8c97a1096670a1e2be4c861959
blueprint smaug-checkpoint-metadata

api-ref/source/v1/karbor-v1-checkpoints.inc

@@ -112,6 +112,7 @@ Request
    - provider_id: provider_id_1
    - checkpoint: checkpoint
    - plan_id: plan_id
+   - extra_info: extra_info
 
 Request Example
 ---------------

api-ref/source/v1/parameters.yaml

@@ -140,6 +140,12 @@ enabled:
   in: body
   required: true
   type: int
+extra_info:
+  description: |
+    The extra information for checkpoint.
+  in: body
+  required: false
+  type: dict
 links:
   description: |
     Links for transfer.

api-ref/source/v1/samples/checkpoint-create-request.json

@@ -1,5 +1,9 @@
 {
   "checkpoint": {
-    "plan_id": "3523a271-68aa-42f5-b9ba-56e5200a2ebb"
+    "plan_id": "3523a271-68aa-42f5-b9ba-56e5200a2ebb",
+    "extra_info": {
+      "create-by": "operation-engine",
+      "trigger_id": "33b6bb0b-1157-4e66-8553-1c9e14b1c7ba"
+    }
   }
 }

doc/source/specs/api/api_examples.md

@@ -205,7 +205,11 @@
 ```json
 {
   "checkpoint": {
-    "plan_id": "3523a271-68aa-42f5-b9ba-56e5200a2ebb"
+    "plan_id": "3523a271-68aa-42f5-b9ba-56e5200a2ebb",
+    "extra_info": {
+      "create-by": "operation-engine",
+      "trigger_id": "33b6bb0b-1157-4e66-8553-1c9e14b1c7ba",
+    }
   }
 }
 ```

doc/source/specs/api/karbor_api.v1.yaml

@@ -1451,6 +1451,10 @@ definitions:
         type: string
         format: UUID
         description: Unique identifier representing a specific protection protection plan.
+      extra_info:
+        readOnly: true
+        type: dict
+        description: The extra info parameter of the checkpoint.
 
   Resource:
     type: object