Add "adjust_to_caps" query parameter

AMWA-TV · Jun 30, 2023 · 6751521 · 6751521
1 parent bf30f5c
commit 6751521
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/APIs/StreamCompatibilityManagementAPI.raml b/APIs/StreamCompatibilityManagementAPI.raml
@@ -285,6 +285,13 @@ mediaType: application/json
                 type: !include schemas/error.json
         put:
           description: Set Base EDID
+          queryParameters:
+            adjust_to_caps:
+              description: >
+                If true, the Input is allowed to adjust Base EDID to its capabilities (e.g. to remove unsupported video modes).
+              type: boolean
+              required: false
+              example: adjust_to_caps=true
           body:
             application/octet-stream:
               type: file

diff --git a/docs/Behaviour - Server Side.md b/docs/Behaviour - Server Side.md
@@ -83,6 +83,8 @@ The `/properties` endpoint shows properties of the Input. In particular, it MAY
 
 ### Base EDID
 
+An Input MAY support adjusting Base EDID to its internal capabilities via `adjust_to_caps` query parameter of a `PUT /edid/base` request.
+
 There is no Base EDID at the initial state. If the Base EDID for an Input changes, then all Senders associated with this Input MUST update their versions (in registered mode this MUST update the registered resources).
 
 ### Effective EDID