@ue-shed/protocol 0.1.0-rc.4 → 0.2.0

package/contracts/cameras/review/v1/capture-request.schema.json

@@ -4,15 +4,7 @@
 	"title": "UE Shed Map Review capture request v1",
 	"type": "object",
 	"additionalProperties": false,
-	"required": [
-		"contract",
-		"operationId",
-		"viewId",
-		"expectedMapPath",
-		"subject",
-		"approvedPose",
-		"resolution"
-	],
+	"required": ["contract", "operationId", "viewId", "expectedMapPath", "subject", "resolution"],
 	"properties": {
 		"contract": {
 			"type": "object",
@@ -26,7 +18,7 @@
 					"required": ["major", "minor"],
 					"properties": {
 						"major": { "const": 1 },
-						"minor": { "type": "integer", "minimum": 0 }
+						"minor": { "type": "integer", "minimum": 0, "maximum": 4 }
 					}
 				}
 			}
@@ -35,14 +27,27 @@
 		"viewId": { "$ref": "#/$defs/safeId" },
 		"expectedMapPath": { "type": "string", "minLength": 1 },
 		"subject": {
-			"type": "object",
-			"additionalProperties": false,
-			"required": ["kind", "actorPath"],
-			"properties": {
-				"kind": { "const": "actor_path" },
-				"actorPath": { "type": "string", "minLength": 1 },
-				"diagnosticLabel": { "type": "string", "minLength": 1 }
-			}
+			"oneOf": [
+				{
+					"type": "object",
+					"additionalProperties": false,
+					"required": ["kind", "actorPath"],
+					"properties": {
+						"kind": { "const": "actor_path" },
+						"actorPath": { "type": "string", "minLength": 1 },
+						"diagnosticLabel": { "type": "string", "minLength": 1 }
+					}
+				},
+				{
+					"type": "object",
+					"additionalProperties": false,
+					"required": ["kind", "bounds"],
+					"properties": {
+						"kind": { "const": "oriented_bounds" },
+						"bounds": { "$ref": "#/$defs/bounds" }
+					}
+				}
+			]
 		},
 		"approvedPose": {
 			"type": "object",
@@ -64,8 +69,39 @@
 				"width": { "type": "integer", "minimum": 160, "maximum": 3840 },
 				"height": { "type": "integer", "minimum": 90, "maximum": 2160 }
 			}
-		}
+		},
+		"assessment": { "$ref": "#/$defs/assessment" },
+		"clearCompanion": { "$ref": "#/$defs/clearCompanion" },
+		"viewpoint": { "$ref": "#/$defs/viewpoint" }
 	},
+	"allOf": [
+		{
+			"if": {
+				"properties": {
+					"contract": {
+						"properties": {
+							"version": { "properties": { "minor": { "enum": [2, 3, 4] } } }
+						}
+					}
+				}
+			},
+			"then": { "required": ["assessment", "viewpoint"] },
+			"else": { "required": ["approvedPose"] }
+		},
+		{
+			"if": {
+				"properties": {
+					"contract": {
+						"properties": {
+							"version": { "properties": { "minor": { "const": 4 } } }
+						}
+					}
+				}
+			},
+			"then": { "required": ["clearCompanion"] },
+			"else": { "not": { "required": ["clearCompanion"] } }
+		}
+	],
 	"$defs": {
 		"safeId": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$" },
 		"vector": {
@@ -87,6 +123,124 @@
 				"yaw": { "type": "number" },
 				"roll": { "type": "number" }
 			}
+		},
+		"bounds": {
+			"type": "object",
+			"additionalProperties": false,
+			"required": ["center", "extent", "rotation"],
+			"properties": {
+				"center": { "$ref": "#/$defs/vector" },
+				"extent": { "$ref": "#/$defs/vector" },
+				"rotation": { "$ref": "#/$defs/rotation" }
+			}
+		},
+		"assessment": {
+			"oneOf": [
+				{
+					"type": "object",
+					"additionalProperties": false,
+					"required": ["method"],
+					"properties": { "method": { "const": "automatic" } }
+				},
+				{
+					"type": "object",
+					"additionalProperties": false,
+					"required": ["method", "samplePreset"],
+					"properties": {
+						"method": { "const": "ray_samples" },
+						"samplePreset": { "enum": ["sparse", "standard", "dense"] }
+					}
+				},
+				{
+					"type": "object",
+					"additionalProperties": false,
+					"required": ["method"],
+					"properties": { "method": { "enum": ["subject_mask", "depth_compare"] } }
+				}
+			]
+		},
+		"clearCompanion": {
+			"oneOf": [
+				{
+					"type": "object",
+					"additionalProperties": false,
+					"required": ["status"],
+					"properties": { "status": { "const": "not_requested" } }
+				},
+				{
+					"type": "object",
+					"additionalProperties": false,
+					"required": ["status", "strategy"],
+					"properties": {
+						"status": { "const": "requested" },
+						"strategy": { "const": "isolate_target" }
+					}
+				},
+				{
+					"type": "object",
+					"additionalProperties": false,
+					"required": ["actors", "status", "strategy"],
+					"properties": {
+						"actors": {
+							"type": "array",
+							"minItems": 1,
+							"maxItems": 32,
+							"uniqueItems": true,
+							"items": {
+								"type": "string",
+								"minLength": 7,
+								"maxLength": 4096,
+								"pattern": "^/Game/"
+							}
+						},
+						"status": { "const": "requested" },
+						"strategy": { "const": "hide_explicit" }
+					}
+				}
+			]
+		},
+		"viewpoint": {
+			"oneOf": [
+				{
+					"type": "object",
+					"additionalProperties": false,
+					"required": ["kind", "approvedPose"],
+					"properties": {
+						"kind": { "const": "world_fixed" },
+						"approvedPose": { "$ref": "#/$defs/pose" }
+					}
+				},
+				{
+					"type": "object",
+					"additionalProperties": false,
+					"required": ["kind", "relativePose", "targetSnapshot"],
+					"properties": {
+						"kind": { "const": "target_relative" },
+						"relativePose": { "$ref": "#/$defs/pose" },
+						"targetSnapshot": {
+							"type": "object",
+							"additionalProperties": false,
+							"required": ["location", "rotation"],
+							"properties": {
+								"location": { "$ref": "#/$defs/vector" },
+								"rotation": { "$ref": "#/$defs/rotation" }
+							}
+						}
+					}
+				}
+			]
+		},
+		"pose": {
+			"type": "object",
+			"additionalProperties": false,
+			"required": ["aspectRatio", "fieldOfViewDegrees", "location", "projection", "rotation"],
+			"properties": {
+				"aspectRatio": { "const": "16:9" },
+				"fieldOfViewDegrees": { "type": "number", "minimum": 5, "maximum": 170 },
+				"projection": { "const": "perspective" },
+				"location": { "$ref": "#/$defs/vector" },
+				"rotation": { "$ref": "#/$defs/rotation" }
+			}
 		}
 	}
 }