"validation_plan_id" property will be removed from validation results…

… in v3.1 in endpoints: - POST /device_report - POST /device/:id_or_serial_number/validation_plan/:validation_plan_id - POST /device/:id_or_serial_number/validation/:validation_id - GET /device/:id_or_serial_number/validation_state It is redundant information as all the validation_ids are included with the individual results.
joyent · Nov 2, 2020 · 3eba9b7 · 3eba9b7
1 parent 7cf1f50
commit 3eba9b7
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 4 deletions.
diff --git a/docs/json-schema/response.json b/docs/json-schema/response.json
@@ -2575,7 +2575,13 @@
           "$ref" : "common.json#/definitions/validation_status"
         },
         "validation_plan_id" : {
-          "$ref" : "common.json#/definitions/uuid"
+          "$comment" : "this property will be removed in v3.1",
+          "allOf" : [
+            {
+              "$ref" : "common.json#/definitions/uuid"
+            }
+          ],
+          "deprecated" : true
         }
       },
       "required" : [
@@ -3073,7 +3079,13 @@
           "$ref" : "common.json#/definitions/validation_status"
         },
         "validation_plan_id" : {
-          "$ref" : "common.json#/definitions/uuid"
+          "$comment" : "this property will be removed in v3.1",
+          "allOf" : [
+            {
+              "$ref" : "common.json#/definitions/uuid"
+            }
+          ],
+          "deprecated" : true
         }
       },
       "required" : [

diff --git a/json-schema/response.yaml b/json-schema/response.yaml
@@ -1062,7 +1062,10 @@ definitions:
       status:
         $ref: common.yaml#/definitions/validation_status
       validation_plan_id:
-        $ref: common.yaml#/definitions/uuid
+        $comment: this property will be removed in v3.1
+        deprecated: true
+        allOf:
+          - $ref: common.yaml#/definitions/uuid
       hardware_product_id:
         $ref: common.yaml#/definitions/uuid
       device_report_id:
@@ -1081,7 +1084,10 @@ definitions:
       device_serial_number:
         $ref: common.yaml#/definitions/device_serial_number
       validation_plan_id:
-        $ref: common.yaml#/definitions/uuid
+        $comment: this property will be removed in v3.1
+        deprecated: true
+        allOf:
+          - $ref: common.yaml#/definitions/uuid
       hardware_product_id:
         $ref: common.yaml#/definitions/uuid
       sku: