Merge branch 'v1.0-dev' into publish-backup-restore

AMWA-TV · Oct 29, 2024 · 5e6f0ed · 5e6f0ed
2 parents 421ca63 + c35423a
commit 5e6f0ed
Show file tree

Hide file tree

Showing 7 changed files with 399 additions and 368 deletions.
diff --git a/APIs/ConfigurationAPI.raml b/APIs/ConfigurationAPI.raml
@@ -34,7 +34,9 @@ documentation:
           example: !include ../examples/rolePaths-base-get-200.json
           type: !include schemas/rolePaths-base.json
   /{rolePath}:
-    displayName: 'Attributes of a Role Path'
+    uriParameters:
+        rolePath:
+            type: string
     get:
       description: 'Get attributes of the object specified by rolePath'
       responses:
@@ -60,6 +62,11 @@ documentation:
               type: !include schemas/bulkProperties-get-response.json
               example: !include ../examples/bulkProperties-get-200.json
       options:
+        description: A pre-flight check generally used for Cross-Origin Resource Sharing (CORS) purposes
+        responses:
+          200:
+          403:
+      patch:
         description: 'Validate an NcBulkValuesHolder object against the Device Model'
         body:
           type: !include schemas/bulkProperties-validate-request.json
@@ -102,7 +109,15 @@ documentation:
               example: !include ../examples/methods-base-get-200.json
               type: !include schemas/methods-base.json
       /{methodId}:
-        displayName: 'Invoke Method.'
+        uriParameters:
+            methodId:
+                type: string
+                pattern: "^[0-9]+m[0-9]+"
+        options:
+          description: A pre-flight check generally used for Cross-Origin Resource Sharing (CORS) purposes
+          responses:
+            200:
+            403:
         patch:
           description: 'Invoke method.'
           body:
@@ -135,7 +150,10 @@ documentation:
               example: !include ../examples/properties-base-get-200.json
               type: !include schemas/properties-base.json
       /{propertyId}:
-        displayName: 'Attributes of a Property'
+        uriParameters:
+            propertyId:
+                type: string
+                pattern: "^[0-9]+p[0-9]+"
         get:
           description: 'Get attributes of a Property'
           responses:
@@ -173,6 +191,11 @@ documentation:
                 description: 'Returned when the Property was unable to be retrieved. Corresponds to NcMethodStatus code 500.'
                 body:
                   type: !include schemas/ms05-error.json
+          options:
+            description: A pre-flight check generally used for Cross-Origin Resource Sharing (CORS) purposes
+            responses:
+              200:
+              403:
           put:
             descriptions: 'Put value of a Property'
             body:

diff --git a/APIs/schemas/methods-base.json b/APIs/schemas/methods-base.json
@@ -4,7 +4,8 @@
   "description": "Describes the Configuration API /rolePaths/{rolePath}/methods base",
   "title": "Configuration API /rolePaths/{rolePath}/methods base",
   "items": {
-    "type": "string"
+    "type": "string",
+    "pattern": "^[0-9]+m[0-9]+"
   },
   "uniqueItems": true
 }
diff --git a/APIs/schemas/properties-base.json b/APIs/schemas/properties-base.json
@@ -4,7 +4,8 @@
   "description": "Describes the Configuration API /rolePaths/{rolePath}/properties base",
   "title": "Configuration API /rolePaths/{rolePath}/properties base",
   "items": {
-    "type": "string"
+    "type": "string",
+    "pattern": "^[0-9]+p[0-9]+"
   },
   "uniqueItems": true
 }
diff --git a/APIs/schemas/rolePath.json b/APIs/schemas/rolePath.json
@@ -6,8 +6,8 @@
   "items": {
     "type": "string",
     "enum": [
-      "bulkProperties",
-      "descriptors/",
+      "bulkProperties/",
+      "descriptor/",
       "methods/",
       "properties/"
     ]