Skip to content

ServerAPI: Remove GraphicId in favor for GraphicInstanceId #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nytamin merged 1 commit into from
Nov 7, 2025
Merged

ServerAPI: Remove GraphicId in favor for GraphicInstanceId #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 13 additions & 23 deletions v1/specification/open-api/server-api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -439,9 +439,9 @@ paths:
required: true
- in: query
name: graphicTarget
description: "The Graphic to target with the command"
description: "The Graphic to target with the command (graphicInstanceId)"
schema:
$ref: "#/components/schemas/GraphicTarget"
$ref: "#/components/schemas/GraphicInstanceId"
required: true
requestBody:
required: true
Expand Down Expand Up @@ -505,9 +505,9 @@ paths:
required: true
- in: query
name: graphicTarget
description: "The Graphic to target with the command"
description: "The Graphic to target with the command (graphicInstanceId)"
schema:
$ref: "#/components/schemas/GraphicTarget"
$ref: "#/components/schemas/GraphicInstanceId"
required: true
requestBody:
required: true
Expand Down Expand Up @@ -578,9 +578,9 @@ paths:
required: true
- in: query
name: graphicTarget
description: "The Graphic to target with the command"
description: "The Graphic to target with the command (graphicInstanceId)"
schema:
$ref: "#/components/schemas/GraphicTarget"
$ref: "#/components/schemas/GraphicInstanceId"
required: true
requestBody:
required: true
Expand Down Expand Up @@ -645,9 +645,9 @@ paths:
required: true
- in: query
name: graphicTarget
description: "The Graphic to target with the command"
description: "The Graphic to target with the command (graphicInstanceId)"
schema:
$ref: "#/components/schemas/GraphicTarget"
$ref: "#/components/schemas/GraphicInstanceId"
required: true
requestBody:
required: true
Expand Down Expand Up @@ -712,9 +712,9 @@ paths:
required: true
- in: query
name: graphicTarget
description: "The Graphic to target with the command"
description: "The Graphic to target with the command (graphicInstanceId)"
schema:
$ref: "#/components/schemas/GraphicTarget"
$ref: "#/components/schemas/GraphicInstanceId"
required: true
requestBody:
required: true
Expand Down Expand Up @@ -787,9 +787,9 @@ paths:
required: true
- in: query
name: graphicTarget
description: "The Graphic to target with the command"
description: "The Graphic to target with the command (graphicInstanceId)"
schema:
$ref: "#/components/schemas/GraphicTarget"
$ref: "#/components/schemas/GraphicInstanceId"
required: true
requestBody:
required: true
Expand Down Expand Up @@ -971,16 +971,6 @@ components:
graphicInstanceId:
description: "(Optional) If set, will only affect a specific GraphicInstance"
type: string
GraphicTarget:
description: "If set, apply filters to which GraphicInstances to affect. If no filters are defined, ALL graphics will be cleared. If multiple filters are defined, only instances that match all filters will be affected."
type: object
properties:
graphicId:
description: "(Optional) If set, will only affect GraphicInstances of a certain Graphic id and version"
$ref: "#/components/schemas/GraphicId"
graphicInstanceId:
description: "(Optional) If set, will only affect a specific GraphicInstance"
$ref: "#/components/schemas/GraphicInstanceId"
# Ids
RendererId:
description: "ID of the Renderer"
Expand All @@ -994,7 +984,7 @@ components:
type: string
example: "simple-l3rd"
GraphicInstanceId:
description: "ID of the GraphicInstance"
description: "ID of an GraphicInstance. A GraphicInstance is a specific instance of a Graphic that is loaded onto a RenderTarget."
type: string
example: "graphic-instance-0"
# Objects
Expand Down