fix: move renderTarget and graphicInstanceId from query to the body, where applicable

Author: nytamin

v1/specification/open-api/server-api.yaml

@@ -225,7 +225,7 @@ paths:
           required: true
         - in: query
           name: renderTarget
-          description: "The RenderTarget to retrieve info about"
+          description: "The RenderTarget to retrieve info about. Note that this is a JSON-stringified RenderTargetIdentifier!"
           schema:
             $ref: "#/components/schemas/RenderTargetIdentifier"
           required: true
@@ -356,19 +356,16 @@ paths:
           schema:
             $ref: "#/components/schemas/RendererId"
           required: true
-        - in: query
-          name: renderTarget
-          description: "The RenderTarget to load the graphic onto"
-          schema:
-            $ref: "#/components/schemas/RenderTargetIdentifier"
-          required: true
       requestBody:
         required: true
         content:
           application/json:
             schema:
               type: object
               properties:
+                renderTarget:
+                  description: "The RenderTarget to load the graphic onto"
+                  $ref: "#/components/schemas/RenderTargetIdentifier"
                 graphicId:
                   description: "The graphic to load"
                   $ref: "#/components/schemas/GraphicId"
@@ -382,6 +379,7 @@ paths:
                   required:
                     - data
               required:
+                - renderTarget
                 - graphicId
                 - params
       responses:
@@ -428,28 +426,24 @@ paths:
           schema:
             $ref: "#/components/schemas/RendererId"
           required: true
-        - in: query
-          name: renderTarget
-          description: "The RenderTarget to target with the command."
-          schema:
-            $ref: "#/components/schemas/RenderTargetIdentifier"
-          required: true
-        - in: query
-          name: graphicInstanceId
-          description: "Id of the Graphic instance to target with the command"
-          schema:
-            $ref: "#/components/schemas/GraphicInstanceId"
-          required: true
       requestBody:
         required: true
         content:
           application/json:
             schema:
               type: object
               properties:
+                renderTarget:
+                  description: "The RenderTarget to target with the command."
+                  $ref: "#/components/schemas/RenderTargetIdentifier"
+                graphicInstanceId:
+                  description: "Id of the Graphic instance to target with the command"
+                  $ref: "#/components/schemas/GraphicInstanceId"
                 params:
                   $ref: "#/components/schemas/UpdateActionParams"
               required:
+                - renderTarget
+                - graphicInstanceId
                 - params
       responses:
         200:
@@ -494,28 +488,24 @@ paths:
           schema:
             $ref: "#/components/schemas/RendererId"
           required: true
-        - in: query
-          name: renderTarget
-          description: "The RenderTarget to target with the command"
-          schema:
-            $ref: "#/components/schemas/RenderTargetIdentifier"
-          required: true
-        - in: query
-          name: graphicInstanceId
-          description: "Id of the Graphic instance to target with the command"
-          schema:
-            $ref: "#/components/schemas/GraphicInstanceId"
-          required: true
       requestBody:
         required: true
         content:
           application/json:
             schema:
               type: object
               properties:
+                renderTarget:
+                  description: "The RenderTarget to target with the command."
+                  $ref: "#/components/schemas/RenderTargetIdentifier"
+                graphicInstanceId:
+                  description: "Id of the Graphic instance to target with the command"
+                  $ref: "#/components/schemas/GraphicInstanceId"
                 params:
                   $ref: "#/components/schemas/PlayActionParams"
               required:
+                - renderTarget
+                - graphicInstanceId
                 - params
 
       responses:
@@ -567,28 +557,24 @@ paths:
           schema:
             $ref: "#/components/schemas/RendererId"
           required: true
-        - in: query
-          name: renderTarget
-          description: "The RenderTarget to target with the command"
-          schema:
-            $ref: "#/components/schemas/RenderTargetIdentifier"
-          required: true
-        - in: query
-          name: graphicInstanceId
-          description: "Id of the Graphic instance to target with the command"
-          schema:
-            $ref: "#/components/schemas/GraphicInstanceId"
-          required: true
       requestBody:
         required: true
         content:
           application/json:
             schema:
               type: object
               properties:
+                renderTarget:
+                  description: "The RenderTarget to target with the command"
+                  $ref: "#/components/schemas/RenderTargetIdentifier"
+                graphicInstanceId:
+                  description: "Id of the Graphic instance to target with the command"
+                  $ref: "#/components/schemas/GraphicInstanceId"
                 params:
                   $ref: "#/components/schemas/StopActionParams"
               required:
+                - renderTarget
+                - graphicInstanceId
                 - params
       responses:
         200:
@@ -634,28 +620,24 @@ paths:
           schema:
             $ref: "#/components/schemas/RendererId"
           required: true
-        - in: query
-          name: renderTarget
-          description: "The RenderTarget to target with the command"
-          schema:
-            $ref: "#/components/schemas/RenderTargetIdentifier"
-          required: true
-        - in: query
-          name: graphicInstanceId
-          description: "Id of the Graphic instance to target with the command"
-          schema:
-            $ref: "#/components/schemas/GraphicInstanceId"
-          required: true
       requestBody:
         required: true
         content:
           application/json:
             schema:
               type: object
               properties:
+                renderTarget:
+                  description: "The RenderTarget to target with the command"
+                  $ref: "#/components/schemas/RenderTargetIdentifier"
+                graphicInstanceId:
+                  description: "Id of the Graphic instance to target with the command"
+                  $ref: "#/components/schemas/GraphicInstanceId"
                 params:
                   $ref: "#/components/schemas/CustomActionParams"
               required:
+                - renderTarget
+                - graphicInstanceId
                 - params
       responses:
         200:
@@ -701,25 +683,19 @@ paths:
           schema:
             $ref: "#/components/schemas/RendererId"
           required: true
-        - in: query
-          name: renderTarget
-          description: "The RenderTarget to target with the command"
-          schema:
-            $ref: "#/components/schemas/RenderTargetIdentifier"
-          required: true
-        - in: query
-          name: graphicInstanceId
-          description: "Id of the Graphic instance to target with the command"
-          schema:
-            $ref: "#/components/schemas/GraphicInstanceId"
-          required: true
       requestBody:
         required: true
         content:
           application/json:
             schema:
               type: object
               properties:
+                renderTarget:
+                  description: "The RenderTarget to target with the command"
+                  $ref: "#/components/schemas/RenderTargetIdentifier"
+                graphicInstanceId:
+                  description: "Id of the Graphic instance to target with the command"
+                  $ref: "#/components/schemas/GraphicInstanceId"
                 params:
                   description: "Params to send to the goToTime() method of the graphic"
                   type: object
@@ -731,6 +707,8 @@ paths:
                   required:
                     - timestamp
               required:
+                - renderTarget
+                - graphicInstanceId
                 - params
       responses:
         200:
@@ -776,25 +754,19 @@ paths:
           schema:
             $ref: "#/components/schemas/RendererId"
           required: true
-        - in: query
-          name: renderTarget
-          description: "The RenderTarget to target with the command"
-          schema:
-            $ref: "#/components/schemas/RenderTargetIdentifier"
-          required: true
-        - in: query
-          name: graphicInstanceId
-          description: "Id of the Graphic instance to target with the command"
-          schema:
-            $ref: "#/components/schemas/GraphicInstanceId"
-          required: true
       requestBody:
         required: true
         content:
           application/json:
             schema:
               type: object
               properties:
+                renderTarget:
+                  description: "The RenderTarget to target with the command"
+                  $ref: "#/components/schemas/RenderTargetIdentifier"
+                graphicInstanceId:
+                  description: "Id of the Graphic instance to target with the command"
+                  $ref: "#/components/schemas/GraphicInstanceId"
                 params:
                   description: "Params to send to the setActionsSchedule() method of the graphic"
                   type: object
@@ -858,6 +830,8 @@ paths:
                   required:
                     - schedule
               required:
+                - renderTarget
+                - graphicInstanceId
                 - params
       responses:
         200: