Introduce DataSchema for property 'things' (#538)

* feat: introduce DataSchema for property 'things' * fixup! feat: introduce DataSchema for property 'things'
w3c · Feb 26, 2024 · bfd5eea · bfd5eea
1 parent d1cdaec
commit bfd5eea
Showing 1 changed file with 42 additions and 0 deletions.
diff --git a/directory.tm.json b/directory.tm.json
@@ -29,6 +29,48 @@
     "properties": {
         "things": {
             "description": "Retrieve all Thing Descriptions",
+            "oneOf": [
+                {
+                    "description": "Plain list of Thing Descriptions",
+                    "type": "array",
+                    "items": {
+                        "description": "Thing Description",
+                        "type": "object"
+                    }
+                },
+                {
+                    "type": "object",
+                    "description": "Verbose payload with pagination information, see format Uri variable",
+                    "properties": {
+                        "@context": {
+                            "const": "https://www.w3.org/2022/wot/discovery"
+                        },
+                        "@type": {
+                            "const": "ThingCollection"
+                        },
+                        "@id": {
+                            "description": "URI of this collection",
+                            "type": "string"
+                        },
+                        "members": {
+                            "description": "Thing Descriptions",
+                            "type": "array",
+                            "items": {
+                                "description": "Thing Description",
+                                "type": "object"
+                            }
+                        },
+                        "total": {
+                            "description": "Total number of Thing Descriptions in this collection",
+                            "type": "number"
+                        },
+                        "next": {
+                            "description": "URI of the next page",
+                            "type": "string"
+                        }
+                    }
+                }
+            ],
             "uriVariables": {
                 "offset": {
                     "title": "Number of TDs to skip before the page",