@things-factory/operato-board 9.2.5 → 10.0.0-beta.10

package/schema.graphql

@@ -459,6 +459,7 @@ enum AttributeSetItemType {
   datetime
   file
   number
+  secret
   select
   text
 }
@@ -986,9 +987,7 @@ input CommonCodePatch {
 
 """Represents a configured connection to an external system or service."""
 type Connection {
-  """
-  Indicates whether the connection is currently active and should be maintained.
-  """
+  """Whether to automatically connect when the application starts"""
   active: Boolean
 
   """The timestamp when the connection was created."""
@@ -1015,6 +1014,11 @@ type Connection {
   """The name of the connection."""
   name: String!
 
+  """
+  When true, connection is created on-demand when needed and cleaned up after use.
+  """
+  onDemand: Boolean
+
   """A key-value map of parameters for the connection."""
   params: Object
 
@@ -1042,7 +1046,7 @@ type ConnectionList {
 
 """Input for updating (patching) an existing connection."""
 input ConnectionPatch {
-  """The new active status for the connection."""
+  """Whether to automatically connect when the application starts"""
   active: Boolean
 
   """
@@ -1065,6 +1069,11 @@ input ConnectionPatch {
   """The new name for the connection."""
   name: String
 
+  """
+  When true, connection is created on-demand when needed and cleaned up after use.
+  """
+  onDemand: Boolean
+
   """The new parameters for the connection."""
   params: Object
 
@@ -1089,6 +1098,11 @@ type ConnectionState {
   """The name of the connection."""
   name: String
 
+  """
+  When true, connection is created on-demand when needed and cleaned up after use.
+  """
+  onDemand: Boolean
+
   """The current status of the connection."""
   state: String
 
@@ -1284,6 +1298,9 @@ type Domain {
   """A description of the domain."""
   description: String
 
+  """The environment variables associated with the domain."""
+  envVars: [EnvVar!]
+
   """The external type of the domain, if applicable."""
   extType: String
 
@@ -1729,6 +1746,68 @@ type EntityRelationMetadata {
   relationType: Boolean
 }
 
+"""Environment variable entity for storing key-value pairs."""
+type EnvVar {
+  """Indicates whether this environment variable is currently active."""
+  active: Boolean!
+
+  """The timestamp when the environment variable was created."""
+  createdAt: DateTimeISO
+
+  """A detailed description of the environment variable."""
+  description: String
+
+  """The domain to which this environment variable belongs."""
+  domain: Domain
+
+  """The domain ID to which this environment variable belongs."""
+  domainId: String!
+
+  """Unique identifier for the environment variable."""
+  id: ID!
+
+  """The name of the environment variable."""
+  name: String!
+
+  """The timestamp when the environment variable was last updated."""
+  updatedAt: DateTimeISO
+
+  """The value of the environment variable (encrypted)."""
+  value: String
+}
+
+"""List of environment variables."""
+type EnvVarList {
+  """The list of environment variable items."""
+  items: [EnvVar!]!
+
+  """The total number of environment variables."""
+  total: Int!
+}
+
+"""Input type for updating an existing environment variable."""
+input EnvVarPatch {
+  """The new active status for the environment variable."""
+  active: Boolean
+
+  """
+  A flag indicating whether the environment variable is being created, updated, or deleted.
+  """
+  cuFlag: String
+
+  """The new description for the environment variable."""
+  description: String
+
+  """The unique identifier of the environment variable to update."""
+  id: ID
+
+  """The new name for the environment variable."""
+  name: String
+
+  """The new value for the environment variable."""
+  value: String
+}
+
 """Entity for Favorite"""
 type Favorite {
   createdAt: DateTimeISO
@@ -2415,6 +2494,9 @@ type Mutation {
   """To create new EntityColumn"""
   createEntityColumn(entityColumn: NewEntityColumn!): EntityColumn!
 
+  """To create new EnvVar"""
+  createEnvVar(envVar: NewEnvVar!): EnvVar!
+
   """To create new Favorite"""
   createFavorite(favorite: NewFavorite!): Favorite!
 
@@ -2627,6 +2709,12 @@ type Mutation {
   """To delete multiple EntityColumns"""
   deleteEntityColumns(ids: [String!]!): Boolean!
 
+  """To delete EnvVar"""
+  deleteEnvVar(id: String!): Boolean!
+
+  """To delete multiple EnvVars"""
+  deleteEnvVars(ids: [String!]!): Boolean!
+
   """To delete Favorite"""
   deleteFavorite(routing: String!): Boolean!
 
@@ -2954,6 +3042,8 @@ type Mutation {
     """Employee Id"""
     employeeId: String!
   ): Boolean!
+
+  """Register a new schedule with the scheduler service."""
   registerSchedule(schedule: NewSchedule!): ID!
 
   """Releases a board, making it public and creating a version history."""
@@ -2982,7 +3072,7 @@ type Mutation {
   singleUpload(file: Upload!): Attachment!
 
   """Starts a new scenario instance, which will run in the background."""
-  startScenario(instanceName: String, scenarioName: String!, variables: Object): ScenarioInstance!
+  startScenario(instanceName: String, scenarioName: String!, variables: Object): ScenarioInstanceStartResult!
 
   """Starts the schedule for a specific scenario, if one is defined."""
   startScenarioSchedule(scenarioId: String!): Scenario!
@@ -3015,6 +3105,8 @@ type Mutation {
     """The username or email of the user to transfer ownership to."""
     username: String!
   ): Boolean!
+
+  """Unregister and remove a schedule from the scheduler service."""
   unregisterSchedule(handle: ID!): Boolean!
   updateAppliance(id: String!, patch: AppliancePatch!): Appliance!
   updateApplication(id: String!, patch: ApplicationPatch!): Application!
@@ -3080,6 +3172,9 @@ type Mutation {
   """To modify EntityColumn information"""
   updateEntityColumn(id: String!, patch: EntityColumnPatch!): EntityColumn!
 
+  """To modify EnvVar information"""
+  updateEnvVar(envVar: EnvVarPatch!, id: String!): EnvVar!
+
   """To modify Font information"""
   updateFont(id: String!, patch: FontPatch!): Font!
 
@@ -3145,6 +3240,9 @@ type Mutation {
   """To modify multiple Entitys' information"""
   updateMultipleEntityColumn(patches: [EntityColumnPatch!]!): [EntityColumn!]!
 
+  """To modify multiple EnvVars' information"""
+  updateMultipleEnvVars(patches: [EnvVarPatch!]!): [EnvVar!]!
+
   """To modify multiple Menus' information"""
   updateMultipleMenu(patches: [MenuPatch!]!): [Menu!]!
 
@@ -3251,6 +3349,8 @@ type Mutation {
 
   """Updates an existing scenario."""
   updateScenario(name: String!, patch: ScenarioPatch!): Scenario!
+
+  """Update an existing schedule configuration."""
   updateSchedule(schedule: SchedulePatch!): ID!
 
   """To update secure IP list for domain"""
@@ -3463,6 +3563,9 @@ input NewCommonCodeDetail {
 
 """Input for creating a new connection."""
 input NewConnection {
+  """Whether to automatically connect when the application starts"""
+  active: Boolean
+
   """A detailed description for the new connection."""
   description: String
 
@@ -3475,6 +3578,11 @@ input NewConnection {
   """The name for the new connection."""
   name: String!
 
+  """
+  When true, connection is created on-demand when needed and cleaned up after use.
+  """
+  onDemand: Boolean
+
   """A key-value map of parameters for the new connection."""
   params: Object
 
@@ -3598,6 +3706,21 @@ input NewEntityColumn {
   virtualField: Boolean
 }
 
+"""Input type for creating a new environment variable."""
+input NewEnvVar {
+  """Indicates whether this environment variable is active."""
+  active: Boolean
+
+  """A detailed description for the new environment variable."""
+  description: String
+
+  """The name for the new environment variable."""
+  name: String!
+
+  """The value for the new environment variable."""
+  value: String
+}
+
 input NewFavorite {
   routing: String!
 }
@@ -3870,18 +3993,10 @@ input NewPrinterDevice {
   type: String
 }
 
-"""Input for creating a new privilege."""
 input NewPrivilege {
-  """The category of the new privilege."""
   category: String!
-
-  """A description for the new privilege."""
   description: String
-
-  """The name of the new privilege."""
   name: String!
-
-  """Roles to which the new privilege will be assigned."""
   roles: [ObjectRef!]
 }
 
@@ -3908,6 +4023,9 @@ input NewScenario {
   """A detailed description for the new scenario."""
   description: String
 
+  """Iteration for scenario execution: SELF, CHILDREN, or SELF & CHILDREN."""
+  iteration: String
+
   """The name of the new scenario."""
   name: String!
 
@@ -3927,12 +4045,24 @@ input NewScenario {
   type: String
 }
 
+"""Input type for creating a new schedule with complete configuration."""
 input NewSchedule {
+  """Client configuration for this schedule."""
   client: ScheduleClientInput!
+
+  """Name of the schedule for identification."""
   name: String!
+
+  """Schedule expression (cron expression, date string, or delay value)."""
   schedule: String
+
+  """Task configuration and execution details for this schedule."""
   task: ScheduleTaskInput!
+
+  """Timezone for the schedule execution (e.g., UTC, Asia/Seoul)."""
   timezone: String
+
+  """Type of schedule timing (now, delay, date, cron, delay-recur)."""
   type: String!
 }
 
@@ -3945,13 +4075,20 @@ input NewSetting {
 
 """Input for creating a new state register."""
 input NewStateRegister {
+  """
+  Whether to automatically publish state changes. If true, state changes will be published using the name as the tag.
+  """
+  autoPublish: Boolean
+
   """Description of the state register"""
   description: String
 
   """Group name for the state register"""
   group: String
 
-  """Name of the state register"""
+  """
+  Name of the state register. If autoPublish is enabled, this name is used as the publish tag.
+  """
   name: String!
 
   """Number of decimal places if the state is a number type"""
@@ -4738,12 +4875,8 @@ type Privilege {
   updater: User
 }
 
-"""A paginated list of privileges."""
 type PrivilegeList {
-  """The list of privilege items."""
   items: [Privilege!]
-
-  """The total number of privileges."""
   total: Int
 }
 
@@ -4762,21 +4895,11 @@ type PrivilegeObject {
   super: Boolean
 }
 
-"""Input for updating (patching) an existing privilege."""
 input PrivilegePatch {
-  """The new category for the privilege."""
   category: String
-
-  """The new description for the privilege."""
   description: String
-
-  """The unique identifier of the privilege to update."""
   id: String
-
-  """The new name for the privilege."""
   name: String
-
-  """A new list of roles to be assigned to the privilege."""
   roles: [ObjectRef!]
 }
 
@@ -4818,8 +4941,15 @@ type PropertySpec {
   """CSS styles to be applied to the input field."""
   styles: Object
 
-  """The data type of the property (e.g., text, number, boolean, select)."""
+  """
+  The data type of the property (e.g., text, number, boolean, select, password).
+  """
   type: String!
+
+  """
+  Whether this property should use Domain attributes for secure storage instead of direct params.
+  """
+  useDomainAttribute: Boolean
 }
 
 type Query {
@@ -5351,6 +5481,20 @@ type Query {
 
   """To fetch a EntityMetadata"""
   entityMetadata(name: String!): EntityMetadata!
+  envVar(id: String!): EnvVar
+  envVars(
+    """An array of filter conditions to apply to the list query."""
+    filters: [Filter!]
+
+    """Inherited value type for the list query."""
+    inherited: InheritedValueType
+
+    """Pagination options for the list query."""
+    pagination: Pagination
+
+    """Sorting options for the list query."""
+    sortings: [Sorting!]
+  ): EnvVarList!
 
   """To fetch a Favorite"""
   favorite(id: String!): Favorite!
@@ -5889,9 +6033,13 @@ type Query {
     """Sorting options for the list query."""
     sortings: [Sorting!]
   ): ScenarioList!
+
+  """Retrieve a single schedule by its unique identifier."""
   schedule(id: ID!): Schedule
 
-  """To fetch multiple Schedules"""
+  """
+  Retrieve a paginated list of schedules with filtering capabilities by name, application, group, type, key, and operation.
+  """
   schedules(
     """An array of filter conditions to apply to the list query."""
     filters: [Filter!]
@@ -6162,7 +6310,7 @@ type RolePrivilege {
 """Represents a sequence of steps designed to automate a task or process."""
 type Scenario {
   """
-  Indicates if the scenario should be automatically started when the server starts. [will be deprecated]
+  Indicates if the scenario should be automatically started when the server starts.
   """
   active: Boolean
   connectionNames: [Connection!]!
@@ -6183,6 +6331,9 @@ type Scenario {
   id: ID!
   instances: [ScenarioInstance!]
 
+  """Iteration for scenario execution: SELF, CHILDREN, or SELF & CHILDREN."""
+  iteration: String
+
   """The name of the scenario."""
   name: String!
 
@@ -6312,6 +6463,18 @@ type ScenarioInstanceRunResult {
   variables: Object
 }
 
+"""Contains the final result of a completed scenario instance start."""
+type ScenarioInstanceStartResult {
+  """A final message from the run (e.g., success or failure reason)."""
+  message: String
+
+  """The final state of the instance after the run."""
+  state: String
+
+  """The timestamp when the instance started."""
+  timestamp: DateTimeISO
+}
+
 """
 Represents the complete state of a scenario instance at a point in time.
 """
@@ -6364,7 +6527,9 @@ type ScenarioList {
 
 """Input for updating (patching) an existing scenario."""
 input ScenarioPatch {
-  """The new active status for the scenario."""
+  """
+  Indicates if the scenario should be automatically started when the server starts.
+  """
   active: Boolean
 
   """
@@ -6378,6 +6543,11 @@ input ScenarioPatch {
   """The unique identifier of the scenario to update."""
   id: ID
 
+  """
+  The new iteration for scenario execution: SELF, CHILDREN, or SELF & CHILDREN.
+  """
+  iteration: String
+
   """The new name for the scenario."""
   name: String
 
@@ -6409,78 +6579,198 @@ type ScenarioQueueState {
   queue: [PendingObject!]!
 }
 
+"""
+Represents a scheduled task with timing configuration, client settings, and task execution details.
+"""
 type Schedule {
+  """Client configuration for this schedule."""
   client: ScheduleClient!
+
+  """Unique identifier for the schedule."""
   id: ID!
+
+  """Name of the schedule for identification."""
   name: String
+
+  """Schedule expression (cron expression, date string, or delay value)."""
   schedule: String
+
+  """Task configuration and execution details for this schedule."""
   task: ScheduleTask!
+
+  """Timezone for the schedule execution (e.g., UTC, Asia/Seoul)."""
   timezone: String
+
+  """Type of schedule timing (now, delay, date, cron, delay-recur)."""
   type: String!
 }
 
+"""
+Represents a schedule client configuration that defines the application, group, type, key, and operation for scheduled tasks.
+"""
 type ScheduleClient {
+  """Name of the application that owns this schedule."""
   application: String!
+
+  """Group identifier for organizing related schedules."""
   group: String!
+
+  """Unique key identifier for the schedule."""
   key: String!
+
+  """
+  Operation to be performed by this schedule (e.g., start, stop, collect, report).
+  """
   operation: String!
+
+  """
+  Type of the schedule client (e.g., data collection, reporting, maintenance).
+  """
   type: String!
 }
 
+"""Input type for schedule client configuration."""
 input ScheduleClientInput {
+  """Name of the application that owns this schedule."""
   application: String!
+
+  """Group identifier for organizing related schedules."""
   group: String!
+
+  """Unique key identifier for the schedule."""
   key: String!
+
+  """
+  Operation to be performed by this schedule (e.g., start, stop, collect, report).
+  """
   operation: String!
+
+  """
+  Type of the schedule client (e.g., data collection, reporting, maintenance).
+  """
   type: String!
 }
 
+"""Represents a paginated list of schedules with total count."""
 type ScheduleList {
+  """Array of schedule objects."""
   items: [Schedule!]!
+
+  """Total number of schedules matching the query criteria."""
   total: Int!
 }
 
+"""Input type for updating an existing schedule configuration."""
 input SchedulePatch {
+  """Client configuration for this schedule."""
   client: ScheduleClientInput!
+
+  """Unique identifier for the schedule to update."""
   id: String
+
+  """Name of the schedule for identification."""
   name: String
+
+  """Schedule expression (cron expression, date string, or delay value)."""
   schedule: String
+
+  """Task configuration and execution details for this schedule."""
   task: ScheduleTaskInput!
+
+  """Timezone for the schedule execution (e.g., UTC, Asia/Seoul)."""
   timezone: String
+
+  """Type of schedule timing (now, delay, date, cron, delay-recur)."""
   type: String!
 }
 
+"""
+Represents a scheduled task with connection settings, data payload, and retry policies.
+"""
 type ScheduleTask {
+  """Connection configuration for the scheduled task."""
   connection: ScheduleTaskConnection!
+
+  """Data payload to be sent with the scheduled task."""
   data: Object!
+
+  """Policy for handling failed task executions (ignore, retry, retry_dlq)."""
   failed_policy: String!
+
+  """Indicates whether to check task execution history before scheduling."""
   history_check: Boolean!
+
+  """Maximum number of retry attempts allowed for this task."""
   max_retry_count: Int!
+
+  """Current number of retry attempts for this task."""
   retry_count: Int!
+
+  """Wait time in seconds before retrying a failed task."""
   retry_wait: Int!
+
+  """Type of the scheduled task (rest, kafka, redis)."""
   type: String!
 }
 
+"""
+Represents the connection configuration for a scheduled task, including host, headers, and topic settings.
+"""
 type ScheduleTaskConnection {
+  """HTTP headers for REST API connections or connection parameters."""
   headers: Object
+
+  """
+  Host URL for the task connection (e.g., REST API endpoint, Kafka broker, Redis server).
+  """
   host: String
+
+  """
+  Topic name for message-based connections (e.g., Kafka topic, Redis channel).
+  """
   topic: String
 }
 
+"""Input type for schedule task connection configuration."""
 input ScheduleTaskConnectionInput {
+  """HTTP headers for REST API connections or connection parameters."""
   headers: Object
+
+  """
+  Host URL for the task connection (e.g., REST API endpoint, Kafka broker, Redis server).
+  """
   host: String
+
+  """
+  Topic name for message-based connections (e.g., Kafka topic, Redis channel).
+  """
   topic: String
 }
 
+"""Input type for schedule task configuration."""
 input ScheduleTaskInput {
+  """Connection configuration for the scheduled task."""
   connection: ScheduleTaskConnectionInput!
+
+  """Data payload to be sent with the scheduled task."""
   data: Object!
+
+  """Policy for handling failed task executions (ignore, retry, retry_dlq)."""
   failed_policy: String!
+
+  """Indicates whether to check task execution history before scheduling."""
   history_check: Boolean!
+
+  """Maximum number of retry attempts allowed for this task."""
   max_retry_count: Int!
+
+  """Current number of retry attempts for this task."""
   retry_count: Int!
+
+  """Wait time in seconds before retrying a failed task."""
   retry_wait: Int!
+
+  """Type of the scheduled task (rest, kafka, redis)."""
   type: String!
 }
 
@@ -6525,6 +6815,11 @@ input Sorting {
 Represents a key-value store for maintaining the state of various entities within a domain.
 """
 type StateRegister {
+  """
+  Whether to automatically publish state changes. If true, state changes will be published using the name as the tag.
+  """
+  autoPublish: Boolean
+
   """Creation time of the state register"""
   createdAt: DateTimeISO
 
@@ -6549,7 +6844,9 @@ type StateRegister {
   """Unique identifier for the state register."""
   id: ID!
 
-  """Name of the state register"""
+  """
+  Name of the state register. If autoPublish is enabled, this name is used as the publish tag.
+  """
   name: String
 
   """Number of decimal places if the state is a number type"""
@@ -6602,6 +6899,11 @@ type StateRegisterList {
 
 """Input for updating (patching) an existing state register."""
 input StateRegisterPatch {
+  """
+  Whether to automatically publish state changes. If true, state changes will be published using the name as the tag.
+  """
+  autoPublish: Boolean
+
   """Flag indicating create/update operations"""
   cuFlag: String
 
@@ -6614,7 +6916,9 @@ input StateRegisterPatch {
   """ID of the state register"""
   id: ID
 
-  """Name of the state register"""
+  """
+  Name of the state register. If autoPublish is enabled, this name is used as the publish tag.
+  """
   name: String
 
   """Number of decimal places if the state is a number type"""