Add regular expression patterns to method and property identifiers

AMWA-TV · Apr 26, 2024 · abb886a · abb886a
1 parent 7b36beb
commit abb886a
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 4 deletions.
diff --git a/APIs/ConfigurationAPI.raml b/APIs/ConfigurationAPI.raml
@@ -102,7 +102,10 @@ 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]+$"
         patch:
           description: 'Invoke method.'
           body:
@@ -135,7 +138,10 @@ documentation:
               example: !include ../examples/properties-base-get-200.json
               type: !include schemas/properties-base.json
       /{propertyId}:
-        displayName: 'Attributes of a Property'
+        uriParameters:
+            methodId:
+            type: string
+            pattern: "^[0-9]+p[0-9]+$"
         get:
           description: 'Get attributes of a Property'
           responses:

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
 }