Updated rolePath schema. Ordered RAML endpoints alphabetically.

AMWA-TV · Mar 7, 2024 · 70784f8 · 70784f8
1 parent 4399659
commit 70784f8
Show file tree

Hide file tree

Showing 3 changed files with 67 additions and 65 deletions.
diff --git a/APIs/ConfigurationAPI.raml b/APIs/ConfigurationAPI.raml
@@ -79,6 +79,52 @@ documentation:
             body:
               type: !include schemas/bulkProperties-set-response.json
               example: !include ../examples/bulkProperties-set-200.json
+    /descriptor:
+      displayName: 'Class Descriptor'
+      get:
+        description: 'Get MS-05 Class Descriptor of this object. This descriptor MUST include all inherited elements'
+        responses:
+          200:
+            body:
+              example: !include ../examples/class-descriptor-get-200.json
+              type: !include schemas/descriptor-get.json
+          500:
+            description: 'Returned when the Class Descriptor of this object was unable to be retrieved. Corresponds to NcMethodStatus code 500.'
+            body:
+              type: !include schemas/ms05-error.json
+    /methods:
+      displayName: 'Methods'
+      get:
+        description: 'Get Methods of this object. This response MUST include all object methods including all the inherited methods'
+        responses:
+          200:
+            body:
+              example: !include ../examples/methods-base-get-200.json
+              type: !include schemas/methods-base.json
+      /{methodId}:
+        displayName: 'Invoke Method.'
+        patch:
+          description: 'Invoke method.'
+          body:
+            example: !include ../examples/method-patch-request.json
+            type: !include schemas/method-patch-request.json
+          responses:
+            200:
+              body:
+                example: !include ../examples/method-patch-200.json
+                type: !include schemas/method-patch-response.json
+            400:
+              description: 'Returned when the method arguments are invalid. Corresponds to NcMethodStatus code 417.'
+              body:
+                type: !include schemas/ms05-error.json
+            404:
+              description: 'Returned when the requested Method does not exist. Corresponds to NcMethodStatus code 501.'
+              body:
+                type: !include schemas/ms05-error.json
+            500:
+              description: 'Returned when the Method was unable to be invoked. Corresponds to NcMethodStatus code 500.'
+              body:
+                type: !include schemas/ms05-error.json
     /properties:
       displayName: 'Properties'
       get:
@@ -101,6 +147,19 @@ documentation:
               description: 'Returned when the requested Property does not exist. Corresponds to NcMethodStatus code 502.'
               body:
                 type: !include schemas/ms05-error.json
+        /descriptor:
+          displayName: 'Datatype Descriptor of property'
+          get:
+            description: 'Get MS-05 Datatype Descriptor of property. This descriptor MUST include all inherited elements'
+            responses:
+              200:
+                body:
+                  example: !include ../examples/property-descriptor-get-200.json
+                  type: !include schemas/property-descriptor.json
+              500:
+                description: 'Returned when the Datatype Descriptor of this object was unable to be retrieved. Corresponds to NcMethodStatus code 500.'
+                body:
+                  type: !include schemas/ms05-error.json
         /value:
           displayName: 'Value of a Property'
           get:
@@ -128,62 +187,3 @@ documentation:
                 description: 'Returned when the Property was unable to be set. Corresponds to the following NcMethodStatus codes: 405 if Property is read only, 417 if the value being PUT is invalid, 500 for all other reasons.'
                 body:
                   type: !include schemas/ms05-error.json
-        /descriptor:
-          displayName: 'Datatype Descriptor of property'
-          get:
-            description: 'Get MS-05 Datatype Descriptor of property. This descriptor MUST include all inherited elements'
-            responses:
-              200:
-                body:
-                  example: !include ../examples/property-descriptor-get-200.json
-                  type: !include schemas/property-descriptor.json
-              500:
-                description: 'Returned when the Datatype Descriptor of this object was unable to be retrieved. Corresponds to NcMethodStatus code 500.'
-                body:
-                  type: !include schemas/ms05-error.json
-    /methods:
-      displayName: 'Methods'
-      get:
-        description: 'Get Methods of this object. This response MUST include all object methods including all the inherited methods'
-        responses:
-          200:
-            body:
-              example: !include ../examples/methods-base-get-200.json
-              type: !include schemas/methods-base.json
-      /{methodId}:
-        displayName: 'Invoke Method.'
-        patch:
-          description: 'Invoke method.'
-          body:
-            example: !include ../examples/method-patch-request.json
-            type: !include schemas/method-patch-request.json
-          responses:
-            200:
-              body:
-                example: !include ../examples/method-patch-200.json
-                type: !include schemas/method-patch-response.json
-            400:
-              description: 'Returned when the method arguments are invalid. Corresponds to NcMethodStatus code 417.'
-              body:
-                type: !include schemas/ms05-error.json
-            404:
-              description: 'Returned when the requested Method does not exist. Corresponds to NcMethodStatus code 501.'
-              body:
-                type: !include schemas/ms05-error.json
-            500:
-              description: 'Returned when the Method was unable to be invoked. Corresponds to NcMethodStatus code 500.'
-              body:
-                type: !include schemas/ms05-error.json
-    /descriptor:
-      displayName: 'Class Descriptor'
-      get:
-        description: 'Get MS-05 Class Descriptor of this object. This descriptor MUST include all inherited elements'
-        responses:
-          200:
-            body:
-              example: !include ../examples/class-descriptor-get-200.json
-              type: !include schemas/descriptor-get.json
-          500:
-            description: 'Returned when the Class Descriptor of this object was unable to be retrieved. Corresponds to NcMethodStatus code 500.'
-            body:
-              type: !include schemas/ms05-error.json
diff --git a/APIs/schemas/rolePath.json b/APIs/schemas/rolePath.json
@@ -6,12 +6,13 @@
   "items": {
     "type": "string",
     "enum": [
-      "properties/",
+      "bulkProperties",
+      "descriptors/",
       "methods/",
-      "descriptors/"
+      "properties/"
     ]
   },
-  "minItems": 3,
-  "maxItems": 3,
+  "minItems": 4,
+  "maxItems": 4,
   "uniqueItems": true
 }
diff --git a/examples/rolePath-get-200.json b/examples/rolePath-get-200.json
@@ -1,5 +1,6 @@
 [
-  "properties/",
+  "bulkProperties",
+  "descriptors/",
   "methods/",
-  "descriptors/"
+  "properties/"
 ]