{ "components": { "schemas": { "OrganizationActionType": { "enum": [ "api-key-create", "api-key-delete", "api-key-update", "oauth-consent-deny", "oauth-consent-grant", "organization-create", "organization-delete", "organization-update", "organization-user-add", "organization-user-invite-create", "organization-user-invite-revoke", "organization-user-remove", "organization-user-update", "team-create", "team-delete", "team-update", "user-login", "user-login-failed", "user-logout" ], "type": "string" }, "LandscapeActionType": { "enum": [ "comment-create", "comment-delete", "comment-reply-create", "comment-reply-delete", "comment-reply-update", "comment-update", "diagram-content-create", "diagram-content-delete", "diagram-content-update", "diagram-content-view", "diagram-create", "diagram-delete", "diagram-export", "diagram-group-create", "diagram-group-delete", "diagram-group-update", "diagram-update", "domain-create", "domain-delete", "domain-update", "draft-create", "draft-delete", "draft-merge", "draft-task-create", "draft-update", "draft-view", "flow-create", "flow-delete", "flow-update", "flow-view", "landscape-copy", "landscape-create", "landscape-delete", "landscape-duplicate", "landscape-export", "landscape-import", "landscape-update", "model-connection-create", "model-connection-delete", "model-connection-update", "model-connections-export", "model-object-create", "model-object-delete", "model-object-dependencies-export", "model-object-update", "model-objects-export", "share-link-create", "share-link-delete", "share-link-update", "tag-create", "tag-delete", "tag-group-create", "tag-group-delete", "tag-group-update", "tag-update", "version-create", "version-delete", "version-revert-create" ], "type": "string" }, "ActionType": { "enum": [ "api-key-create", "api-key-delete", "api-key-update", "oauth-consent-deny", "oauth-consent-grant", "organization-create", "organization-delete", "organization-update", "organization-user-add", "organization-user-invite-create", "organization-user-invite-revoke", "organization-user-remove", "organization-user-update", "team-create", "team-delete", "team-update", "user-login", "user-login-failed", "user-logout", "comment-create", "comment-delete", "comment-reply-create", "comment-reply-delete", "comment-reply-update", "comment-update", "diagram-content-create", "diagram-content-delete", "diagram-content-update", "diagram-content-view", "diagram-create", "diagram-delete", "diagram-export", "diagram-group-create", "diagram-group-delete", "diagram-group-update", "diagram-update", "domain-create", "domain-delete", "domain-update", "draft-create", "draft-delete", "draft-merge", "draft-task-create", "draft-update", "draft-view", "flow-create", "flow-delete", "flow-update", "flow-view", "landscape-copy", "landscape-create", "landscape-delete", "landscape-duplicate", "landscape-export", "landscape-import", "landscape-update", "model-connection-create", "model-connection-delete", "model-connection-update", "model-connections-export", "model-object-create", "model-object-delete", "model-object-dependencies-export", "model-object-update", "model-objects-export", "share-link-create", "share-link-delete", "share-link-update", "tag-create", "tag-delete", "tag-group-create", "tag-group-delete", "tag-group-update", "tag-update", "version-create", "version-delete", "version-revert-create" ], "type": "string" }, "ActionContextModelObject": { "properties": { "handleId": { "type": "string" }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/ModelObjectType" } }, "required": [ "handleId", "name", "type" ], "type": "object" }, "ActionCommentCreateContext": { "properties": { "domainHandleId": { "type": "string" }, "domainName": { "type": "string" }, "modelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" }, "targetHandleId": { "type": "string" }, "targetName": { "type": "string" } }, "type": "object" }, "ActionCommentCreate": { "properties": { "context": { "$ref": "#/components/schemas/ActionCommentCreateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/CommentRequired" }, "type": { "enum": [ "comment-create" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionCommentUpdateContext": { "properties": { "domainHandleId": { "type": "string" }, "domainName": { "type": "string" }, "modelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" }, "targetHandleId": { "type": "string" }, "targetName": { "type": "string" } }, "type": "object" }, "ActionCommentUpdate": { "properties": { "context": { "$ref": "#/components/schemas/ActionCommentUpdateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/CommentPartial" }, "type": { "enum": [ "comment-update" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionCommentDeleteContext": { "properties": { "domainHandleId": { "type": "string" }, "domainName": { "type": "string" }, "modelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" }, "targetHandleId": { "type": "string" }, "targetName": { "type": "string" } }, "type": "object" }, "ActionCommentDelete": { "properties": { "context": { "$ref": "#/components/schemas/ActionCommentDeleteContext" }, "id": { "type": "string" }, "type": { "enum": [ "comment-delete" ], "type": "string" } }, "required": [ "context", "id", "type" ], "type": "object" }, "ActionCommentReplyCreateContext": { "properties": { "commentHandleId": { "type": "string" }, "domainHandleId": { "type": "string" }, "domainName": { "type": "string" } }, "type": "object" }, "ActionCommentReplyCreate": { "properties": { "context": { "$ref": "#/components/schemas/ActionCommentReplyCreateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/CommentReplyRequired" }, "type": { "enum": [ "comment-reply-create" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionCommentReplyUpdateContext": { "properties": { "commentHandleId": { "type": "string" }, "domainHandleId": { "type": "string" }, "domainName": { "type": "string" } }, "type": "object" }, "ActionCommentReplyUpdate": { "properties": { "context": { "$ref": "#/components/schemas/ActionCommentReplyUpdateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/CommentReplyPartial" }, "type": { "enum": [ "comment-reply-update" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionCommentReplyDeleteContext": { "properties": { "commentHandleId": { "type": "string" }, "domainHandleId": { "type": "string" }, "domainName": { "type": "string" } }, "type": "object" }, "ActionCommentReplyDelete": { "properties": { "context": { "$ref": "#/components/schemas/ActionCommentReplyDeleteContext" }, "id": { "type": "string" }, "type": { "enum": [ "comment-reply-delete" ], "type": "string" } }, "required": [ "context", "id", "type" ], "type": "object" }, "ActionDiagramContentContextComment": { "properties": { "commentBodyType": { "$ref": "#/components/schemas/CommentBodyType" }, "commentHandleId": { "type": "string" } }, "required": [ "commentHandleId", "commentBodyType" ], "type": "object" }, "ActionDiagramContentContextConnection": { "properties": { "modelHandleId": { "nullable": true, "type": "string" }, "modelName": { "nullable": true, "type": "string" } }, "required": [ "modelHandleId", "modelName" ], "type": "object" }, "ActionDiagramContentContextObject": { "properties": { "modelHandleId": { "type": "string" }, "modelName": { "type": "string" }, "modelType": { "$ref": "#/components/schemas/ModelObjectType" }, "type": { "$ref": "#/components/schemas/DiagramObjectType" } }, "required": [ "modelHandleId", "modelName", "modelType", "type" ], "type": "object" }, "ActionDiagramContentCreateContext": { "properties": { "comments": { "additionalProperties": { "$ref": "#/components/schemas/ActionDiagramContentContextComment" }, "type": "object" }, "connections": { "additionalProperties": { "$ref": "#/components/schemas/ActionDiagramContentContextConnection" }, "type": "object" }, "domainHandleId": { "type": "string" }, "domainName": { "type": "string" }, "groupHandleId": { "type": "string" }, "groupName": { "type": "string" }, "modelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" }, "name": { "type": "string" }, "objects": { "additionalProperties": { "$ref": "#/components/schemas/ActionDiagramContentContextObject" }, "type": "object" }, "type": { "$ref": "#/components/schemas/DiagramType" } }, "required": [ "name", "type" ], "type": "object" }, "ActionDiagramContentCreate": { "properties": { "context": { "$ref": "#/components/schemas/ActionDiagramContentCreateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/DiagramContentRequired" }, "type": { "enum": [ "diagram-content-create" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionDiagramContentUpdateContext": { "properties": { "comments": { "additionalProperties": { "$ref": "#/components/schemas/ActionDiagramContentContextComment" }, "type": "object" }, "connections": { "additionalProperties": { "$ref": "#/components/schemas/ActionDiagramContentContextConnection" }, "type": "object" }, "domainHandleId": { "type": "string" }, "domainName": { "type": "string" }, "groupHandleId": { "type": "string" }, "groupName": { "type": "string" }, "modelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" }, "name": { "type": "string" }, "objects": { "additionalProperties": { "$ref": "#/components/schemas/ActionDiagramContentContextObject" }, "type": "object" }, "type": { "$ref": "#/components/schemas/DiagramType" } }, "required": [ "name", "type" ], "type": "object" }, "ActionDiagramContentUpdate": { "properties": { "context": { "$ref": "#/components/schemas/ActionDiagramContentUpdateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/DiagramContentPartial" }, "type": { "enum": [ "diagram-content-update" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionDiagramContentDeleteContext": { "properties": { "domainHandleId": { "type": "string" }, "domainName": { "type": "string" }, "modelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/DiagramType" } }, "required": [ "name", "type" ], "type": "object" }, "ActionDiagramContentDelete": { "properties": { "context": { "$ref": "#/components/schemas/ActionDiagramContentDeleteContext" }, "id": { "type": "string" }, "type": { "enum": [ "diagram-content-delete" ], "type": "string" } }, "required": [ "context", "id", "type" ], "type": "object" }, "ActionDiagramContentViewContext": { "properties": { "domainHandleId": { "type": "string" }, "domainName": { "type": "string" }, "modelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/DiagramType" } }, "required": [ "name", "type" ], "type": "object" }, "ActionDiagramContentView": { "properties": { "context": { "$ref": "#/components/schemas/ActionDiagramContentViewContext" }, "id": { "type": "string" }, "type": { "enum": [ "diagram-content-view" ], "type": "string" } }, "required": [ "context", "id", "type" ], "type": "object" }, "ActionDiagramGroupCreateContext": { "properties": { "domainHandleId": { "type": "string" }, "domainName": { "type": "string" }, "modelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" } }, "type": "object" }, "ActionDiagramGroupCreate": { "properties": { "context": { "$ref": "#/components/schemas/ActionDiagramGroupCreateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/DiagramGroupRequired" }, "type": { "enum": [ "diagram-group-create" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionDiagramGroupUpdateContext": { "properties": { "domainHandleId": { "type": "string" }, "domainName": { "type": "string" }, "modelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" }, "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "ActionDiagramGroupUpdate": { "properties": { "context": { "$ref": "#/components/schemas/ActionDiagramGroupUpdateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/DiagramGroupPartial" }, "type": { "enum": [ "diagram-group-update" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionDiagramGroupDeleteContext": { "properties": { "domainHandleId": { "type": "string" }, "domainName": { "type": "string" }, "modelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" }, "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "ActionDiagramGroupDelete": { "properties": { "context": { "$ref": "#/components/schemas/ActionDiagramGroupDeleteContext" }, "id": { "type": "string" }, "type": { "enum": [ "diagram-group-delete" ], "type": "string" } }, "required": [ "context", "id", "type" ], "type": "object" }, "ActionDomainCreate": { "properties": { "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/DomainRequired" }, "type": { "enum": [ "domain-create" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "ActionDomainUpdateContext": { "properties": { "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "ActionDomainUpdate": { "properties": { "context": { "$ref": "#/components/schemas/ActionDomainUpdateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/DomainPartial" }, "type": { "enum": [ "domain-update" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionDomainDeleteContext": { "properties": { "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "ActionDomainDelete": { "properties": { "context": { "$ref": "#/components/schemas/ActionDomainDeleteContext" }, "id": { "type": "string" }, "type": { "enum": [ "domain-delete" ], "type": "string" } }, "required": [ "context", "id", "type" ], "type": "object" }, "ActionFlowCreateContext": { "properties": { "diagramHandleId": { "type": "string" }, "diagramName": { "type": "string" }, "diagramType": { "$ref": "#/components/schemas/DiagramType" }, "domainHandleId": { "type": "string" }, "domainName": { "type": "string" }, "modelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" } }, "type": "object" }, "ActionFlowCreate": { "properties": { "context": { "$ref": "#/components/schemas/ActionFlowCreateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/FlowRequired" }, "type": { "enum": [ "flow-create" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionFlowContextObject": { "properties": { "type": { "$ref": "#/components/schemas/DiagramObjectType" } }, "required": [ "type" ], "type": "object" }, "ActionFlowUpdateContext": { "properties": { "diagramHandleId": { "type": "string" }, "diagramName": { "type": "string" }, "diagramType": { "$ref": "#/components/schemas/DiagramType" }, "domainHandleId": { "type": "string" }, "domainName": { "type": "string" }, "modelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" }, "name": { "type": "string" }, "objects": { "additionalProperties": { "$ref": "#/components/schemas/ActionFlowContextObject" }, "type": "object" } }, "required": [ "name" ], "type": "object" }, "ActionFlowUpdate": { "properties": { "context": { "$ref": "#/components/schemas/ActionFlowUpdateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/FlowPartial" }, "type": { "enum": [ "flow-update" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionFlowDeleteContext": { "properties": { "diagramHandleId": { "type": "string" }, "diagramName": { "type": "string" }, "diagramType": { "$ref": "#/components/schemas/DiagramType" }, "domainHandleId": { "type": "string" }, "domainName": { "type": "string" }, "modelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" }, "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "ActionFlowDelete": { "properties": { "context": { "$ref": "#/components/schemas/ActionFlowDeleteContext" }, "id": { "type": "string" }, "type": { "enum": [ "flow-delete" ], "type": "string" } }, "required": [ "context", "id", "type" ], "type": "object" }, "ActionFlowViewContext": { "properties": { "diagramHandleId": { "type": "string" }, "diagramName": { "type": "string" }, "diagramType": { "$ref": "#/components/schemas/DiagramType" }, "domainHandleId": { "type": "string" }, "domainName": { "type": "string" }, "modelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" }, "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "ActionFlowView": { "properties": { "context": { "$ref": "#/components/schemas/ActionFlowViewContext" }, "id": { "type": "string" }, "type": { "enum": [ "flow-view" ], "type": "string" } }, "required": [ "context", "id", "type" ], "type": "object" }, "ActionTagCreateContext": { "properties": { "groupHandleId": { "type": "string" }, "groupName": { "type": "string" } }, "type": "object" }, "ActionTagCreate": { "properties": { "context": { "$ref": "#/components/schemas/ActionTagCreateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/TagRequired" }, "type": { "enum": [ "tag-create" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionTagUpdateContext": { "properties": { "groupHandleId": { "type": "string" }, "groupName": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "ActionTagUpdate": { "properties": { "context": { "$ref": "#/components/schemas/ActionTagUpdateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/TagPartial" }, "type": { "enum": [ "tag-update" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionTagDeleteContext": { "properties": { "groupHandleId": { "type": "string" }, "groupName": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "ActionTagDelete": { "properties": { "context": { "$ref": "#/components/schemas/ActionTagDeleteContext" }, "id": { "type": "string" }, "type": { "enum": [ "tag-delete" ], "type": "string" } }, "required": [ "context", "id", "type" ], "type": "object" }, "ActionTagGroupCreate": { "properties": { "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/TagGroupRequired" }, "type": { "enum": [ "tag-group-create" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "ActionTagGroupUpdateContext": { "properties": { "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "ActionTagGroupUpdate": { "properties": { "context": { "$ref": "#/components/schemas/ActionTagGroupUpdateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/TagGroupPartial" }, "type": { "enum": [ "tag-group-update" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionTagGroupDeleteContext": { "properties": { "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "ActionTagGroupDelete": { "properties": { "context": { "$ref": "#/components/schemas/ActionTagGroupDeleteContext" }, "id": { "type": "string" }, "type": { "enum": [ "tag-group-delete" ], "type": "string" } }, "required": [ "context", "id", "type" ], "type": "object" }, "OrganizationAction": { "oneOf": [ { "$ref": "#/components/schemas/ActionApiKey" }, { "$ref": "#/components/schemas/ActionOAuth" }, { "$ref": "#/components/schemas/ActionOrganization" }, { "$ref": "#/components/schemas/ActionOrganizationUser" }, { "$ref": "#/components/schemas/ActionOrganizationUserInvite" }, { "$ref": "#/components/schemas/ActionTeam" }, { "$ref": "#/components/schemas/ActionUser" } ] }, "LandscapeAction": { "oneOf": [ { "$ref": "#/components/schemas/ActionCommentCreate" }, { "$ref": "#/components/schemas/ActionCommentUpdate" }, { "$ref": "#/components/schemas/ActionCommentDelete" }, { "$ref": "#/components/schemas/ActionCommentReplyCreate" }, { "$ref": "#/components/schemas/ActionCommentReplyUpdate" }, { "$ref": "#/components/schemas/ActionCommentReplyDelete" }, { "$ref": "#/components/schemas/ActionDiagramContentCreate" }, { "$ref": "#/components/schemas/ActionDiagramContentUpdate" }, { "$ref": "#/components/schemas/ActionDiagramContentDelete" }, { "$ref": "#/components/schemas/ActionDiagramContentView" }, { "$ref": "#/components/schemas/ActionDiagram" }, { "$ref": "#/components/schemas/ActionDiagramGroupCreate" }, { "$ref": "#/components/schemas/ActionDiagramGroupUpdate" }, { "$ref": "#/components/schemas/ActionDiagramGroupDelete" }, { "$ref": "#/components/schemas/ActionDomainCreate" }, { "$ref": "#/components/schemas/ActionDomainUpdate" }, { "$ref": "#/components/schemas/ActionDomainDelete" }, { "$ref": "#/components/schemas/ActionDraft" }, { "$ref": "#/components/schemas/ActionDraftTaskCreate" }, { "$ref": "#/components/schemas/ActionLandscape" }, { "$ref": "#/components/schemas/ActionModelObject" }, { "$ref": "#/components/schemas/ActionModelConnection" }, { "$ref": "#/components/schemas/ActionShareLink" }, { "$ref": "#/components/schemas/ActionFlowCreate" }, { "$ref": "#/components/schemas/ActionFlowUpdate" }, { "$ref": "#/components/schemas/ActionFlowDelete" }, { "$ref": "#/components/schemas/ActionFlowView" }, { "$ref": "#/components/schemas/ActionTagCreate" }, { "$ref": "#/components/schemas/ActionTagUpdate" }, { "$ref": "#/components/schemas/ActionTagDelete" }, { "$ref": "#/components/schemas/ActionTagGroupCreate" }, { "$ref": "#/components/schemas/ActionTagGroupUpdate" }, { "$ref": "#/components/schemas/ActionTagGroupDelete" }, { "$ref": "#/components/schemas/ActionVersion" } ] }, "Action": { "oneOf": [ { "$ref": "#/components/schemas/OrganizationAction" }, { "$ref": "#/components/schemas/LandscapeAction" } ] }, "ActionLogFilterActionType": { "description": "type of action that was performed, eg: diagram-content-update or model-object-create", "oneOf": [ { "$ref": "#/components/schemas/LandscapeActionType" }, { "items": { "$ref": "#/components/schemas/LandscapeActionType" }, "maxItems": 100, "type": "array" }, { "properties": { "$not": { "oneOf": [ { "$ref": "#/components/schemas/LandscapeActionType" }, { "items": { "$ref": "#/components/schemas/LandscapeActionType" }, "maxItems": 100, "type": "array" } ] } }, "type": "object" } ] }, "ActionLogFilter": { "properties": { "actionId": { "description": "id of the entity to lookup, eg: id of the tag being created, or id of the model object being updated", "type": "string" }, "actionType": { "$ref": "#/components/schemas/ActionLogFilterActionType" }, "endAtDate": { "format": "date-time", "type": "string" }, "endAtId": { "deprecated": true, "description": "use cursor instead", "type": "string" }, "endBeforeDate": { "format": "date-time", "type": "string" }, "endBeforeId": { "deprecated": true, "description": "use cursor instead", "type": "string" }, "includeActionsInContext": { "description": "include actions from objects inside the context, eg: update of a model connection that is connected to a model object", "type": "boolean" }, "performedBy": { "oneOf": [ { "$ref": "#/components/schemas/AuthType" }, { "items": { "$ref": "#/components/schemas/AuthType" }, "maxItems": 100, "type": "array" } ] }, "performedById": { "description": "id of the user or api key who performed the action", "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "maxItems": 100, "type": "array" } ] }, "startAfterDate": { "format": "date-time", "type": "string" }, "startAfterId": { "deprecated": true, "description": "use cursor instead", "type": "string" }, "startAtDate": { "format": "date-time", "type": "string" }, "startAtId": { "deprecated": true, "description": "use cursor instead", "type": "string" } }, "type": "object" }, "ActionLog": { "properties": { "action": { "$ref": "#/components/schemas/Action", "description": "full description of the action that happened" }, "actionIds": { "description": "id of the action and any related ids that were part of the action", "items": { "type": "string" }, "type": "array" }, "id": { "type": "string" }, "landscapeId": { "type": "string" }, "parentId": { "description": "parent action log id that caused this action to happen, eg: update of a diagram caused by a model object delete", "nullable": true, "type": "string" }, "performedAt": { "format": "date-time", "type": "string" }, "performedBy": { "$ref": "#/components/schemas/AuthType" }, "performedByAuthProvider": { "type": "string" }, "performedByClientId": { "type": "string" }, "performedById": { "type": "string" }, "performedByIp": { "description": "ip address of the user or api key who performed the action", "type": "string" }, "performedByName": { "type": "string" }, "performedByUserAgent": { "type": "string" } }, "required": [ "action", "actionIds", "id", "landscapeId", "parentId", "performedAt", "performedBy", "performedById" ], "type": "object" }, "ActionLogStatsPeriod": { "enum": [ "day", "week", "month", "year", "all" ], "type": "string" }, "ActionLogStatsFilter": { "properties": { "actionType": { "description": "type of action that was performed, eg: diagram-content-update or model-object-create", "oneOf": [ { "$ref": "#/components/schemas/LandscapeActionType" }, { "items": { "$ref": "#/components/schemas/LandscapeActionType" }, "maxItems": 100, "type": "array" } ] }, "endAtDate": { "format": "date-time", "type": "string" }, "entityId": { "description": "id of the entity to lookup, eg: id of the tag being created, or id of the model object being updated", "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "maxItems": 100, "type": "array" } ] }, "performedBy": { "oneOf": [ { "$ref": "#/components/schemas/AuthType" }, { "items": { "$ref": "#/components/schemas/AuthType" }, "maxItems": 100, "type": "array" } ] }, "performedById": { "description": "id of the user or api key who performed the action", "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "maxItems": 100, "type": "array" } ] }, "startAtDate": { "format": "date-time", "type": "string" } }, "type": "object" }, "ActionLogStatsContributor": { "properties": { "contributedAt": { "format": "date-time", "type": "string" }, "count": { "type": "number" }, "id": { "type": "string" }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/AuthType" } }, "required": [ "contributedAt", "count", "id", "type" ], "type": "object" }, "ActionLogStatsItemByType": { "properties": { "contributors": { "additionalProperties": { "$ref": "#/components/schemas/ActionLogStatsContributor" }, "type": "object" }, "count": { "type": "number" }, "type": { "$ref": "#/components/schemas/LandscapeActionType", "description": "type of action that was performed, eg: diagram-content-update or model-object-create" } }, "required": [ "contributors", "count", "type" ], "type": "object" }, "ActionLogStatsItemByEntity": { "properties": { "contributors": { "additionalProperties": { "$ref": "#/components/schemas/ActionLogStatsContributor" }, "type": "object" }, "count": { "type": "number" }, "entityId": { "description": "id of the entity to lookup, eg: id of the tag being created, or id of the model object being updated", "type": "string" } }, "required": [ "contributors", "count", "entityId" ], "type": "object" }, "ActionLogStatsDateByType": { "properties": { "actions": { "additionalProperties": { "$ref": "#/components/schemas/ActionLogStatsItemByType" }, "type": "object" }, "date": { "format": "date-time", "type": "string" } }, "required": [ "actions", "date" ], "type": "object" }, "ActionLogStatsDateByEntity": { "properties": { "date": { "format": "date-time", "type": "string" }, "entities": { "additionalProperties": { "$ref": "#/components/schemas/ActionLogStatsItemByEntity" }, "type": "object" } }, "required": [ "date", "entities" ], "type": "object" }, "ActionLogStatsListByType": { "properties": { "contributors": { "additionalProperties": { "$ref": "#/components/schemas/ActionLogStatsContributor" }, "type": "object" }, "dates": { "items": { "$ref": "#/components/schemas/ActionLogStatsDateByType" }, "type": "array" }, "totalCount": { "type": "number" } }, "required": [ "contributors", "dates", "totalCount" ], "type": "object" }, "ActionLogStatsListByEntity": { "properties": { "contributors": { "additionalProperties": { "$ref": "#/components/schemas/ActionLogStatsContributor" }, "type": "object" }, "dates": { "items": { "$ref": "#/components/schemas/ActionLogStatsDateByEntity" }, "type": "array" }, "totalCount": { "type": "number" } }, "required": [ "contributors", "dates", "totalCount" ], "type": "object" }, "ActionApiKeyContext": { "properties": { "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "ActionApiKeyCreate": { "properties": { "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/ApiKeyRequired" }, "type": { "enum": [ "api-key-create" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "ActionApiKeyUpdate": { "properties": { "context": { "$ref": "#/components/schemas/ActionApiKeyContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/ApiKeyPartial" }, "type": { "enum": [ "api-key-update" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionApiKeyDelete": { "properties": { "context": { "$ref": "#/components/schemas/ActionApiKeyContext" }, "id": { "type": "string" }, "type": { "enum": [ "api-key-delete" ], "type": "string" } }, "required": [ "context", "id", "type" ], "type": "object" }, "ActionApiKey": { "oneOf": [ { "$ref": "#/components/schemas/ActionApiKeyCreate" }, { "$ref": "#/components/schemas/ActionApiKeyUpdate" }, { "$ref": "#/components/schemas/ActionApiKeyDelete" } ] }, "ActionDiagramCreateContext": { "properties": { "domainHandleId": { "type": "string" }, "domainName": { "type": "string" }, "groupHandleId": { "type": "string" }, "groupName": { "type": "string" }, "modelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" } }, "type": "object" }, "ActionDiagramCreate": { "properties": { "context": { "$ref": "#/components/schemas/ActionDiagramCreateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/DiagramRequired" }, "type": { "enum": [ "diagram-create" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionDiagramUpdateContext": { "properties": { "domainHandleId": { "type": "string" }, "domainName": { "type": "string" }, "groupHandleId": { "type": "string" }, "groupName": { "type": "string" }, "modelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/DiagramType" } }, "required": [ "name", "type" ], "type": "object" }, "ActionDiagramUpdate": { "properties": { "context": { "$ref": "#/components/schemas/ActionDiagramUpdateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/DiagramPartial" }, "type": { "enum": [ "diagram-update" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionDiagramExportContext": { "properties": { "diagramName": { "type": "string" }, "diagramType": { "$ref": "#/components/schemas/DiagramType" }, "draftHandleId": { "type": "string" }, "draftName": { "type": "string" }, "flowHandleId": { "type": "string" }, "flowName": { "type": "string" }, "versionName": { "type": "string" } }, "required": [ "diagramName", "diagramType", "versionName" ], "type": "object" }, "ActionDiagramExportProps": { "properties": { "bucketPath": { "type": "string" }, "filename": { "type": "string" }, "options": { "$ref": "#/components/schemas/DiagramExportImageOptions" }, "versionId": { "type": "string" } }, "required": [ "bucketPath", "filename", "versionId" ], "type": "object" }, "ActionDiagramExport": { "properties": { "context": { "$ref": "#/components/schemas/ActionDiagramExportContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/ActionDiagramExportProps" }, "type": { "enum": [ "diagram-export" ], "type": "string" } }, "required": [ "context", "props", "id", "type" ], "type": "object" }, "ActionDiagramDeleteContext": { "properties": { "domainHandleId": { "type": "string" }, "domainName": { "type": "string" }, "modelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/DiagramType" } }, "required": [ "name", "type" ], "type": "object" }, "ActionDiagramDelete": { "properties": { "context": { "$ref": "#/components/schemas/ActionDiagramDeleteContext" }, "id": { "type": "string" }, "type": { "enum": [ "diagram-delete" ], "type": "string" } }, "required": [ "context", "id", "type" ], "type": "object" }, "ActionDiagram": { "oneOf": [ { "$ref": "#/components/schemas/ActionDiagramCreate" }, { "$ref": "#/components/schemas/ActionDiagramUpdate" }, { "$ref": "#/components/schemas/ActionDiagramExport" }, { "$ref": "#/components/schemas/ActionDiagramDelete" } ] }, "ActionDraftCreateContext": { "properties": { "name": { "type": "string" }, "versionName": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "ActionDraftCreate": { "properties": { "context": { "$ref": "#/components/schemas/ActionDraftCreateContext" }, "id": { "type": "string" }, "ids": { "items": { "type": "string" }, "type": "array" }, "props": { "$ref": "#/components/schemas/DraftRequired" }, "type": { "enum": [ "draft-create" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionDraftUpdateContext": { "properties": { "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "ActionDraftUpdate": { "properties": { "context": { "$ref": "#/components/schemas/ActionDraftUpdateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/DraftPartial" }, "type": { "enum": [ "draft-update" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionDraftViewContext": { "properties": { "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "ActionDraftView": { "properties": { "context": { "$ref": "#/components/schemas/ActionDraftViewContext" }, "id": { "type": "string" }, "type": { "enum": [ "draft-view" ], "type": "string" } }, "required": [ "context", "id", "type" ], "type": "object" }, "ActionDraftMergeContext": { "properties": { "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "ActionDraftMerge": { "properties": { "context": { "$ref": "#/components/schemas/ActionDraftMergeContext" }, "id": { "type": "string" }, "type": { "enum": [ "draft-merge" ], "type": "string" } }, "required": [ "context", "id", "type" ], "type": "object" }, "ActionDraftDeleteContext": { "properties": { "name": { "type": "string" }, "versionName": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "ActionDraftDelete": { "properties": { "context": { "$ref": "#/components/schemas/ActionDraftDeleteContext" }, "id": { "type": "string" }, "type": { "enum": [ "draft-delete" ], "type": "string" } }, "required": [ "context", "id", "type" ], "type": "object" }, "ActionDraft": { "oneOf": [ { "$ref": "#/components/schemas/ActionDraftCreate" }, { "$ref": "#/components/schemas/ActionDraftUpdate" }, { "$ref": "#/components/schemas/ActionDraftView" }, { "$ref": "#/components/schemas/ActionDraftMerge" }, { "$ref": "#/components/schemas/ActionDraftDelete" } ] }, "ActionDraftTaskCreateContext": { "properties": { "draftName": { "type": "string" } }, "required": [ "draftName" ], "type": "object" }, "ActionDraftTaskCreate": { "properties": { "context": { "$ref": "#/components/schemas/ActionDraftTaskCreateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/DraftTaskRequired" }, "type": { "enum": [ "draft-task-create" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionDraftTask": { "oneOf": [ { "$ref": "#/components/schemas/ActionDraftTaskCreate" } ] }, "ActionLandscapeCreateContext": { "properties": { "backstageImport": { "type": "boolean" }, "name": { "type": "string" }, "structurizrImport": { "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "ActionLandscapeCreate": { "properties": { "context": { "$ref": "#/components/schemas/ActionLandscapeCreateContext" }, "id": { "type": "string" }, "type": { "enum": [ "landscape-create" ], "type": "string" } }, "required": [ "context", "id", "type" ], "type": "object" }, "ActionLandscapeUpdateContext": { "properties": { "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "ActionLandscapeUpdate": { "properties": { "context": { "$ref": "#/components/schemas/ActionLandscapeUpdateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/LandscapePartial" }, "type": { "enum": [ "landscape-update" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionLandscapeDuplicateContext": { "properties": { "name": { "type": "string" }, "targetOrganizationName": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "ActionLandscapeDuplicateProps": { "properties": { "targetOrganizationId": { "type": "string" } }, "type": "object" }, "ActionLandscapeDuplicate": { "properties": { "context": { "$ref": "#/components/schemas/ActionLandscapeDuplicateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/ActionLandscapeDuplicateProps" }, "type": { "enum": [ "landscape-duplicate" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionLandscapeCopyContext": { "properties": { "name": { "type": "string" }, "targetLandscapeName": { "type": "string" } }, "required": [ "name", "targetLandscapeName" ], "type": "object" }, "ActionLandscapeCopy": { "properties": { "context": { "$ref": "#/components/schemas/ActionLandscapeCopyContext" }, "id": { "type": "string" }, "props": { "properties": { "targetLandscapeId": { "type": "string" } }, "required": [ "targetLandscapeId" ], "type": "object" }, "type": { "enum": [ "landscape-copy" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionLandscapeDeleteContext": { "properties": { "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "ActionLandscapeDelete": { "properties": { "context": { "$ref": "#/components/schemas/ActionLandscapeDeleteContext" }, "id": { "type": "string" }, "type": { "enum": [ "landscape-delete" ], "type": "string" } }, "required": [ "context", "id", "type" ], "type": "object" }, "ActionLandscapeExportContext": { "properties": { "draftHandleId": { "type": "string" }, "draftName": { "type": "string" }, "filterDiagramHandleId": { "type": "string" }, "filterDiagramName": { "type": "string" }, "filterDiagramType": { "$ref": "#/components/schemas/DiagramType" }, "filterFlowHandleId": { "type": "string" }, "filterFlowName": { "type": "string" }, "filterModelObjectHandleId": { "type": "string" }, "filterModelObjectName": { "type": "string" }, "filterModelObjectType": { "$ref": "#/components/schemas/ModelObjectType" }, "landscapeName": { "type": "string" }, "versionName": { "type": "string" } }, "required": [ "landscapeName", "versionName" ], "type": "object" }, "ActionLandscapeExportProps": { "properties": { "bucketPath": { "type": "string" }, "filename": { "type": "string" }, "filter": { "$ref": "#/components/schemas/LandscapeExportFilter" }, "options": { "$ref": "#/components/schemas/LandscapeExportOptions" }, "type": { "$ref": "#/components/schemas/LandscapeExportType" }, "versionId": { "type": "string" } }, "required": [ "bucketPath", "filename", "type", "versionId" ], "type": "object" }, "ActionLandscapeExport": { "properties": { "context": { "$ref": "#/components/schemas/ActionLandscapeExportContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/ActionLandscapeExportProps" }, "type": { "enum": [ "landscape-export" ], "type": "string" } }, "required": [ "context", "props", "id", "type" ], "type": "object" }, "ActionLandscapeImportContext": { "properties": { "landscapeName": { "type": "string" }, "versionName": { "type": "string" } }, "required": [ "landscapeName", "versionName" ], "type": "object" }, "ActionLandscapeImportProps": { "properties": { "bucketPath": { "type": "string" }, "modelConnectionCount": { "type": "number" }, "modelObjectCount": { "type": "number" }, "modelObjectTypeCount": { "additionalProperties": { "type": "number" }, "type": "object" }, "prune": { "type": "boolean" }, "tagCount": { "type": "number" }, "tagGroupCount": { "type": "number" }, "versionId": { "type": "string" } }, "required": [ "bucketPath", "modelConnectionCount", "modelObjectCount", "modelObjectTypeCount", "tagCount", "tagGroupCount", "versionId" ], "type": "object" }, "ActionLandscapeImport": { "properties": { "context": { "$ref": "#/components/schemas/ActionLandscapeImportContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/ActionLandscapeImportProps" }, "type": { "enum": [ "landscape-import" ], "type": "string" } }, "required": [ "context", "props", "id", "type" ], "type": "object" }, "ActionLandscape": { "oneOf": [ { "$ref": "#/components/schemas/ActionLandscapeCreate" }, { "$ref": "#/components/schemas/ActionLandscapeUpdate" }, { "$ref": "#/components/schemas/ActionLandscapeDuplicate" }, { "$ref": "#/components/schemas/ActionLandscapeCopy" }, { "$ref": "#/components/schemas/ActionLandscapeDelete" }, { "$ref": "#/components/schemas/ActionLandscapeExport" }, { "$ref": "#/components/schemas/ActionLandscapeImport" } ] }, "ActionModelConnectionCreateContext": { "properties": { "domainHandleId": { "type": "string" }, "domainName": { "type": "string" }, "originModelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" }, "tagNames": { "additionalProperties": { "type": "string" }, "type": "object" }, "targetModelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" }, "technologyNames": { "additionalProperties": { "type": "string" }, "type": "object" }, "viaModelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" } }, "type": "object" }, "ActionModelConnectionCreate": { "properties": { "context": { "$ref": "#/components/schemas/ActionModelConnectionCreateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/ModelConnectionRequired" }, "type": { "enum": [ "model-connection-create" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionModelConnectionUpdateContext": { "properties": { "domainHandleId": { "type": "string" }, "domainName": { "type": "string" }, "name": { "type": "string" }, "originModelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" }, "tagNames": { "additionalProperties": { "type": "string" }, "type": "object" }, "targetModelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" }, "technologyNames": { "additionalProperties": { "type": "string" }, "type": "object" }, "viaModelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" } }, "required": [ "name" ], "type": "object" }, "ActionModelConnectionUpdate": { "properties": { "context": { "$ref": "#/components/schemas/ActionModelConnectionUpdateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/ModelConnectionPartial" }, "type": { "enum": [ "model-connection-update" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionModelConnectionsExportContext": { "properties": { "landscapeName": { "type": "string" }, "versionName": { "type": "string" } }, "required": [ "landscapeName", "versionName" ], "type": "object" }, "ActionModelConnectionsExportProps": { "properties": { "type": { "enum": [ "csv" ], "type": "string" }, "versionId": { "type": "string" } }, "required": [ "type", "versionId" ], "type": "object" }, "ActionModelConnectionsExport": { "properties": { "context": { "$ref": "#/components/schemas/ActionModelConnectionsExportContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/ActionModelConnectionsExportProps" }, "type": { "enum": [ "model-connections-export" ], "type": "string" } }, "required": [ "context", "props", "id", "type" ], "type": "object" }, "ActionModelConnectionDeleteContext": { "properties": { "domainHandleId": { "type": "string" }, "domainName": { "type": "string" }, "name": { "type": "string" }, "originModelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" }, "tagNames": { "additionalProperties": { "type": "string" }, "type": "object" }, "targetModelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" }, "technologyNames": { "additionalProperties": { "type": "string" }, "type": "object" }, "viaModelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" } }, "required": [ "name" ], "type": "object" }, "ActionModelConnectionDelete": { "properties": { "context": { "$ref": "#/components/schemas/ActionModelConnectionDeleteContext" }, "id": { "type": "string" }, "type": { "enum": [ "model-connection-delete" ], "type": "string" } }, "required": [ "context", "id", "type" ], "type": "object" }, "ActionModelConnection": { "oneOf": [ { "$ref": "#/components/schemas/ActionModelConnectionCreate" }, { "$ref": "#/components/schemas/ActionModelConnectionUpdate" }, { "$ref": "#/components/schemas/ActionModelConnectionsExport" }, { "$ref": "#/components/schemas/ActionModelConnectionDelete" } ] }, "ActionModelObjectCreateContext": { "properties": { "domainHandleId": { "type": "string" }, "domainName": { "type": "string" }, "groupNames": { "additionalProperties": { "type": "string" }, "type": "object" }, "modelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" }, "tagNames": { "additionalProperties": { "type": "string" }, "type": "object" }, "teamNames": { "additionalProperties": { "type": "string" }, "type": "object" }, "technologyNames": { "additionalProperties": { "type": "string" }, "type": "object" } }, "type": "object" }, "ActionModelObjectCreate": { "properties": { "context": { "$ref": "#/components/schemas/ActionModelObjectCreateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/ModelObjectRequired" }, "type": { "enum": [ "model-object-create" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionModelObjectUpdateContext": { "properties": { "domainHandleId": { "type": "string" }, "domainName": { "type": "string" }, "groupNames": { "additionalProperties": { "type": "string" }, "type": "object" }, "modelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" }, "name": { "type": "string" }, "tagNames": { "additionalProperties": { "type": "string" }, "type": "object" }, "teamNames": { "additionalProperties": { "type": "string" }, "type": "object" }, "technologyNames": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": { "$ref": "#/components/schemas/ModelObjectType" } }, "required": [ "name", "type" ], "type": "object" }, "ActionModelObjectUpdate": { "properties": { "context": { "$ref": "#/components/schemas/ActionModelObjectUpdateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/ModelObjectPartial" }, "type": { "enum": [ "model-object-update" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionModelObjectDependenciesExportContext": { "properties": { "domainHandleId": { "type": "string" }, "domainName": { "type": "string" }, "modelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/ModelObjectType" }, "versionName": { "type": "string" } }, "required": [ "name", "type", "versionName" ], "type": "object" }, "ActionModelObjectDependenciesExportProps": { "properties": { "type": { "enum": [ "json" ], "type": "string" }, "versionId": { "type": "string" } }, "required": [ "type", "versionId" ], "type": "object" }, "ActionModelObjectDependenciesExport": { "properties": { "context": { "$ref": "#/components/schemas/ActionModelObjectDependenciesExportContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/ActionModelObjectDependenciesExportProps" }, "type": { "enum": [ "model-object-dependencies-export" ], "type": "string" } }, "required": [ "context", "props", "id", "type" ], "type": "object" }, "ActionModelObjectsExportContext": { "properties": { "landscapeName": { "type": "string" }, "versionName": { "type": "string" } }, "required": [ "landscapeName", "versionName" ], "type": "object" }, "ActionModelObjectsExportProps": { "properties": { "type": { "enum": [ "csv" ], "type": "string" }, "versionId": { "type": "string" } }, "required": [ "type", "versionId" ], "type": "object" }, "ActionModelObjectsExport": { "properties": { "context": { "$ref": "#/components/schemas/ActionModelObjectsExportContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/ActionModelObjectsExportProps" }, "type": { "enum": [ "model-objects-export" ], "type": "string" } }, "required": [ "context", "props", "id", "type" ], "type": "object" }, "ActionModelObjectDeleteContext": { "properties": { "domainHandleId": { "type": "string" }, "domainName": { "type": "string" }, "groupNames": { "additionalProperties": { "type": "string" }, "type": "object" }, "modelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" }, "name": { "type": "string" }, "tagNames": { "additionalProperties": { "type": "string" }, "type": "object" }, "teamNames": { "additionalProperties": { "type": "string" }, "type": "object" }, "technologyNames": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": { "$ref": "#/components/schemas/ModelObjectType" } }, "required": [ "name", "type" ], "type": "object" }, "ActionModelObjectDelete": { "properties": { "context": { "$ref": "#/components/schemas/ActionModelObjectDeleteContext" }, "id": { "type": "string" }, "type": { "enum": [ "model-object-delete" ], "type": "string" } }, "required": [ "context", "id", "type" ], "type": "object" }, "ActionModelObject": { "oneOf": [ { "$ref": "#/components/schemas/ActionModelObjectCreate" }, { "$ref": "#/components/schemas/ActionModelObjectUpdate" }, { "$ref": "#/components/schemas/ActionModelObjectDependenciesExport" }, { "$ref": "#/components/schemas/ActionModelObjectsExport" }, { "$ref": "#/components/schemas/ActionModelObjectDelete" } ] }, "ActionOAuthConsentGrantProps": { "properties": { "clientName": { "type": "string" }, "landscapeId": { "type": "string" } }, "required": [ "clientName", "landscapeId" ], "type": "object" }, "ActionOAuthConsentGrant": { "properties": { "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/ActionOAuthConsentGrantProps" }, "type": { "enum": [ "oauth-consent-grant" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "ActionOAuthConsentDenyProps": { "properties": { "clientName": { "type": "string" } }, "required": [ "clientName" ], "type": "object" }, "ActionOAuthConsentDeny": { "properties": { "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/ActionOAuthConsentDenyProps" }, "type": { "enum": [ "oauth-consent-deny" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "ActionOAuth": { "oneOf": [ { "$ref": "#/components/schemas/ActionOAuthConsentDeny" }, { "$ref": "#/components/schemas/ActionOAuthConsentGrant" } ] }, "ActionOrganizationCreateContext": { "properties": { "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "ActionOrganizationCreate": { "properties": { "context": { "$ref": "#/components/schemas/ActionOrganizationCreateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/OrganizationRequired" }, "type": { "enum": [ "organization-create" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionOrganizationUpdateContext": { "properties": { "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "ActionOrganizationUpdate": { "properties": { "context": { "$ref": "#/components/schemas/ActionOrganizationUpdateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/OrganizationPartial" }, "type": { "enum": [ "organization-update" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionOrganizationDeleteContext": { "properties": { "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "ActionOrganizationDeleteProps": { "properties": { "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "ActionOrganizationDelete": { "properties": { "context": { "$ref": "#/components/schemas/ActionOrganizationDeleteContext" }, "id": { "type": "string" }, "type": { "enum": [ "organization-delete" ], "type": "string" } }, "required": [ "context", "id", "type" ], "type": "object" }, "ActionOrganization": { "oneOf": [ { "$ref": "#/components/schemas/ActionOrganizationCreate" }, { "$ref": "#/components/schemas/ActionOrganizationUpdate" }, { "$ref": "#/components/schemas/ActionOrganizationDelete" } ] }, "ActionOrganizationUserAddContext": { "properties": { "email": { "type": "string" }, "landscapeNames": { "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "type": "string" } }, "required": [ "email" ], "type": "object" }, "ActionOrganizationUserAdd": { "properties": { "context": { "$ref": "#/components/schemas/ActionOrganizationUserAddContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/OrganizationUser" }, "type": { "enum": [ "organization-user-add" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionOrganizationUserUpdateContext": { "properties": { "email": { "type": "string" }, "landscapeNames": { "additionalProperties": { "type": "string" }, "type": "object" }, "name": { "type": "string" } }, "required": [ "email" ], "type": "object" }, "ActionOrganizationUserUpdate": { "properties": { "context": { "$ref": "#/components/schemas/ActionOrganizationUserUpdateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/OrganizationUser" }, "type": { "enum": [ "organization-user-update" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionOrganizationUserRemoveContext": { "properties": { "email": { "type": "string" }, "landscapeNames": { "additionalProperties": { "type": "string" }, "type": "object" }, "landscapePermissions": { "additionalProperties": { "type": "boolean" }, "type": "object" }, "name": { "type": "string" }, "permission": { "$ref": "#/components/schemas/PermissionType" } }, "required": [ "email", "permission" ], "type": "object" }, "ActionOrganizationUserRemove": { "properties": { "context": { "$ref": "#/components/schemas/ActionOrganizationUserRemoveContext" }, "id": { "type": "string" }, "type": { "enum": [ "organization-user-remove" ], "type": "string" } }, "required": [ "context", "id", "type" ], "type": "object" }, "ActionOrganizationUser": { "oneOf": [ { "$ref": "#/components/schemas/ActionOrganizationUserAdd" }, { "$ref": "#/components/schemas/ActionOrganizationUserUpdate" }, { "$ref": "#/components/schemas/ActionOrganizationUserRemove" } ] }, "ActionOrganizationUserInviteCreateContext": { "properties": { "landscapeNames": { "additionalProperties": { "type": "string" }, "type": "object" } }, "type": "object" }, "ActionOrganizationUserInviteCreate": { "properties": { "context": { "$ref": "#/components/schemas/ActionOrganizationUserInviteCreateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/OrganizationUserInviteRequired" }, "type": { "enum": [ "organization-user-invite-create" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionOrganizationUserInviteRevokeContext": { "properties": { "email": { "type": "string" }, "landscapeNames": { "additionalProperties": { "type": "string" }, "type": "object" }, "permission": { "$ref": "#/components/schemas/PermissionType" } }, "required": [ "email", "permission" ], "type": "object" }, "ActionOrganizationUserInviteRevoke": { "properties": { "context": { "$ref": "#/components/schemas/ActionOrganizationUserInviteRevokeContext" }, "id": { "type": "string" }, "type": { "enum": [ "organization-user-invite-revoke" ], "type": "string" } }, "required": [ "context", "id", "type" ], "type": "object" }, "ActionOrganizationUserInvite": { "oneOf": [ { "$ref": "#/components/schemas/ActionOrganizationUserInviteCreate" }, { "$ref": "#/components/schemas/ActionOrganizationUserInviteRevoke" } ] }, "ActionShareLinkCreateContext": { "properties": { "draftHandleId": { "nullable": true, "type": "string" }, "draftName": { "type": "string" }, "versionModelHandleId": { "nullable": true, "type": "string" }, "versionName": { "type": "string" } }, "required": [ "versionName", "versionModelHandleId" ], "type": "object" }, "ActionShareLinkCreate": { "properties": { "context": { "$ref": "#/components/schemas/ActionShareLinkCreateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/ShareLinkRequired" }, "type": { "enum": [ "share-link-create" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionShareLinkUpdateContext": { "properties": { "draftHandleId": { "nullable": true, "type": "string" }, "draftName": { "type": "string" }, "shortId": { "type": "string" }, "versionModelHandleId": { "nullable": true, "type": "string" }, "versionName": { "type": "string" } }, "required": [ "shortId", "versionName", "versionModelHandleId" ], "type": "object" }, "ActionShareLinkUpdate": { "properties": { "context": { "$ref": "#/components/schemas/ActionShareLinkUpdateContext" }, "id": { "type": "string" }, "props": { "allOf": [ { "$ref": "#/components/schemas/ShareLinkPartial" }, { "properties": { "resetShortId": { "type": "boolean" } }, "required": [ "resetShortId" ], "type": "object" } ] }, "type": { "enum": [ "share-link-update" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionShareLinkDeleteContext": { "properties": { "draftHandleId": { "nullable": true, "type": "string" }, "draftName": { "type": "string" }, "shortId": { "type": "string" }, "versionModelHandleId": { "nullable": true, "type": "string" }, "versionName": { "type": "string" } }, "required": [ "shortId", "versionName", "versionModelHandleId" ], "type": "object" }, "ActionShareLinkDelete": { "properties": { "context": { "$ref": "#/components/schemas/ActionShareLinkDeleteContext" }, "id": { "type": "string" }, "type": { "enum": [ "share-link-delete" ], "type": "string" } }, "required": [ "context", "id", "type" ], "type": "object" }, "ActionShareLink": { "oneOf": [ { "$ref": "#/components/schemas/ActionShareLinkCreate" }, { "$ref": "#/components/schemas/ActionShareLinkUpdate" }, { "$ref": "#/components/schemas/ActionShareLinkDelete" } ] }, "ActionTeamCreateContext": { "properties": { "userNames": { "additionalProperties": { "type": "string" }, "type": "object" } }, "type": "object" }, "ActionTeamCreate": { "properties": { "context": { "$ref": "#/components/schemas/ActionTeamCreateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/TeamRequired" }, "type": { "enum": [ "team-create" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionTeamUpdateContext": { "properties": { "name": { "type": "string" }, "userNames": { "additionalProperties": { "type": "string" }, "type": "object" } }, "required": [ "name" ], "type": "object" }, "ActionTeamUpdate": { "properties": { "context": { "$ref": "#/components/schemas/ActionTeamUpdateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/TeamPartial" }, "type": { "enum": [ "team-update" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionTeamDeleteContext": { "properties": { "name": { "type": "string" }, "userNames": { "additionalProperties": { "type": "string" }, "type": "object" } }, "required": [ "name" ], "type": "object" }, "ActionTeamDelete": { "properties": { "context": { "$ref": "#/components/schemas/ActionTeamDeleteContext" }, "id": { "type": "string" }, "type": { "enum": [ "team-delete" ], "type": "string" } }, "required": [ "context", "id", "type" ], "type": "object" }, "ActionTeam": { "oneOf": [ { "$ref": "#/components/schemas/ActionTeamCreate" }, { "$ref": "#/components/schemas/ActionTeamUpdate" }, { "$ref": "#/components/schemas/ActionTeamDelete" } ] }, "ActionUserLogin": { "properties": { "id": { "type": "string" }, "type": { "enum": [ "user-login" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "ActionUserLoginFailedProps": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" }, "ActionUserLoginFailed": { "properties": { "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/ActionUserLoginFailedProps" }, "type": { "enum": [ "user-login-failed" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "ActionUserLogout": { "properties": { "id": { "type": "string" }, "type": { "enum": [ "user-logout" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "ActionUser": { "oneOf": [ { "$ref": "#/components/schemas/ActionUserLogin" }, { "$ref": "#/components/schemas/ActionUserLoginFailed" }, { "$ref": "#/components/schemas/ActionUserLogout" } ] }, "ActionVersionCreateContext": { "properties": { "domainHandleId": { "type": "string" }, "domainName": { "type": "string" }, "modelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" } }, "type": "object" }, "ActionVersionCreate": { "properties": { "context": { "$ref": "#/components/schemas/ActionVersionCreateContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/VersionRequired" }, "type": { "enum": [ "version-create" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionVersionDeleteContext": { "properties": { "domainHandleId": { "type": "string" }, "domainName": { "type": "string" }, "modelFamily": { "items": { "$ref": "#/components/schemas/ActionContextModelObject" }, "type": "array" }, "versionName": { "type": "string" } }, "required": [ "versionName" ], "type": "object" }, "ActionVersionDelete": { "properties": { "context": { "$ref": "#/components/schemas/ActionVersionDeleteContext" }, "id": { "type": "string" }, "type": { "enum": [ "version-delete" ], "type": "string" } }, "required": [ "context", "id", "type" ], "type": "object" }, "ActionVersionRevertContext": { "properties": { "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "ActionVersionRevertCreate": { "properties": { "context": { "$ref": "#/components/schemas/ActionVersionRevertContext" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/VersionRevertRequired" }, "type": { "enum": [ "version-revert-create" ], "type": "string" } }, "required": [ "context", "id", "props", "type" ], "type": "object" }, "ActionVersion": { "oneOf": [ { "$ref": "#/components/schemas/ActionVersionCreate" }, { "$ref": "#/components/schemas/ActionVersionDelete" }, { "$ref": "#/components/schemas/ActionVersionRevertCreate" } ] }, "ADRFilter": { "properties": { "name": { "description": "The name of the ADR", "maxLength": 1000, "type": "string" }, "status": { "oneOf": [ { "$ref": "#/components/schemas/ADRStatus" }, { "items": { "$ref": "#/components/schemas/ADRStatus" }, "maxItems": 3, "type": "array" } ] } }, "type": "object" }, "ADRStatus": { "enum": [ "accepted", "draft", "rejected" ], "type": "string" }, "ADRStatusChange": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "status": { "$ref": "#/components/schemas/ADRStatus" } }, "required": [ "status", "createdAt", "createdBy", "createdById" ], "type": "object" }, "ADRRelatedItemType": { "enum": [ "adr", "diagram", "draft", "link" ], "type": "string" }, "ADRRelatedItem": { "properties": { "adrId": { "format": "id", "type": "string" }, "diagramId": { "format": "id", "type": "string" }, "draftId": { "format": "id", "type": "string" }, "id": { "format": "id", "type": "string" }, "index": { "minimum": 0, "type": "number" }, "link": { "$ref": "#/components/schemas/RealityLink" }, "type": { "$ref": "#/components/schemas/ADRRelatedItemType" } }, "required": [ "id", "type", "index" ], "type": "object" }, "ADRPartial": { "properties": { "commit": { "minimum": 0, "type": "number" }, "content": { "description": "The markdown content of the ADR", "maxLength": 100000, "type": "string" }, "description": { "description": "The description of the ADR", "maxLength": 100000, "type": "string" }, "name": { "description": "The name of the ADR", "maxLength": 1000, "type": "string" }, "relatedItems": { "additionalProperties": { "$ref": "#/components/schemas/ADRRelatedItem" }, "type": "object" }, "status": { "$ref": "#/components/schemas/ADRStatus", "description": "The status of the ADR" }, "statusChanges": { "items": { "$ref": "#/components/schemas/ADRStatusChange" }, "type": "array" } }, "type": "object" }, "ADRRequired": { "properties": { "commit": { "minimum": 0, "type": "number" }, "content": { "description": "The markdown content of the ADR", "maxLength": 100000, "type": "string" }, "description": { "description": "The description of the ADR", "maxLength": 100000, "type": "string" }, "name": { "description": "The name of the ADR", "maxLength": 1000, "type": "string" }, "relatedItems": { "additionalProperties": { "$ref": "#/components/schemas/ADRRelatedItem" }, "type": "object" }, "status": { "$ref": "#/components/schemas/ADRStatus", "description": "The status of the ADR" }, "statusChanges": { "items": { "$ref": "#/components/schemas/ADRStatusChange" }, "type": "array" }, "handleId": { "description": "The handle id of the ADR", "format": "handle-id", "type": "string" } }, "required": [ "name", "status" ], "type": "object" }, "ADR": { "properties": { "commit": { "minimum": 0, "type": "number" }, "content": { "description": "The markdown content of the ADR", "maxLength": 100000, "type": "string" }, "description": { "description": "The description of the ADR", "maxLength": 100000, "type": "string" }, "name": { "description": "The name of the ADR", "maxLength": 1000, "type": "string" }, "relatedItems": { "additionalProperties": { "$ref": "#/components/schemas/ADRRelatedItem" }, "type": "object" }, "status": { "$ref": "#/components/schemas/ADRStatus", "description": "The status of the ADR" }, "statusChanges": { "items": { "$ref": "#/components/schemas/ADRStatusChange" }, "type": "array" }, "handleId": { "description": "The handle id of the ADR", "format": "handle-id", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "deletedAt": { "format": "date-time", "type": "string" }, "deletedBy": { "$ref": "#/components/schemas/AuthType" }, "deletedById": { "type": "string" }, "id": { "description": "The id of the ADR", "format": "id", "type": "string" }, "landscapeId": { "description": "The id of the landscape that the ADR belongs to", "format": "id", "type": "string" }, "latestEntityId": { "format": "id", "type": "string" }, "number": { "description": "The incremental number of the ADR", "type": "number" }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/AuthType" }, "updatedById": { "type": "string" }, "version": { "minimum": 0, "type": "number" }, "versionId": { "format": "id", "type": "string" } }, "required": [ "name", "status", "commit", "createdAt", "createdBy", "createdById", "handleId", "id", "landscapeId", "number", "updatedAt", "updatedBy", "updatedById", "version", "versionId" ], "type": "object" }, "ApiKeyPartial": { "properties": { "name": { "maxLength": 4000, "type": "string" }, "permission": { "$ref": "#/components/schemas/PermissionType" } }, "type": "object" }, "ApiKeyRequired": { "properties": { "name": { "maxLength": 4000, "type": "string" }, "permission": { "$ref": "#/components/schemas/PermissionType" } }, "required": [ "name", "permission" ], "type": "object" }, "ApiKey": { "properties": { "name": { "maxLength": 4000, "type": "string" }, "permission": { "$ref": "#/components/schemas/PermissionType" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "id": { "type": "string" }, "organizationId": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/AuthType" }, "updatedById": { "type": "string" } }, "required": [ "name", "permission", "createdAt", "createdBy", "createdById", "id", "organizationId", "updatedAt", "updatedBy", "updatedById" ], "type": "object" }, "AutomationRunPartial": { "properties": { "automationId": { "type": "string" }, "automationVersion": { "type": "string" }, "stepIndex": { "type": "number" }, "stepIndexCompletedAt": { "items": { "format": "date-time", "type": "string" }, "type": "array" }, "trigger": { "$ref": "#/components/schemas/AutomationTrigger" }, "uniqueKey": { "type": "string" } }, "type": "object" }, "AutomationRunRequired": { "properties": { "automationId": { "type": "string" }, "automationVersion": { "type": "string" }, "stepIndex": { "type": "number" }, "stepIndexCompletedAt": { "items": { "format": "date-time", "type": "string" }, "type": "array" }, "trigger": { "$ref": "#/components/schemas/AutomationTrigger" }, "uniqueKey": { "type": "string" } }, "required": [ "automationId", "automationVersion", "stepIndex", "stepIndexCompletedAt", "trigger", "uniqueKey" ], "type": "object" }, "AutomationRun": { "properties": { "automationId": { "type": "string" }, "automationVersion": { "type": "string" }, "stepIndex": { "type": "number" }, "stepIndexCompletedAt": { "items": { "format": "date-time", "type": "string" }, "type": "array" }, "trigger": { "$ref": "#/components/schemas/AutomationTrigger" }, "uniqueKey": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "error": { "type": "string" }, "executedAt": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "status": { "enum": [ "idle", "executing", "error", "exited", "completed" ], "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "automationId", "automationVersion", "stepIndex", "stepIndexCompletedAt", "trigger", "uniqueKey", "createdAt", "executedAt", "id", "status", "updatedAt" ], "type": "object" }, "AutomationTriggerType": { "enum": [ "catalog-technology-review-approved", "catalog-technology-review-rejected", "comment-create", "comment-reply-create", "comment-status-update", "export-pdf-ready", "organization-billing-charge-refunded", "organization-billing-checkout-session-completed", "organization-billing-invoice-paid", "organization-billing-invoice-payment-failed", "organization-billing-payment-method-attached", "organization-billing-payment-method-detached", "organization-billing-subscription-changed", "organization-create", "organization-updated", "organization-user-invite-create", "organization-user-invite-used", "schedule", "send-c4-model-ebook", "user-email-verification", "user-register", "user-request-reset-password", "user-update" ], "type": "string" }, "AutomationTriggerSchedule": { "properties": { "date": { "format": "date-time", "type": "string" }, "type": { "enum": [ "schedule" ], "type": "string" } }, "required": [ "date", "type" ], "type": "object" }, "AutomationTriggerCatalogTechnologyReviewApproved": { "properties": { "catalogTechnologyId": { "type": "string" }, "type": { "enum": [ "catalog-technology-review-approved" ], "type": "string" } }, "required": [ "catalogTechnologyId", "type" ], "type": "object" }, "AutomationTriggerCatalogTechnologyReviewRejected": { "properties": { "catalogTechnologyId": { "type": "string" }, "type": { "enum": [ "catalog-technology-review-rejected" ], "type": "string" } }, "required": [ "catalogTechnologyId", "type" ], "type": "object" }, "AutomationTriggerCommentCreate": { "properties": { "commentId": { "type": "string" }, "landscapeId": { "type": "string" }, "organizationId": { "type": "string" }, "type": { "enum": [ "comment-create" ], "type": "string" }, "userId": { "type": "string" } }, "required": [ "commentId", "landscapeId", "organizationId", "type", "userId" ], "type": "object" }, "AutomationTriggerCommentReplyCreate": { "properties": { "commentId": { "type": "string" }, "commentReplyId": { "type": "string" }, "landscapeId": { "type": "string" }, "organizationId": { "type": "string" }, "type": { "enum": [ "comment-reply-create" ], "type": "string" }, "userId": { "type": "string" } }, "required": [ "commentId", "commentReplyId", "landscapeId", "organizationId", "type", "userId" ], "type": "object" }, "AutomationTriggerCommentStatusUpdate": { "properties": { "commentId": { "type": "string" }, "landscapeId": { "type": "string" }, "organizationId": { "type": "string" }, "type": { "enum": [ "comment-status-update" ], "type": "string" }, "userId": { "type": "string" } }, "required": [ "commentId", "landscapeId", "organizationId", "type", "userId" ], "type": "object" }, "AutomationTriggerExportPdfReady": { "properties": { "downloadUrl": { "format": "uri", "type": "string" }, "email": { "type": "string" }, "filename": { "type": "string" }, "name": { "type": "string" }, "type": { "enum": [ "export-pdf-ready" ], "type": "string" }, "userId": { "type": "string" } }, "required": [ "downloadUrl", "email", "filename", "name", "type" ], "type": "object" }, "AutomationTriggerOrganizationBillingChargeRefunded": { "properties": { "amount": { "type": "number" }, "amountRefunded": { "type": "number" }, "currency": { "$ref": "#/components/schemas/OrganizationBillingCurrency" }, "description": { "type": "string" }, "eventId": { "type": "string" }, "invoiceId": { "nullable": true, "type": "string" }, "organizationId": { "type": "string" }, "paymentIntentId": { "type": "string" }, "paymentMethodType": { "type": "string" }, "type": { "enum": [ "organization-billing-charge-refunded" ], "type": "string" } }, "required": [ "amount", "amountRefunded", "eventId", "type" ], "type": "object" }, "AutomationTriggerOrganizationBillingCheckoutSessionCompleted": { "properties": { "currency": { "$ref": "#/components/schemas/OrganizationBillingCurrency" }, "customFields": { "additionalProperties": { "nullable": true, "type": "string" }, "type": "object" }, "customer": { "properties": { "email": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "eventId": { "type": "string" }, "invoiceId": { "type": "string" }, "organizationId": { "type": "string" }, "paymentIntentId": { "type": "string" }, "paymentLinkId": { "type": "string" }, "subtotal": { "type": "number" }, "total": { "type": "number" }, "type": { "enum": [ "organization-billing-checkout-session-completed" ], "type": "string" } }, "required": [ "customer", "eventId", "type" ], "type": "object" }, "AutomationTriggerOrganizationBillingInvoicePaid": { "properties": { "amountDue": { "type": "number" }, "amountPaid": { "type": "number" }, "collectionMethod": { "$ref": "#/components/schemas/OrganizationCollectionMethod" }, "currency": { "$ref": "#/components/schemas/OrganizationBillingCurrency" }, "cycle": { "$ref": "#/components/schemas/OrganizationBillingCycle" }, "eventId": { "type": "string" }, "invoiceId": { "type": "string" }, "organizationId": { "type": "string" }, "plan": { "$ref": "#/components/schemas/OrganizationPlan" }, "seats": { "type": "number" }, "subtotal": { "type": "number" }, "total": { "type": "number" }, "type": { "enum": [ "organization-billing-invoice-paid" ], "type": "string" } }, "required": [ "amountDue", "amountPaid", "collectionMethod", "currency", "cycle", "invoiceId", "organizationId", "plan", "seats", "eventId", "subtotal", "total", "type" ], "type": "object" }, "AutomationTriggerOrganizationBillingInvoicePaymentFailed": { "properties": { "amountDue": { "type": "number" }, "amountPaid": { "type": "number" }, "collectionMethod": { "$ref": "#/components/schemas/OrganizationCollectionMethod" }, "currency": { "$ref": "#/components/schemas/OrganizationBillingCurrency" }, "cycle": { "$ref": "#/components/schemas/OrganizationBillingCycle" }, "errors": { "items": { "properties": { "code": { "type": "string" }, "docUrl": { "format": "uri", "type": "string" } }, "type": "object" }, "type": "array" }, "eventId": { "type": "string" }, "invoiceId": { "type": "string" }, "organizationId": { "type": "string" }, "plan": { "$ref": "#/components/schemas/OrganizationPlan" }, "seats": { "type": "number" }, "subtotal": { "type": "number" }, "total": { "type": "number" }, "type": { "enum": [ "organization-billing-invoice-payment-failed" ], "type": "string" } }, "required": [ "amountDue", "amountPaid", "collectionMethod", "currency", "cycle", "invoiceId", "organizationId", "plan", "seats", "eventId", "subtotal", "total", "type" ], "type": "object" }, "AutomationTriggerOrganizationBillingPaymentMethodAttached": { "properties": { "card": { "properties": { "brand": { "type": "string" }, "country": { "type": "string" } }, "required": [ "brand" ], "type": "object" }, "eventId": { "type": "string" }, "organizationId": { "type": "string" }, "paymentMethodType": { "type": "string" }, "type": { "enum": [ "organization-billing-payment-method-attached" ], "type": "string" } }, "required": [ "organizationId", "paymentMethodType", "eventId", "type" ], "type": "object" }, "AutomationTriggerOrganizationBillingPaymentMethodDetached": { "properties": { "card": { "properties": { "brand": { "type": "string" }, "country": { "type": "string" } }, "required": [ "brand" ], "type": "object" }, "eventId": { "type": "string" }, "organizationId": { "type": "string" }, "paymentMethodType": { "type": "string" }, "type": { "enum": [ "organization-billing-payment-method-detached" ], "type": "string" } }, "required": [ "organizationId", "paymentMethodType", "eventId", "type" ], "type": "object" }, "AutomationTriggerOrganizationBillingSubscriptionChanged": { "properties": { "billingMonthlyRevenue": { "type": "number" }, "cancelAt": { "format": "date-time", "type": "string" }, "canceledAt": { "format": "date-time", "type": "string" }, "cancellationDetails": { "properties": { "comment": { "type": "string" }, "feedback": { "type": "string" }, "reason": { "type": "string" } }, "type": "object" }, "collectionMethod": { "$ref": "#/components/schemas/OrganizationCollectionMethod" }, "currency": { "$ref": "#/components/schemas/OrganizationBillingCurrency" }, "cycle": { "$ref": "#/components/schemas/OrganizationBillingCycle" }, "eventId": { "type": "string" }, "organizationId": { "type": "string" }, "plan": { "$ref": "#/components/schemas/OrganizationPlan" }, "planEndsAt": { "format": "date-time", "type": "string" }, "seats": { "type": "number" }, "status": { "$ref": "#/components/schemas/OrganizationStatus" }, "trialEndsAt": { "format": "date-time", "type": "string" }, "type": { "enum": [ "organization-billing-subscription-changed" ], "type": "string" }, "updateBillingMonthlyRevenue": { "type": "number" }, "updateCancelAt": { "format": "date-time", "type": "string" }, "updateCanceledAt": { "format": "date-time", "type": "string" }, "updateCollectionMethod": { "$ref": "#/components/schemas/OrganizationCollectionMethod" }, "updateCurrency": { "$ref": "#/components/schemas/OrganizationBillingCurrency" }, "updateCycle": { "$ref": "#/components/schemas/OrganizationBillingCycle" }, "updatePlan": { "$ref": "#/components/schemas/OrganizationPlan" }, "updatePlanEndsAt": { "format": "date-time", "type": "string" }, "updateSeats": { "type": "number" }, "updateStatus": { "$ref": "#/components/schemas/OrganizationStatus" }, "updateTrialEndsAt": { "format": "date-time", "type": "string" } }, "required": [ "eventId", "organizationId", "plan", "seats", "status", "type" ], "type": "object" }, "AutomationTriggerOrganizationCreate": { "properties": { "organizationId": { "type": "string" }, "type": { "enum": [ "organization-create" ], "type": "string" }, "userId": { "type": "string" } }, "required": [ "organizationId", "type", "userId" ], "type": "object" }, "AutomationTriggerOrganizationUpdated": { "properties": { "balance": { "type": "number" }, "billingCollectionMethod": { "$ref": "#/components/schemas/OrganizationCollectionMethod" }, "billingCurrency": { "$ref": "#/components/schemas/OrganizationBillingCurrency" }, "billingCycle": { "$ref": "#/components/schemas/OrganizationBillingCycle" }, "billingEmail": { "type": "string" }, "billingPaymentMethod": { "type": "boolean" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "type": { "enum": [ "organization-updated" ], "type": "string" } }, "required": [ "organizationId", "type" ], "type": "object" }, "AutomationTriggerOrganizationUserInviteCreate": { "properties": { "organizationId": { "type": "string" }, "organizationUserInviteId": { "type": "string" }, "type": { "enum": [ "organization-user-invite-create" ], "type": "string" } }, "required": [ "organizationId", "organizationUserInviteId", "type" ], "type": "object" }, "AutomationTriggerOrganizationUserInviteUsed": { "properties": { "organizationId": { "type": "string" }, "organizationUserInviteId": { "type": "string" }, "type": { "enum": [ "organization-user-invite-used" ], "type": "string" }, "usedByUserId": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "organizationId", "organizationUserInviteId", "type", "usedByUserId", "userId" ], "type": "object" }, "AutomationTriggerUserRegister": { "properties": { "type": { "enum": [ "user-register" ], "type": "string" }, "userId": { "type": "string" } }, "required": [ "type", "userId" ], "type": "object" }, "AutomationTriggerUserUpdate": { "properties": { "type": { "enum": [ "user-update" ], "type": "string" }, "userId": { "type": "string" } }, "required": [ "type", "userId" ], "type": "object" }, "AutomationTriggerUserEmailVerification": { "properties": { "emailVerificationToken": { "type": "string" }, "linkParams": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": { "enum": [ "user-email-verification" ], "type": "string" }, "userId": { "type": "string" } }, "required": [ "emailVerificationToken", "type", "userId" ], "type": "object" }, "AutomationTriggerUserRequestResetPassword": { "properties": { "resetPasswordToken": { "type": "string" }, "type": { "enum": [ "user-request-reset-password" ], "type": "string" }, "userId": { "type": "string" } }, "required": [ "resetPasswordToken", "type", "userId" ], "type": "object" }, "AutomationTriggerSendC4ModelEbook": { "properties": { "email": { "type": "string" }, "type": { "enum": [ "send-c4-model-ebook" ], "type": "string" } }, "required": [ "email", "type" ], "type": "object" }, "AutomationTrigger": { "oneOf": [ { "$ref": "#/components/schemas/AutomationTriggerSchedule" }, { "$ref": "#/components/schemas/AutomationTriggerCatalogTechnologyReviewApproved" }, { "$ref": "#/components/schemas/AutomationTriggerCatalogTechnologyReviewRejected" }, { "$ref": "#/components/schemas/AutomationTriggerCommentCreate" }, { "$ref": "#/components/schemas/AutomationTriggerCommentReplyCreate" }, { "$ref": "#/components/schemas/AutomationTriggerCommentStatusUpdate" }, { "$ref": "#/components/schemas/AutomationTriggerExportPdfReady" }, { "$ref": "#/components/schemas/AutomationTriggerOrganizationBillingChargeRefunded" }, { "$ref": "#/components/schemas/AutomationTriggerOrganizationBillingCheckoutSessionCompleted" }, { "$ref": "#/components/schemas/AutomationTriggerOrganizationBillingInvoicePaid" }, { "$ref": "#/components/schemas/AutomationTriggerOrganizationBillingInvoicePaymentFailed" }, { "$ref": "#/components/schemas/AutomationTriggerOrganizationBillingPaymentMethodAttached" }, { "$ref": "#/components/schemas/AutomationTriggerOrganizationBillingPaymentMethodDetached" }, { "$ref": "#/components/schemas/AutomationTriggerOrganizationBillingSubscriptionChanged" }, { "$ref": "#/components/schemas/AutomationTriggerOrganizationCreate" }, { "$ref": "#/components/schemas/AutomationTriggerOrganizationUpdated" }, { "$ref": "#/components/schemas/AutomationTriggerOrganizationUserInviteCreate" }, { "$ref": "#/components/schemas/AutomationTriggerOrganizationUserInviteUsed" }, { "$ref": "#/components/schemas/AutomationTriggerUserRegister" }, { "$ref": "#/components/schemas/AutomationTriggerUserUpdate" }, { "$ref": "#/components/schemas/AutomationTriggerUserEmailVerification" }, { "$ref": "#/components/schemas/AutomationTriggerUserRequestResetPassword" }, { "$ref": "#/components/schemas/AutomationTriggerSendC4ModelEbook" } ] }, "AzureDevopsAuthorizationPartial": { "properties": { "accountId": { "type": "string" } }, "type": "object" }, "AzureDevopsAuthorization": { "properties": { "accountId": { "type": "string" }, "accountName": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "id": { "type": "string" }, "organizationId": { "type": "string" }, "senderEmail": { "type": "string" }, "senderId": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/AuthType" }, "updatedById": { "type": "string" } }, "required": [ "createdAt", "createdBy", "createdById", "id", "organizationId", "senderEmail", "senderId", "updatedAt", "updatedBy", "updatedById" ], "type": "object" }, "BitbucketAuthorizationPartial": { "properties": { "workspaceId": { "type": "string" } }, "type": "object" }, "BitbucketAuthorization": { "properties": { "workspaceId": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "id": { "type": "string" }, "organizationId": { "type": "string" }, "senderEmail": { "type": "string" }, "senderId": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/AuthType" }, "updatedById": { "type": "string" }, "workspaceName": { "type": "string" } }, "required": [ "createdAt", "createdBy", "createdById", "id", "organizationId", "senderEmail", "senderId", "updatedAt", "updatedBy", "updatedById" ], "type": "object" }, "BitbucketServerTokenPartial": { "properties": { "serverUrl": { "format": "uri", "type": "string" }, "token": { "type": "string" }, "username": { "type": "string" } }, "type": "object" }, "BitbucketServerTokenRequired": { "properties": { "serverUrl": { "format": "uri", "type": "string" }, "token": { "type": "string" }, "username": { "type": "string" } }, "required": [ "serverUrl", "token", "username" ], "type": "object" }, "BitbucketServerToken": { "properties": { "serverUrl": { "format": "uri", "type": "string" }, "token": { "type": "string" }, "username": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "id": { "type": "string" }, "organizationId": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/AuthType" }, "updatedById": { "type": "string" } }, "required": [ "serverUrl", "token", "username", "createdAt", "createdBy", "createdById", "id", "organizationId", "updatedAt", "updatedBy", "updatedById" ], "type": "object" }, "CatalogNewsArticleTag": { "enum": [ "announcement", "breaking", "change", "deprecate", "feature", "fix", "issue", "library", "security" ], "type": "string" }, "CatalogNewsArticleFilter": { "properties": { "catalogTechnologyId": { "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "endAtDate": { "format": "date-time", "type": "string" }, "endAtId": { "type": "string" }, "endBeforeDate": { "format": "date-time", "type": "string" }, "endBeforeId": { "type": "string" }, "limit": { "type": "number" }, "limitToLast": { "type": "number" }, "order": { "enum": [ "asc", "desc" ], "type": "string" }, "startAfterDate": { "format": "date-time", "type": "string" }, "startAfterId": { "type": "string" }, "startAtDate": { "format": "date-time", "type": "string" }, "startAtId": { "type": "string" } }, "type": "object" }, "CatalogNewsArticle": { "properties": { "body": { "type": "string" }, "catalogTechnologyIds": { "items": { "type": "string" }, "type": "array" }, "createdAt": { "format": "date-time", "type": "string" }, "defaultSlug": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "link": { "type": "string" }, "provider": { "$ref": "#/components/schemas/CatalogProviderNullable" }, "publishedAt": { "format": "date-time", "type": "string" }, "slugs": { "items": { "type": "string" }, "type": "array" }, "tags": { "items": { "$ref": "#/components/schemas/CatalogNewsArticleTag" }, "type": "array" }, "title": { "type": "string" } }, "required": [ "body", "catalogTechnologyIds", "createdAt", "defaultSlug", "description", "id", "link", "provider", "publishedAt", "slugs", "tags", "title" ], "type": "object" }, "CatalogIconVariant": { "enum": [ "light", "dark" ], "type": "string" }, "CatalogIconType": { "enum": [ "svg", "webp", "png", "jpeg" ], "type": "string" }, "CatalogProvider": { "enum": [ "aws", "azure", "gcp", "microsoft", "salesforce", "atlassian", "apache", "supabase" ], "type": "string" }, "CatalogProviderNullable": { "enum": [ "aws", "azure", "gcp", "microsoft", "salesforce", "atlassian", "apache", "supabase", null ], "nullable": true, "type": "string" }, "CatalogTechnologyType": { "enum": [ "data-storage", "deployment", "framework-library", "gateway", "other", "language", "message-broker", "network", "protocol", "runtime", "service-tool" ], "type": "string" }, "CatalogTechnologyTypeNullable": { "enum": [ "data-storage", "deployment", "framework-library", "gateway", "other", "language", "message-broker", "network", "protocol", "runtime", "service-tool", null ], "nullable": true, "type": "string" }, "CatalogRestriction": { "enum": [ "actor", "app", "component", "connection", "group", "store", "system", null ], "type": "string" }, "CatalogRestrictionNullable": { "enum": [ "actor", "app", "component", "connection", "group", "store", "system" ], "type": "string" }, "CatalogTechnologyStatus": { "enum": [ "approved", "pending-review", "rejected" ], "type": "string" }, "CatalogTechnologyStatusNullable": { "enum": [ "approved", "pending-review", "rejected", null ], "nullable": true, "type": "string" }, "CatalogTechnologyReviewRejectionReason": { "enum": [ "duplicate", "incomplete", "invalid", "other" ], "type": "string" }, "CatalogTechnologyFilter": { "properties": { "name": { "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "maxItems": 30, "type": "array" } ] }, "provider": { "oneOf": [ { "$ref": "#/components/schemas/CatalogProviderNullable" }, { "items": { "$ref": "#/components/schemas/CatalogProviderNullable" }, "maxItems": 30, "type": "array" } ] }, "restrictions": { "oneOf": [ { "$ref": "#/components/schemas/CatalogRestrictionNullable" }, { "items": { "$ref": "#/components/schemas/CatalogRestrictionNullable" }, "maxItems": 30, "type": "array" } ] }, "status": { "oneOf": [ { "$ref": "#/components/schemas/CatalogTechnologyStatus" }, { "items": { "$ref": "#/components/schemas/CatalogTechnologyStatus" }, "maxItems": 30, "type": "array" } ] }, "type": { "oneOf": [ { "$ref": "#/components/schemas/CatalogTechnologyTypeNullable" }, { "items": { "$ref": "#/components/schemas/CatalogTechnologyTypeNullable" }, "maxItems": 30, "type": "array" } ] } }, "type": "object" }, "CatalogTechnologyPartial": { "properties": { "category": { "maxLength": 1000, "type": "string" }, "color": { "$ref": "#/components/schemas/TagColor", "description": "Technology color used in diagrams" }, "deprecatedAt": { "format": "date-time", "type": "string" }, "description": { "description": "Technical description for the technology, avoid marketing language", "maxLength": 10000, "type": "string" }, "docsUrl": { "description": "Documentation or readme url", "maxLength": 2048, "type": "string" }, "iconUrlDark": { "description": "Icon that only works on dark backgrounds", "example": [ "/organizations/{organizationId}/dark/{catalogTechnologyId}.png", "/dark/{catalogTechnologyId}.png" ], "maxLength": 2048, "nullable": true, "type": "string" }, "iconUrlLight": { "description": "Icon that only works on light backgrounds", "example": [ "/organizations/{organizationId}/light/{catalogTechnologyId}.png", "/light/{catalogTechnologyId}.png" ], "maxLength": 2048, "nullable": true, "type": "string" }, "name": { "description": "Long verbose name", "maxLength": 1000, "type": "string" }, "nameShort": { "description": "Short one or two word name to show in places with limited space", "maxLength": 1000, "type": "string" }, "provider": { "$ref": "#/components/schemas/CatalogProviderNullable", "description": "Service provider that provides this technology" }, "rejectionMessage": { "description": "If rejected, detail description of why", "maxLength": 5000, "type": "string" }, "rejectionReason": { "$ref": "#/components/schemas/CatalogTechnologyReviewRejectionReason", "description": "If rejected, the reason why" }, "restrictions": { "description": "Restriction on which model object or connections this technology can be added to", "items": { "$ref": "#/components/schemas/CatalogRestriction" }, "nullable": true, "type": "array" }, "status": { "$ref": "#/components/schemas/CatalogTechnologyStatusNullable", "description": "Current status of the technology, including pending review, approved, and rejected. Approved technologies are visible to all users. Set to null to make the technology private." }, "type": { "$ref": "#/components/schemas/CatalogTechnologyTypeNullable", "description": "Type or category of technology" }, "updatesUrl": { "description": "Release notes or changelog url", "maxLength": 2048, "type": "string" }, "websiteUrl": { "description": "Landing page website url", "maxLength": 2048, "type": "string" } }, "type": "object" }, "CatalogTechnologyRequired": { "properties": { "category": { "maxLength": 1000, "type": "string" }, "color": { "$ref": "#/components/schemas/TagColor", "description": "Technology color used in diagrams" }, "deprecatedAt": { "format": "date-time", "type": "string" }, "description": { "description": "Technical description for the technology, avoid marketing language", "maxLength": 10000, "type": "string" }, "docsUrl": { "description": "Documentation or readme url", "maxLength": 2048, "type": "string" }, "iconUrlDark": { "description": "Icon that only works on dark backgrounds", "example": [ "/organizations/{organizationId}/dark/{catalogTechnologyId}.png", "/dark/{catalogTechnologyId}.png" ], "maxLength": 2048, "nullable": true, "type": "string" }, "iconUrlLight": { "description": "Icon that only works on light backgrounds", "example": [ "/organizations/{organizationId}/light/{catalogTechnologyId}.png", "/light/{catalogTechnologyId}.png" ], "maxLength": 2048, "nullable": true, "type": "string" }, "name": { "description": "Long verbose name", "maxLength": 1000, "type": "string" }, "nameShort": { "description": "Short one or two word name to show in places with limited space", "maxLength": 1000, "type": "string" }, "provider": { "$ref": "#/components/schemas/CatalogProviderNullable", "description": "Service provider that provides this technology" }, "rejectionMessage": { "description": "If rejected, detail description of why", "maxLength": 5000, "type": "string" }, "rejectionReason": { "$ref": "#/components/schemas/CatalogTechnologyReviewRejectionReason", "description": "If rejected, the reason why" }, "restrictions": { "description": "Restriction on which model object or connections this technology can be added to", "items": { "$ref": "#/components/schemas/CatalogRestriction" }, "nullable": true, "type": "array" }, "status": { "$ref": "#/components/schemas/CatalogTechnologyStatusNullable", "description": "Current status of the technology, including pending review, approved, and rejected. Approved technologies are visible to all users. Set to null to make the technology private." }, "type": { "$ref": "#/components/schemas/CatalogTechnologyTypeNullable", "description": "Type or category of technology" }, "updatesUrl": { "description": "Release notes or changelog url", "maxLength": 2048, "type": "string" }, "websiteUrl": { "description": "Landing page website url", "maxLength": 2048, "type": "string" } }, "required": [ "color", "name", "provider", "restrictions", "type" ], "type": "object" }, "CatalogTechnology": { "properties": { "category": { "maxLength": 1000, "type": "string" }, "color": { "$ref": "#/components/schemas/TagColor", "description": "Technology color used in diagrams" }, "deprecatedAt": { "format": "date-time", "type": "string" }, "description": { "description": "Technical description for the technology, avoid marketing language", "maxLength": 10000, "type": "string" }, "docsUrl": { "description": "Documentation or readme url", "maxLength": 2048, "type": "string" }, "iconUrlDark": { "description": "Icon that only works on dark backgrounds", "example": [ "/organizations/{organizationId}/dark/{catalogTechnologyId}.png", "/dark/{catalogTechnologyId}.png" ], "maxLength": 2048, "nullable": true, "type": "string" }, "iconUrlLight": { "description": "Icon that only works on light backgrounds", "example": [ "/organizations/{organizationId}/light/{catalogTechnologyId}.png", "/light/{catalogTechnologyId}.png" ], "maxLength": 2048, "nullable": true, "type": "string" }, "name": { "description": "Long verbose name", "maxLength": 1000, "type": "string" }, "nameShort": { "description": "Short one or two word name to show in places with limited space", "maxLength": 1000, "type": "string" }, "provider": { "$ref": "#/components/schemas/CatalogProviderNullable", "description": "Service provider that provides this technology" }, "rejectionMessage": { "description": "If rejected, detail description of why", "maxLength": 5000, "type": "string" }, "rejectionReason": { "$ref": "#/components/schemas/CatalogTechnologyReviewRejectionReason", "description": "If rejected, the reason why" }, "restrictions": { "description": "Restriction on which model object or connections this technology can be added to", "items": { "$ref": "#/components/schemas/CatalogRestriction" }, "nullable": true, "type": "array" }, "status": { "$ref": "#/components/schemas/CatalogTechnologyStatusNullable", "description": "Current status of the technology, including pending review, approved, and rejected. Approved technologies are visible to all users. Set to null to make the technology private." }, "type": { "$ref": "#/components/schemas/CatalogTechnologyTypeNullable", "description": "Type or category of technology" }, "updatesUrl": { "description": "Release notes or changelog url", "maxLength": 2048, "type": "string" }, "websiteUrl": { "description": "Landing page website url", "maxLength": 2048, "type": "string" }, "awsXmlSelector": { "type": "string" }, "azureUpdatesKeyword": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "defaultSlug": { "description": "URL path name for the technology, used by stackfeed", "type": "string" }, "deletedAt": { "format": "date-time", "type": "string" }, "deletedBy": { "$ref": "#/components/schemas/AuthType" }, "deletedById": { "type": "string" }, "disabled": { "default": false, "description": "Whether the technology is disabled and not visible to users", "type": "boolean" }, "iconUrl": { "deprecated": true, "description": "Use either iconUrlDark or iconUrlLight", "maxLength": 2048, "nullable": true, "type": "string" }, "id": { "type": "string" }, "organizationId": { "description": "Organization that owns this technology, or null if its publicly accessible", "nullable": true, "type": "string" }, "slugs": { "description": "Current and historical url path names used for the technology, used by stackfeed", "items": { "type": "string" }, "type": "array" }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/AuthType" }, "updatedById": { "type": "string" }, "updatesXmlUrl": { "type": "string" } }, "required": [ "color", "name", "provider", "restrictions", "type", "createdAt", "createdBy", "createdById", "disabled", "iconUrl", "iconUrlDark", "iconUrlLight", "id", "organizationId", "updatedAt", "updatedBy", "updatedById" ], "type": "object" }, "CatalogTechnologyReviewCreate": { "properties": { "catalogTechnologyId": { "type": "string" } }, "required": [ "catalogTechnologyId" ], "type": "object" }, "CatalogSuggestionInformation": { "properties": { "description": { "description": "Technical description for the technology", "maxLength": 100000, "type": "string" }, "docsUrl": { "description": "Documentation or readme url", "maxLength": 2048, "type": "string" }, "githubUrl": { "description": "GitHub repo url", "maxLength": 2048, "type": "string" }, "name": { "maxLength": 4000, "type": "string" }, "nameShort": { "description": "Short name to show in places with limited space", "maxLength": 1000, "type": "string" }, "newsUrl": { "description": "News url", "maxLength": 2048, "type": "string" }, "type": { "$ref": "#/components/schemas/CatalogTechnologyTypeNullable", "description": "Type or category of technology" }, "updatesUrl": { "description": "Release notes or changelog url", "maxLength": 2048, "type": "string" } }, "type": "object" }, "CatalogSuggestionBrandColor": { "properties": { "brightness": { "description": "Color brightness. Calculated based on the standard formula 0.2126R + 0.7152G + 0.0722*B", "type": "number" }, "hex": { "description": "Hexadecimal color code", "type": "string" }, "type": { "description": "Color type. For example, \"accent\" or \"dark\"", "enum": [ "accent", "dark", "light", "brand" ], "type": "string" } }, "required": [ "hex", "type", "brightness" ], "type": "object" }, "CatalogSuggestionBrandLogoFormat": { "properties": { "background": { "description": "Indicates if the file has a transparent background.", "nullable": true, "type": "string" }, "format": { "description": "File format of the logo", "enum": [ "svg", "png", "webp", "jpeg" ], "type": "string" }, "height": { "description": "Height of the logo in pixels", "nullable": true, "type": "number" }, "size": { "description": "File size in bytes", "type": "number" }, "src": { "description": "File source url of the logo", "type": "string" }, "width": { "description": "Width of the logo in pixels", "nullable": true, "type": "number" } }, "required": [ "background", "format", "height", "size", "src", "width" ], "type": "object" }, "CatalogSuggestionBrandLogo": { "properties": { "formats": { "description": "A list of format objects containing files in different formats", "items": { "$ref": "#/components/schemas/CatalogSuggestionBrandLogoFormat" }, "type": "array" }, "tags": { "description": "A list of strings attached to the logo. For example, if the logo icon is \"photographic\" rather than a logomark.", "items": { "type": "string" }, "type": "array" }, "theme": { "description": "Theme of the logo. For example, \"dark\" or \"light\"", "enum": [ "light", "dark", null ], "nullable": true, "type": "string" }, "type": { "description": "Logo type. For example, \"icon\" or \"symbol\"", "enum": [ "icon", "logo", "symbol", "other" ], "type": "string" } }, "required": [ "type", "formats", "theme", "tags" ], "type": "object" }, "CatalogSuggestionBrand": { "properties": { "colors": { "description": "Accent, dark, light & palette colors of the brand", "items": { "$ref": "#/components/schemas/CatalogSuggestionBrandColor" }, "type": "array" }, "isNsfw": { "description": "true when the brand is for adult content, e.g. is not safe for work", "type": "boolean" }, "logos": { "description": "Logos, symbols & icons of the brand", "items": { "$ref": "#/components/schemas/CatalogSuggestionBrandLogo" }, "type": "array" } }, "required": [ "isNsfw", "logos", "colors" ], "type": "object" }, "CodeRepoFilter": { "properties": { "azureDevopsUrl": { "format": "uri", "type": "string" }, "bitbucketServerUrl": { "format": "uri", "type": "string" }, "bitbucketUrl": { "format": "uri", "type": "string" }, "githubUrl": { "format": "uri", "type": "string" }, "gitlabUrl": { "format": "uri", "type": "string" }, "type": { "$ref": "#/components/schemas/CodeRepoType" }, "url": { "format": "uri", "type": "string" } }, "type": "object" }, "CodeRepoTreeItemType": { "enum": [ "blob", "tree" ], "type": "string" }, "CodeRepoTreeItem": { "properties": { "language": { "type": "string" }, "path": { "type": "string" }, "sha": { "type": "string" }, "size": { "type": "number" }, "type": { "$ref": "#/components/schemas/CodeRepoTreeItemType" } }, "required": [ "path", "sha", "type" ], "type": "object" }, "CodeRepoRefType": { "enum": [ "branch" ], "type": "string" }, "CodeRepoRef": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "sha": { "type": "string" }, "type": { "$ref": "#/components/schemas/CodeRepoRefType" } }, "required": [ "id", "name", "sha", "type" ], "type": "object" }, "CodeRepoType": { "enum": [ "azure-devops", "bitbucket", "bitbucket-server", "github", "gitlab" ], "type": "string" }, "CodeRepoPartial": { "properties": { "azureDevopsAccountName": { "type": "string" }, "azureDevopsProjectId": { "type": "string" }, "azureDevopsRepositoryId": { "type": "string" }, "azureDevopsUrl": { "format": "uri", "type": "string" }, "bitbucketProjectId": { "type": "string" }, "bitbucketRepositoryId": { "type": "string" }, "bitbucketServerProjectId": { "type": "number" }, "bitbucketServerProjectKey": { "type": "string" }, "bitbucketServerRepositoryId": { "type": "number" }, "bitbucketServerRepositorySlug": { "type": "string" }, "bitbucketServerUrl": { "format": "uri", "type": "string" }, "bitbucketUrl": { "format": "uri", "type": "string" }, "bitbucketWorkspaceId": { "type": "string" }, "githubOwnerId": { "type": "number" }, "githubOwnerLogin": { "type": "string" }, "githubRepositoryId": { "type": "number" }, "githubRepositoryName": { "type": "string" }, "githubUrl": { "format": "uri", "type": "string" }, "gitlabGroupId": { "type": "number" }, "gitlabProjectId": { "type": "number" }, "gitlabUrl": { "format": "uri", "type": "string" }, "name": { "maxLength": 4000, "type": "string" }, "refs": { "additionalProperties": { "$ref": "#/components/schemas/CodeRepoRef" }, "type": "object" }, "type": { "$ref": "#/components/schemas/CodeRepoType" }, "url": { "format": "uri", "type": "string" } }, "type": "object" }, "CodeRepoRequired": { "properties": { "azureDevopsAccountName": { "type": "string" }, "azureDevopsProjectId": { "type": "string" }, "azureDevopsRepositoryId": { "type": "string" }, "azureDevopsUrl": { "format": "uri", "type": "string" }, "bitbucketProjectId": { "type": "string" }, "bitbucketRepositoryId": { "type": "string" }, "bitbucketServerProjectId": { "type": "number" }, "bitbucketServerProjectKey": { "type": "string" }, "bitbucketServerRepositoryId": { "type": "number" }, "bitbucketServerRepositorySlug": { "type": "string" }, "bitbucketServerUrl": { "format": "uri", "type": "string" }, "bitbucketUrl": { "format": "uri", "type": "string" }, "bitbucketWorkspaceId": { "type": "string" }, "githubOwnerId": { "type": "number" }, "githubOwnerLogin": { "type": "string" }, "githubRepositoryId": { "type": "number" }, "githubRepositoryName": { "type": "string" }, "githubUrl": { "format": "uri", "type": "string" }, "gitlabGroupId": { "type": "number" }, "gitlabProjectId": { "type": "number" }, "gitlabUrl": { "format": "uri", "type": "string" }, "name": { "maxLength": 4000, "type": "string" }, "refs": { "additionalProperties": { "$ref": "#/components/schemas/CodeRepoRef" }, "type": "object" }, "type": { "$ref": "#/components/schemas/CodeRepoType" }, "url": { "format": "uri", "type": "string" } }, "required": [ "name", "type", "url" ], "type": "object" }, "CodeRepo": { "properties": { "azureDevopsAccountName": { "type": "string" }, "azureDevopsProjectId": { "type": "string" }, "azureDevopsRepositoryId": { "type": "string" }, "azureDevopsUrl": { "format": "uri", "type": "string" }, "bitbucketProjectId": { "type": "string" }, "bitbucketRepositoryId": { "type": "string" }, "bitbucketServerProjectId": { "type": "number" }, "bitbucketServerProjectKey": { "type": "string" }, "bitbucketServerRepositoryId": { "type": "number" }, "bitbucketServerRepositorySlug": { "type": "string" }, "bitbucketServerUrl": { "format": "uri", "type": "string" }, "bitbucketUrl": { "format": "uri", "type": "string" }, "bitbucketWorkspaceId": { "type": "string" }, "githubOwnerId": { "type": "number" }, "githubOwnerLogin": { "type": "string" }, "githubRepositoryId": { "type": "number" }, "githubRepositoryName": { "type": "string" }, "githubUrl": { "format": "uri", "type": "string" }, "gitlabGroupId": { "type": "number" }, "gitlabProjectId": { "type": "number" }, "gitlabUrl": { "format": "uri", "type": "string" }, "name": { "maxLength": 4000, "type": "string" }, "refs": { "additionalProperties": { "$ref": "#/components/schemas/CodeRepoRef" }, "type": "object" }, "type": { "$ref": "#/components/schemas/CodeRepoType" }, "url": { "format": "uri", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "id": { "type": "string" }, "organizationId": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/AuthType" }, "updatedById": { "type": "string" } }, "required": [ "name", "type", "url", "createdAt", "createdBy", "createdById", "id", "organizationId", "refs", "updatedAt", "updatedBy", "updatedById" ], "type": "object" }, "CommentDiagram": { "properties": { "commentId": { "type": "string" }, "id": { "type": "string" } }, "required": [ "id", "commentId" ], "type": "object" }, "CommentPartial": { "properties": { "body": { "$ref": "#/components/schemas/CommentBody" }, "commit": { "type": "number" }, "mentionedUserIds": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "CommentRequired": { "properties": { "body": { "$ref": "#/components/schemas/CommentBody" }, "commit": { "type": "number" }, "mentionedUserIds": { "items": { "type": "string" }, "type": "array" }, "handleId": { "type": "string" } }, "required": [ "body" ], "type": "object" }, "CommentUpsert": { "allOf": [ { "$ref": "#/components/schemas/CommentRequired" }, { "$ref": "#/components/schemas/CommentPartial" } ] }, "Comment": { "properties": { "body": { "$ref": "#/components/schemas/CommentBody" }, "commit": { "type": "number" }, "mentionedUserIds": { "items": { "type": "string" }, "type": "array" }, "handleId": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "deletedAt": { "format": "date-time", "type": "string" }, "deletedBy": { "$ref": "#/components/schemas/AuthType" }, "deletedById": { "type": "string" }, "diagrams": { "additionalProperties": { "$ref": "#/components/schemas/CommentDiagram" }, "type": "object" }, "id": { "type": "string" }, "landscapeId": { "type": "string" }, "latestEntityId": { "type": "string" }, "replyCount": { "type": "number" }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/AuthType" }, "updatedById": { "type": "string" }, "version": { "type": "number" }, "versionId": { "type": "string" } }, "required": [ "body", "commit", "createdAt", "createdBy", "createdById", "diagrams", "handleId", "id", "landscapeId", "mentionedUserIds", "replyCount", "updatedAt", "updatedBy", "updatedById", "version", "versionId" ], "type": "object" }, "CommentBodyType": { "enum": [ "idea", "inaccurate", "new-idea", "new-inaccurate", "new-question", "question" ], "type": "string" }, "CommentBodyStatus": { "enum": [ "active", "create", "dismissed", "open", "resolved" ], "type": "string" }, "CommentBodyNewIdea": { "properties": { "content": { "maxLength": 950000, "type": "string" }, "showContentPreview": { "type": "boolean" }, "status": { "enum": [ "create" ], "type": "string" }, "type": { "enum": [ "new-idea" ], "type": "string" } }, "required": [ "type", "status", "content" ], "type": "object" }, "CommentBodyNewQuestion": { "properties": { "content": { "maxLength": 950000, "type": "string" }, "showContentPreview": { "type": "boolean" }, "status": { "enum": [ "create" ], "type": "string" }, "type": { "enum": [ "new-question" ], "type": "string" } }, "required": [ "type", "status", "content" ], "type": "object" }, "CommentBodyNewInaccuracy": { "properties": { "content": { "maxLength": 950000, "type": "string" }, "showContentPreview": { "type": "boolean" }, "status": { "enum": [ "create" ], "type": "string" }, "type": { "enum": [ "new-inaccurate" ], "type": "string" } }, "required": [ "type", "status", "content" ], "type": "object" }, "CommentBodyQuestion": { "properties": { "content": { "maxLength": 950000, "type": "string" }, "showContentPreview": { "type": "boolean" }, "status": { "enum": [ "open", "resolved" ], "type": "string" }, "type": { "enum": [ "question" ], "type": "string" } }, "required": [ "type", "status", "content" ], "type": "object" }, "CommentBodyInaccuracy": { "properties": { "content": { "maxLength": 950000, "type": "string" }, "showContentPreview": { "type": "boolean" }, "status": { "enum": [ "open", "resolved" ], "type": "string" }, "type": { "enum": [ "inaccurate" ], "type": "string" } }, "required": [ "type", "status", "content" ], "type": "object" }, "CommentBodyIdea": { "properties": { "content": { "maxLength": 950000, "type": "string" }, "showContentPreview": { "type": "boolean" }, "status": { "enum": [ "active", "dismissed" ], "type": "string" }, "type": { "enum": [ "idea" ], "type": "string" } }, "required": [ "type", "status", "content" ], "type": "object" }, "CommentBody": { "oneOf": [ { "$ref": "#/components/schemas/CommentBodyQuestion" }, { "$ref": "#/components/schemas/CommentBodyInaccuracy" }, { "$ref": "#/components/schemas/CommentBodyIdea" }, { "$ref": "#/components/schemas/CommentBodyNewQuestion" }, { "$ref": "#/components/schemas/CommentBodyNewInaccuracy" }, { "$ref": "#/components/schemas/CommentBodyNewIdea" } ] }, "CommentReplyPartial": { "properties": { "content": { "maxLength": 950000, "type": "string" }, "mentionedUserIds": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "CommentReplyRequired": { "properties": { "content": { "maxLength": 950000, "type": "string" }, "mentionedUserIds": { "items": { "type": "string" }, "type": "array" } }, "required": [ "content" ], "type": "object" }, "CommentReplyUpsert": { "allOf": [ { "$ref": "#/components/schemas/CommentReplyRequired" }, { "$ref": "#/components/schemas/CommentReplyPartial" } ] }, "CommentReply": { "properties": { "content": { "maxLength": 950000, "type": "string" }, "mentionedUserIds": { "items": { "type": "string" }, "type": "array" }, "commentId": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "deletedAt": { "format": "date-time", "type": "string" }, "deletedBy": { "$ref": "#/components/schemas/AuthType" }, "deletedById": { "type": "string" }, "id": { "type": "string" }, "landscapeId": { "type": "string" }, "latestEntityId": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/AuthType" }, "updatedById": { "type": "string" }, "versionId": { "type": "string" } }, "required": [ "content", "commentId", "createdAt", "createdBy", "createdById", "id", "landscapeId", "mentionedUserIds", "updatedAt", "updatedBy", "updatedById", "versionId" ], "type": "object" }, "DiagramExportPngOptions": { "properties": { "filename": { "type": "string" }, "flowId": { "type": "string" }, "flowParentIds": { "items": { "type": "string" }, "type": "array" }, "flowPathIds": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "overlayGroupId": { "type": "string" }, "overlayIdsFocused": { "items": { "type": "string" }, "type": "array" }, "overlayIdsHidden": { "items": { "type": "string" }, "type": "array" }, "overlayIdsPinned": { "items": { "type": "string" }, "type": "array" }, "overlayTab": { "enum": [ "tags", "technology", "status", "teams" ], "type": "string" }, "theme": { "$ref": "#/components/schemas/Theme" } }, "type": "object" }, "DiagramAction": { "enum": [ "initial-load", "load", "zoom" ], "type": "string" }, "DiagramFilter": { "properties": { "empty": { "description": "Filter diagrams that contain no objects", "type": "boolean" }, "handleId": { "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "maxItems": 30, "type": "array" } ] }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "modelId": { "type": "string" }, "name": { "type": "string" }, "pinned": { "type": "boolean" }, "status": { "oneOf": [ { "$ref": "#/components/schemas/DiagramStatus" }, { "items": { "$ref": "#/components/schemas/DiagramStatus" }, "maxItems": 30, "type": "array" } ] }, "type": { "oneOf": [ { "$ref": "#/components/schemas/DiagramType" }, { "items": { "$ref": "#/components/schemas/DiagramType" }, "maxItems": 30, "type": "array" } ] } }, "type": "object" }, "DiagramThumbnail": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "expires": { "format": "date-time", "type": "string" }, "handleId": { "type": "string" }, "id": { "type": "string" }, "index": { "type": "number" }, "modelId": { "type": "string" }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/DiagramType" }, "updatedAt": { "format": "date-time", "type": "string" }, "url": { "format": "uri", "type": "string" } }, "required": [ "createdAt", "expires", "handleId", "id", "index", "modelId", "name", "type", "updatedAt", "url" ], "type": "object" }, "DiagramType": { "enum": [ "app-diagram", "component-diagram", "context-diagram" ], "type": "string" }, "DiagramStatus": { "enum": [ "current" ], "type": "string" }, "DiagramPartial": { "properties": { "commit": { "type": "number" }, "description": { "maxLength": 950000, "type": "string" }, "groupId": { "nullable": true, "type": "string" }, "index": { "type": "number" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "modelId": { "description": "model object id this object belongs to", "type": "string" }, "name": { "maxLength": 4000, "type": "string" }, "parentId": { "nullable": true, "type": "string" }, "pinned": { "type": "boolean" }, "pinnedAt": { "format": "date-time", "type": "string" }, "pinnedIndex": { "type": "number" }, "status": { "$ref": "#/components/schemas/DiagramStatus" }, "zoomOverrides": { "$ref": "#/components/schemas/DiagramZoomOverridesNullable" } }, "type": "object" }, "DiagramRequired": { "properties": { "commit": { "type": "number" }, "description": { "maxLength": 950000, "type": "string" }, "groupId": { "nullable": true, "type": "string" }, "index": { "type": "number" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "modelId": { "description": "model object id this object belongs to", "type": "string" }, "name": { "maxLength": 4000, "type": "string" }, "parentId": { "nullable": true, "type": "string" }, "pinned": { "type": "boolean" }, "pinnedAt": { "format": "date-time", "type": "string" }, "pinnedIndex": { "type": "number" }, "status": { "$ref": "#/components/schemas/DiagramStatus" }, "zoomOverrides": { "$ref": "#/components/schemas/DiagramZoomOverridesNullable" }, "handleId": { "type": "string" }, "type": { "$ref": "#/components/schemas/DiagramType" } }, "required": [ "index", "modelId", "name", "type" ], "type": "object" }, "DiagramZoomOverrides": { "additionalProperties": { "type": "string" }, "description": "Custom zoom levels for specific model objects within the diagram. The key is the modelObjectId and the value is the diagram id.", "type": "object" }, "DiagramZoomOverridesNullable": { "oneOf": [ { "$ref": "#/components/schemas/DiagramZoomOverrides" }, { "type": "null" } ] }, "DiagramUpsert": { "allOf": [ { "$ref": "#/components/schemas/DiagramPartial" }, { "$ref": "#/components/schemas/DiagramContentPartial" } ] }, "Diagram": { "properties": { "commit": { "type": "number" }, "description": { "maxLength": 950000, "type": "string" }, "groupId": { "nullable": true, "type": "string" }, "index": { "type": "number" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "modelId": { "description": "model object id this object belongs to", "type": "string" }, "name": { "maxLength": 4000, "type": "string" }, "parentId": { "nullable": true, "type": "string" }, "pinned": { "type": "boolean" }, "pinnedAt": { "format": "date-time", "type": "string" }, "pinnedIndex": { "type": "number" }, "status": { "$ref": "#/components/schemas/DiagramStatus" }, "zoomOverrides": { "$ref": "#/components/schemas/DiagramZoomOverridesNullable" }, "handleId": { "type": "string" }, "type": { "$ref": "#/components/schemas/DiagramType" }, "commentCount": { "type": "number" }, "connectionCount": { "type": "number" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "deletedAt": { "format": "date-time", "type": "string" }, "deletedBy": { "$ref": "#/components/schemas/AuthType" }, "deletedById": { "type": "string" }, "id": { "type": "string" }, "landscapeId": { "type": "string" }, "latestEntityId": { "type": "string" }, "objectCount": { "$ref": "#/components/schemas/DiagramObjectCount" }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/AuthType" }, "updatedById": { "type": "string" }, "version": { "type": "number" }, "versionId": { "type": "string" } }, "required": [ "index", "modelId", "name", "type", "commentCount", "commit", "connectionCount", "createdAt", "createdBy", "createdById", "groupId", "handleId", "id", "labels", "landscapeId", "objectCount", "parentId", "pinned", "status", "updatedAt", "updatedBy", "updatedById", "version", "versionId" ], "type": "object" }, "DiagramCreate": { "allOf": [ { "$ref": "#/components/schemas/DiagramRequired" }, { "$ref": "#/components/schemas/DiagramContentRequired" } ] }, "DiagramObjectShape": { "enum": [ "area", "box" ], "type": "string" }, "DiagramObjectType": { "enum": [ "actor", "app", "group", "component", "store", "system" ], "type": "string" }, "DiagramObjectCount": { "properties": { "actor": { "type": "number" }, "app": { "type": "number" }, "group": { "type": "number" }, "component": { "type": "number" }, "store": { "type": "number" }, "system": { "type": "number" }, "area": { "type": "number" }, "box": { "type": "number" } }, "required": [ "actor", "app", "group", "component", "store", "system", "area", "box" ], "type": "object" }, "DiagramObjectConnector": { "enum": [ "top-left", "top-center", "top-right", "right-top", "right-middle", "right-bottom", "bottom-right", "bottom-center", "bottom-left", "left-bottom", "left-middle", "left-top" ], "nullable": true, "type": "string" }, "DiagramObjectPartial": { "properties": { "height": { "type": "number" }, "id": { "type": "string" }, "modelId": { "type": "string" }, "shape": { "$ref": "#/components/schemas/DiagramObjectShape" }, "type": { "$ref": "#/components/schemas/DiagramObjectType" }, "width": { "type": "number" }, "x": { "type": "number" }, "y": { "type": "number" } }, "type": "object" }, "DiagramObject": { "properties": { "height": { "type": "number" }, "id": { "type": "string" }, "modelId": { "type": "string" }, "shape": { "$ref": "#/components/schemas/DiagramObjectShape" }, "type": { "$ref": "#/components/schemas/DiagramObjectType" }, "width": { "type": "number" }, "x": { "type": "number" }, "y": { "type": "number" } }, "required": [ "height", "id", "modelId", "shape", "type", "width", "x", "y" ], "type": "object" }, "LineShape": { "enum": [ "curved", "straight", "square" ], "type": "string" }, "DiagramConnectionPartial": { "properties": { "id": { "type": "string" }, "labelPosition": { "description": "The percentage along the line where the label should be placed", "type": "number" }, "lineShape": { "$ref": "#/components/schemas/LineShape" }, "modelId": { "nullable": true, "type": "string" }, "originConnector": { "$ref": "#/components/schemas/DiagramObjectConnector" }, "originId": { "nullable": true, "type": "string" }, "points": { "items": { "properties": { "x": { "type": "number" }, "y": { "type": "number" } }, "required": [ "x", "y" ], "type": "object" }, "type": "array" }, "targetConnector": { "$ref": "#/components/schemas/DiagramObjectConnector" }, "targetId": { "nullable": true, "type": "string" } }, "type": "object" }, "DiagramConnection": { "properties": { "id": { "type": "string" }, "labelPosition": { "description": "The percentage along the line where the label should be placed", "type": "number" }, "lineShape": { "$ref": "#/components/schemas/LineShape" }, "modelId": { "nullable": true, "type": "string" }, "originConnector": { "$ref": "#/components/schemas/DiagramObjectConnector" }, "originId": { "nullable": true, "type": "string" }, "points": { "items": { "properties": { "x": { "type": "number" }, "y": { "type": "number" } }, "required": [ "x", "y" ], "type": "object" }, "type": "array" }, "targetConnector": { "$ref": "#/components/schemas/DiagramObjectConnector" }, "targetId": { "nullable": true, "type": "string" } }, "required": [ "id", "labelPosition", "lineShape", "modelId", "originConnector", "originId", "points", "targetConnector", "targetId" ], "type": "object" }, "DiagramCommentPartial": { "properties": { "commentId": { "type": "string" }, "id": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" } }, "type": "object" }, "DiagramComment": { "properties": { "commentId": { "type": "string" }, "id": { "type": "string" }, "x": { "type": "number" }, "y": { "type": "number" } }, "required": [ "commentId", "id", "x", "y" ], "type": "object" }, "DiagramContentPartial": { "properties": { "comments": { "properties": { "$add": { "additionalProperties": { "$ref": "#/components/schemas/DiagramComment" }, "type": "object" }, "$remove": { "items": { "type": "string" }, "type": "array" }, "$replace": { "additionalProperties": { "$ref": "#/components/schemas/DiagramComment" }, "type": "object" }, "$update": { "additionalProperties": { "$ref": "#/components/schemas/DiagramCommentPartial" }, "type": "object" } }, "type": "object" }, "commit": { "type": "number" }, "connections": { "properties": { "$add": { "additionalProperties": { "$ref": "#/components/schemas/DiagramConnection" }, "type": "object" }, "$remove": { "items": { "type": "string" }, "type": "array" }, "$replace": { "additionalProperties": { "$ref": "#/components/schemas/DiagramConnection" }, "type": "object" }, "$update": { "additionalProperties": { "$ref": "#/components/schemas/DiagramConnectionPartial" }, "type": "object" } }, "type": "object" }, "objects": { "properties": { "$add": { "additionalProperties": { "$ref": "#/components/schemas/DiagramObject" }, "type": "object" }, "$remove": { "items": { "type": "string" }, "type": "array" }, "$replace": { "additionalProperties": { "$ref": "#/components/schemas/DiagramObject" }, "type": "object" }, "$update": { "additionalProperties": { "$ref": "#/components/schemas/DiagramObjectPartial" }, "type": "object" } }, "type": "object" } }, "type": "object" }, "DiagramContentRequired": { "properties": { "comments": { "additionalProperties": { "$ref": "#/components/schemas/DiagramComment" }, "type": "object" }, "commit": { "type": "number" }, "connections": { "additionalProperties": { "$ref": "#/components/schemas/DiagramConnection" }, "type": "object" }, "objects": { "additionalProperties": { "$ref": "#/components/schemas/DiagramObject" }, "type": "object" } }, "type": "object" }, "DiagramContent": { "properties": { "comments": { "additionalProperties": { "$ref": "#/components/schemas/DiagramComment" }, "type": "object" }, "commit": { "type": "number" }, "connections": { "additionalProperties": { "$ref": "#/components/schemas/DiagramConnection" }, "type": "object" }, "objects": { "additionalProperties": { "$ref": "#/components/schemas/DiagramObject" }, "type": "object" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "deletedAt": { "format": "date-time", "type": "string" }, "deletedBy": { "$ref": "#/components/schemas/AuthType" }, "deletedById": { "type": "string" }, "groupId": { "nullable": true, "type": "string" }, "handleId": { "type": "string" }, "id": { "type": "string" }, "landscapeId": { "type": "string" }, "latestEntityId": { "type": "string" }, "modelId": { "type": "string" }, "name": { "type": "string" }, "status": { "$ref": "#/components/schemas/DiagramStatus" }, "type": { "$ref": "#/components/schemas/DiagramType" }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/AuthType" }, "updatedById": { "type": "string" }, "version": { "type": "number" }, "versionId": { "type": "string" }, "viewedAt": { "format": "date-time", "type": "string" }, "viewedBy": { "$ref": "#/components/schemas/AuthType" }, "viewedById": { "type": "string" } }, "required": [ "comments", "commit", "connections", "createdAt", "createdBy", "createdById", "groupId", "handleId", "id", "landscapeId", "modelId", "name", "objects", "status", "type", "updatedAt", "updatedBy", "updatedById", "version", "versionId" ], "type": "object" }, "DiagramContentNullable": { "oneOf": [ { "$ref": "#/components/schemas/DiagramContent" }, { "type": "null" } ] }, "DiagramContentGenerateDescriptionFilter": { "properties": { "modelObjectIds": { "description": "Filter any objects with these model object ids, if not provided, all objects in the diagram will be included", "items": { "type": "string" }, "type": "array" }, "type": { "$ref": "#/components/schemas/AIDescriptionType", "description": "Type description to generate: \"caption\" or \"detailed\"" } }, "required": [ "type" ], "type": "object" }, "DiagramExportImageOptions": { "properties": { "draftId": { "description": "Fetch and apply draft tasks before producing the export", "type": "string" }, "flowId": { "type": "string" }, "flowPathIds": { "items": { "type": "string" }, "type": "array" }, "focusIds": { "items": { "type": "string" }, "type": "array" }, "groupId": { "type": "string" }, "hideIds": { "items": { "type": "string" }, "type": "array" }, "maxWidth": { "description": "Maximum pixel width for the exported PNG. The image will be scaled down if the diagram exceeds this width. Defaults to no limit (up to 10240px).", "maximum": 10240, "minimum": 100, "type": "integer" }, "pinIds": { "items": { "type": "string" }, "type": "array" }, "tab": { "enum": [ "tags", "technology", "status", "teams" ], "type": "string" }, "theme": { "$ref": "#/components/schemas/Theme" } }, "type": "object" }, "DiagramExportImageFileType": { "enum": [ "png", "svg" ], "type": "string" }, "DiagramExportImageFileUrls": { "properties": { "png": { "format": "uri", "type": "string" }, "svg": { "format": "uri", "type": "string" } }, "required": [ "png", "svg" ], "type": "object" }, "DiagramExportImage": { "properties": { "completedAt": { "format": "date-time", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "deleteAt": { "format": "date-time", "type": "string" }, "diagramId": { "type": "string" }, "error": { "nullable": true, "type": "string" }, "fileUrls": { "$ref": "#/components/schemas/DiagramExportImageFileUrls" }, "id": { "type": "string" }, "landscapeId": { "type": "string" }, "options": { "$ref": "#/components/schemas/DiagramExportImageOptions" }, "versionId": { "type": "string" } }, "required": [ "createdAt", "deleteAt", "diagramId", "error", "fileUrls", "id", "landscapeId", "options", "versionId" ], "type": "object" }, "DiagramGroupFilter": { "properties": { "handleId": { "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "maxItems": 30, "type": "array" } ] }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "modelId": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "DiagramGroupPartial": { "properties": { "commit": { "type": "number" }, "index": { "type": "number" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "modelId": { "type": "string" }, "name": { "maxLength": 4000, "type": "string" } }, "type": "object" }, "DiagramGroupRequired": { "properties": { "commit": { "type": "number" }, "index": { "type": "number" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "modelId": { "type": "string" }, "name": { "maxLength": 4000, "type": "string" }, "handleId": { "type": "string" } }, "required": [ "modelId", "name" ], "type": "object" }, "DiagramGroupUpsert": { "allOf": [ { "$ref": "#/components/schemas/DiagramGroupRequired" }, { "$ref": "#/components/schemas/DiagramGroupPartial" } ] }, "DiagramGroup": { "properties": { "commit": { "type": "number" }, "index": { "type": "number" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "modelId": { "type": "string" }, "name": { "maxLength": 4000, "type": "string" }, "handleId": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "deletedAt": { "format": "date-time", "type": "string" }, "deletedBy": { "$ref": "#/components/schemas/AuthType" }, "deletedById": { "type": "string" }, "id": { "type": "string" }, "landscapeId": { "type": "string" }, "latestEntityId": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/AuthType" }, "updatedById": { "type": "string" }, "version": { "type": "number" }, "versionId": { "type": "string" } }, "required": [ "modelId", "name", "commit", "createdAt", "createdBy", "createdById", "handleId", "id", "index", "labels", "landscapeId", "updatedAt", "updatedBy", "updatedById", "version", "versionId" ], "type": "object" }, "DomainFilter": { "properties": { "handleId": { "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "maxItems": 30, "type": "array" } ] }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "name": { "type": "string" } }, "type": "object" }, "DomainPartial": { "properties": { "commit": { "type": "number" }, "index": { "type": "number" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "name": { "maxLength": 4000, "type": "string" } }, "type": "object" }, "DomainRequired": { "properties": { "commit": { "type": "number" }, "index": { "type": "number" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "name": { "maxLength": 4000, "type": "string" }, "handleId": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "DomainUpsert": { "allOf": [ { "$ref": "#/components/schemas/DomainRequired" }, { "$ref": "#/components/schemas/DomainPartial" } ] }, "Domain": { "properties": { "commit": { "type": "number" }, "index": { "type": "number" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "name": { "maxLength": 4000, "type": "string" }, "handleId": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "deletedAt": { "format": "date-time", "type": "string" }, "deletedBy": { "$ref": "#/components/schemas/AuthType" }, "deletedById": { "type": "string" }, "id": { "type": "string" }, "landscapeId": { "type": "string" }, "latestEntityId": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/AuthType" }, "updatedById": { "type": "string" }, "version": { "type": "number" }, "versionId": { "type": "string" } }, "required": [ "name", "commit", "createdAt", "createdBy", "createdById", "handleId", "id", "index", "labels", "landscapeId", "updatedAt", "updatedBy", "updatedById", "version", "versionId" ], "type": "object" }, "DraftStatus": { "enum": [ "in-progress", "merged", "archived" ], "type": "string" }, "DraftChangeSummary": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "summary": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "summary", "createdAt", "updatedAt" ], "type": "object" }, "DraftFilter": { "properties": { "name": { "type": "string" }, "status": { "oneOf": [ { "$ref": "#/components/schemas/DraftStatus" }, { "items": { "$ref": "#/components/schemas/DraftStatus" }, "maxItems": 3, "type": "array" } ] } }, "type": "object" }, "DraftPartial": { "properties": { "changeSummary": { "$ref": "#/components/schemas/DraftChangeSummary" }, "commit": { "type": "number" }, "handleId": { "type": "string" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "name": { "maxLength": 4000, "type": "string" }, "status": { "$ref": "#/components/schemas/DraftStatus" }, "summaryDirtiedAt": { "format": "date-time", "type": "string" } }, "type": "object" }, "DraftRequired": { "properties": { "changeSummary": { "$ref": "#/components/schemas/DraftChangeSummary" }, "commit": { "type": "number" }, "handleId": { "type": "string" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "name": { "maxLength": 4000, "type": "string" }, "status": { "$ref": "#/components/schemas/DraftStatus" }, "summaryDirtiedAt": { "format": "date-time", "type": "string" } }, "required": [ "name", "status" ], "type": "object" }, "Draft": { "properties": { "changeSummary": { "$ref": "#/components/schemas/DraftChangeSummary" }, "commit": { "type": "number" }, "handleId": { "type": "string" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "name": { "maxLength": 4000, "type": "string" }, "status": { "$ref": "#/components/schemas/DraftStatus" }, "summaryDirtiedAt": { "format": "date-time", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "deletedAt": { "format": "date-time", "type": "string" }, "deletedBy": { "$ref": "#/components/schemas/AuthType" }, "deletedById": { "type": "string" }, "headVersionId": { "type": "string" }, "id": { "type": "string" }, "landscapeId": { "type": "string" }, "latestEntityId": { "type": "string" }, "mergedAt": { "format": "date-time", "type": "string" }, "mergedBy": { "$ref": "#/components/schemas/AuthType" }, "mergedById": { "type": "string" }, "originVersionId": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/AuthType" }, "updatedById": { "type": "string" }, "version": { "type": "number" }, "versionId": { "type": "string" }, "viewedAt": { "format": "date-time", "type": "string" }, "viewedBy": { "$ref": "#/components/schemas/AuthType" }, "viewedById": { "type": "string" } }, "required": [ "name", "status", "commit", "createdAt", "createdBy", "createdById", "handleId", "id", "labels", "landscapeId", "originVersionId", "updatedAt", "updatedBy", "updatedById", "version", "versionId" ], "type": "object" }, "DraftConflictType": { "enum": [ "overwrite", "invalid-entity", "invalid-entity-reference" ], "type": "string" }, "DraftConflict": { "properties": { "currentValue": { "description": "Current value in the main landscape/version", "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "draftTaskId": { "description": "ID of the draft task that caused this conflict", "type": "string" }, "draftValue": { "description": "New value proposed by the draft task", "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "entityId": { "type": "string" }, "fieldName": { "description": "Name of the conflicting field", "type": "string" }, "originalValue": { "description": "Value captured in the draft task snapshot", "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "taskToReplaceCurrent": { "$ref": "#/components/schemas/DraftTask" }, "taskToReplaceDraft": { "$ref": "#/components/schemas/DraftTask" }, "taskToReplaceOriginal": { "$ref": "#/components/schemas/DraftTask" }, "type": { "$ref": "#/components/schemas/DraftConflictType" } }, "required": [ "draftTaskId", "entityId", "taskToReplaceCurrent", "type" ], "type": "object" }, "DraftConflictsList": { "items": { "$ref": "#/components/schemas/DraftConflict" }, "type": "array" }, "DraftTaskFilter": { "properties": { "active": { "description": "Tasks which have not been superseded by subsequent tasks", "type": "boolean" }, "entityId": { "type": "string" }, "type": { "oneOf": [ { "$ref": "#/components/schemas/DraftTaskType" }, { "items": { "$ref": "#/components/schemas/DraftTaskType" }, "maxItems": 30, "type": "array" } ] } }, "type": "object" }, "DraftTaskType": { "enum": [ "draft-comment-create", "draft-comment-delete", "draft-comment-reply-create", "draft-comment-reply-delete", "draft-comment-reply-update", "draft-comment-update", "draft-diagram-content-update", "draft-diagram-create", "draft-diagram-delete", "draft-diagram-group-create", "draft-diagram-group-delete", "draft-diagram-group-update", "draft-diagram-update", "draft-flow-create", "draft-flow-delete", "draft-flow-update", "draft-model-connection-create", "draft-model-connection-delete", "draft-model-connection-update", "draft-model-object-create", "draft-model-object-delete", "draft-model-object-update", "draft-tag-create", "draft-tag-delete", "draft-tag-group-create", "draft-tag-group-delete", "draft-tag-group-update", "draft-tag-update" ], "type": "string" }, "DraftTaskCommentCreateProps": { "allOf": [ { "$ref": "#/components/schemas/CommentRequired" } ] }, "DraftTaskCommentCreate": { "properties": { "entityId": { "type": "string" }, "props": { "$ref": "#/components/schemas/DraftTaskCommentCreateProps" }, "type": { "enum": [ "draft-comment-create" ], "type": "string" } }, "required": [ "entityId", "props", "type" ], "type": "object" }, "DraftTaskCommentUpdateProps": { "allOf": [ { "$ref": "#/components/schemas/CommentPartial" } ] }, "DraftTaskCommentUpdate": { "properties": { "entityId": { "type": "string" }, "props": { "$ref": "#/components/schemas/DraftTaskCommentUpdateProps" }, "snapshot": { "$ref": "#/components/schemas/DraftTaskCommentUpdateProps" }, "type": { "enum": [ "draft-comment-update" ], "type": "string" } }, "required": [ "entityId", "props", "snapshot", "type" ], "type": "object" }, "DraftTaskCommentDelete": { "properties": { "entityId": { "type": "string" }, "type": { "enum": [ "draft-comment-delete" ], "type": "string" } }, "required": [ "entityId", "type" ], "type": "object" }, "DraftTaskCommentReplyCreateProps": { "allOf": [ { "$ref": "#/components/schemas/CommentReplyRequired" } ] }, "DraftTaskCommentReplyCreate": { "properties": { "commentId": { "type": "string" }, "entityId": { "type": "string" }, "props": { "$ref": "#/components/schemas/DraftTaskCommentReplyCreateProps" }, "type": { "enum": [ "draft-comment-reply-create" ], "type": "string" } }, "required": [ "entityId", "props", "type", "commentId" ], "type": "object" }, "DraftTaskCommentReplyUpdateProps": { "allOf": [ { "$ref": "#/components/schemas/CommentReplyPartial" } ] }, "DraftTaskCommentReplyUpdate": { "properties": { "commentId": { "type": "string" }, "entityId": { "type": "string" }, "props": { "$ref": "#/components/schemas/DraftTaskCommentReplyUpdateProps" }, "snapshot": { "$ref": "#/components/schemas/DraftTaskCommentReplyUpdateProps" }, "type": { "enum": [ "draft-comment-reply-update" ], "type": "string" } }, "required": [ "entityId", "props", "snapshot", "type", "commentId" ], "type": "object" }, "DraftTaskCommentReplyDelete": { "properties": { "commentId": { "type": "string" }, "entityId": { "type": "string" }, "type": { "enum": [ "draft-comment-reply-delete" ], "type": "string" } }, "required": [ "entityId", "type", "commentId" ], "type": "object" }, "DraftTaskDiagramCreateProps": { "allOf": [ { "$ref": "#/components/schemas/DiagramRequired" }, { "$ref": "#/components/schemas/DiagramContentRequired" } ] }, "DraftTaskDiagramCreate": { "properties": { "entityId": { "type": "string" }, "props": { "$ref": "#/components/schemas/DraftTaskDiagramCreateProps" }, "type": { "enum": [ "draft-diagram-create" ], "type": "string" } }, "required": [ "entityId", "props", "type" ], "type": "object" }, "DraftTaskDiagramUpdateProps": { "allOf": [ { "$ref": "#/components/schemas/DiagramPartial" }, { "$ref": "#/components/schemas/DiagramContentPartial" } ] }, "DraftTaskDiagramUpdate": { "properties": { "entityId": { "type": "string" }, "props": { "$ref": "#/components/schemas/DraftTaskDiagramUpdateProps" }, "snapshot": { "$ref": "#/components/schemas/DraftTaskDiagramUpdateProps" }, "type": { "enum": [ "draft-diagram-update" ], "type": "string" } }, "required": [ "entityId", "props", "snapshot", "type" ], "type": "object" }, "DraftTaskDiagramDelete": { "properties": { "entityId": { "type": "string" }, "type": { "enum": [ "draft-diagram-delete" ], "type": "string" } }, "required": [ "entityId", "type" ], "type": "object" }, "DraftTaskDiagramContentUpdateProps": { "allOf": [ { "$ref": "#/components/schemas/DiagramContentPartial" } ] }, "DraftTaskDiagramContentUpdate": { "properties": { "entityId": { "type": "string" }, "props": { "$ref": "#/components/schemas/DraftTaskDiagramContentUpdateProps" }, "snapshot": { "$ref": "#/components/schemas/DraftTaskDiagramContentUpdateProps" }, "type": { "enum": [ "draft-diagram-content-update" ], "type": "string" } }, "required": [ "entityId", "props", "snapshot", "type" ], "type": "object" }, "DraftTaskDiagramGroupCreateProps": { "allOf": [ { "$ref": "#/components/schemas/DiagramGroupRequired" } ] }, "DraftTaskDiagramGroupCreate": { "properties": { "entityId": { "type": "string" }, "props": { "$ref": "#/components/schemas/DraftTaskDiagramGroupCreateProps" }, "type": { "enum": [ "draft-diagram-group-create" ], "type": "string" } }, "required": [ "entityId", "props", "type" ], "type": "object" }, "DraftTaskDiagramGroupUpdateProps": { "allOf": [ { "$ref": "#/components/schemas/DiagramGroupPartial" } ] }, "DraftTaskDiagramGroupUpdate": { "properties": { "entityId": { "type": "string" }, "props": { "$ref": "#/components/schemas/DraftTaskDiagramGroupUpdateProps" }, "snapshot": { "$ref": "#/components/schemas/DraftTaskDiagramGroupUpdateProps" }, "type": { "enum": [ "draft-diagram-group-update" ], "type": "string" } }, "required": [ "entityId", "props", "snapshot", "type" ], "type": "object" }, "DraftTaskDiagramGroupDelete": { "properties": { "entityId": { "type": "string" }, "type": { "enum": [ "draft-diagram-group-delete" ], "type": "string" } }, "required": [ "entityId", "type" ], "type": "object" }, "DraftTaskModelObjectCreateProps": { "allOf": [ { "$ref": "#/components/schemas/ModelObjectRequired" } ] }, "DraftTaskModelObjectCreate": { "properties": { "entityId": { "type": "string" }, "props": { "$ref": "#/components/schemas/DraftTaskModelObjectCreateProps" }, "type": { "enum": [ "draft-model-object-create" ], "type": "string" } }, "required": [ "entityId", "props", "type" ], "type": "object" }, "DraftTaskModelObjectUpdateProps": { "allOf": [ { "$ref": "#/components/schemas/ModelObjectPartial" } ] }, "DraftTaskModelObjectUpdate": { "properties": { "entityId": { "type": "string" }, "props": { "$ref": "#/components/schemas/DraftTaskModelObjectUpdateProps" }, "snapshot": { "$ref": "#/components/schemas/DraftTaskModelObjectUpdateProps" }, "type": { "enum": [ "draft-model-object-update" ], "type": "string" } }, "required": [ "entityId", "props", "snapshot", "type" ], "type": "object" }, "DraftTaskModelObjectDelete": { "properties": { "entityId": { "type": "string" }, "type": { "enum": [ "draft-model-object-delete" ], "type": "string" } }, "required": [ "entityId", "type" ], "type": "object" }, "DraftTaskModelConnectionCreateProps": { "allOf": [ { "$ref": "#/components/schemas/ModelConnectionRequired" } ] }, "DraftTaskModelConnectionCreate": { "properties": { "entityId": { "type": "string" }, "props": { "$ref": "#/components/schemas/DraftTaskModelConnectionCreateProps" }, "type": { "enum": [ "draft-model-connection-create" ], "type": "string" } }, "required": [ "entityId", "props", "type" ], "type": "object" }, "DraftTaskModelConnectionUpdateProps": { "allOf": [ { "$ref": "#/components/schemas/ModelConnectionPartial" } ] }, "DraftTaskModelConnectionUpdate": { "properties": { "entityId": { "type": "string" }, "props": { "$ref": "#/components/schemas/DraftTaskModelConnectionUpdateProps" }, "snapshot": { "$ref": "#/components/schemas/DraftTaskModelConnectionUpdateProps" }, "type": { "enum": [ "draft-model-connection-update" ], "type": "string" } }, "required": [ "entityId", "props", "snapshot", "type" ], "type": "object" }, "DraftTaskModelConnectionDelete": { "properties": { "entityId": { "type": "string" }, "type": { "enum": [ "draft-model-connection-delete" ], "type": "string" } }, "required": [ "entityId", "type" ], "type": "object" }, "DraftTaskFlowCreateProps": { "allOf": [ { "$ref": "#/components/schemas/FlowRequired" } ] }, "DraftTaskFlowCreate": { "properties": { "entityId": { "type": "string" }, "props": { "$ref": "#/components/schemas/DraftTaskFlowCreateProps" }, "type": { "enum": [ "draft-flow-create" ], "type": "string" } }, "required": [ "entityId", "props", "type" ], "type": "object" }, "DraftTaskFlowUpdateProps": { "allOf": [ { "$ref": "#/components/schemas/FlowPartial" } ] }, "DraftTaskFlowUpdate": { "properties": { "entityId": { "type": "string" }, "props": { "$ref": "#/components/schemas/DraftTaskFlowUpdateProps" }, "snapshot": { "$ref": "#/components/schemas/DraftTaskFlowUpdateProps" }, "type": { "enum": [ "draft-flow-update" ], "type": "string" } }, "required": [ "entityId", "props", "snapshot", "type" ], "type": "object" }, "DraftTaskFlowDelete": { "properties": { "entityId": { "type": "string" }, "type": { "enum": [ "draft-flow-delete" ], "type": "string" } }, "required": [ "entityId", "type" ], "type": "object" }, "DraftTaskTagCreateProps": { "allOf": [ { "$ref": "#/components/schemas/TagRequired" } ] }, "DraftTaskTagCreate": { "properties": { "entityId": { "type": "string" }, "props": { "$ref": "#/components/schemas/DraftTaskTagCreateProps" }, "type": { "enum": [ "draft-tag-create" ], "type": "string" } }, "required": [ "entityId", "props", "type" ], "type": "object" }, "DraftTaskTagUpdateProps": { "allOf": [ { "$ref": "#/components/schemas/TagPartial" } ] }, "DraftTaskTagUpdate": { "properties": { "entityId": { "type": "string" }, "props": { "$ref": "#/components/schemas/DraftTaskTagUpdateProps" }, "snapshot": { "$ref": "#/components/schemas/DraftTaskTagUpdateProps" }, "type": { "enum": [ "draft-tag-update" ], "type": "string" } }, "required": [ "entityId", "props", "snapshot", "type" ], "type": "object" }, "DraftTaskTagDelete": { "properties": { "entityId": { "type": "string" }, "type": { "enum": [ "draft-tag-delete" ], "type": "string" } }, "required": [ "entityId", "type" ], "type": "object" }, "DraftTaskTagGroupCreateProps": { "allOf": [ { "$ref": "#/components/schemas/TagGroupRequired" } ] }, "DraftTaskTagGroupCreate": { "properties": { "entityId": { "type": "string" }, "props": { "$ref": "#/components/schemas/DraftTaskTagGroupCreateProps" }, "type": { "enum": [ "draft-tag-group-create" ], "type": "string" } }, "required": [ "entityId", "props", "type" ], "type": "object" }, "DraftTaskTagGroupUpdateProps": { "allOf": [ { "$ref": "#/components/schemas/TagGroupPartial" } ] }, "DraftTaskTagGroupUpdate": { "properties": { "entityId": { "type": "string" }, "props": { "$ref": "#/components/schemas/DraftTaskTagGroupUpdateProps" }, "snapshot": { "$ref": "#/components/schemas/DraftTaskTagGroupUpdateProps" }, "type": { "enum": [ "draft-tag-group-update" ], "type": "string" } }, "required": [ "entityId", "props", "snapshot", "type" ], "type": "object" }, "DraftTaskTagGroupDelete": { "properties": { "entityId": { "type": "string" }, "type": { "enum": [ "draft-tag-group-delete" ], "type": "string" } }, "required": [ "entityId", "type" ], "type": "object" }, "DraftTaskProps": { "oneOf": [ { "$ref": "#/components/schemas/DraftTaskCommentCreateProps" }, { "$ref": "#/components/schemas/DraftTaskCommentUpdateProps" }, { "$ref": "#/components/schemas/DraftTaskCommentReplyCreateProps" }, { "$ref": "#/components/schemas/DraftTaskCommentReplyUpdateProps" }, { "$ref": "#/components/schemas/DraftTaskDiagramCreateProps" }, { "$ref": "#/components/schemas/DraftTaskDiagramUpdateProps" }, { "$ref": "#/components/schemas/DraftTaskDiagramContentUpdateProps" }, { "$ref": "#/components/schemas/DraftTaskDiagramGroupCreateProps" }, { "$ref": "#/components/schemas/DraftTaskDiagramGroupUpdateProps" }, { "$ref": "#/components/schemas/DraftTaskModelObjectCreateProps" }, { "$ref": "#/components/schemas/DraftTaskModelObjectUpdateProps" }, { "$ref": "#/components/schemas/DraftTaskModelConnectionCreateProps" }, { "$ref": "#/components/schemas/DraftTaskModelConnectionUpdateProps" }, { "$ref": "#/components/schemas/DraftTaskFlowCreateProps" }, { "$ref": "#/components/schemas/DraftTaskFlowUpdateProps" }, { "$ref": "#/components/schemas/DraftTaskTagCreateProps" }, { "$ref": "#/components/schemas/DraftTaskTagUpdateProps" }, { "$ref": "#/components/schemas/DraftTaskTagGroupCreateProps" }, { "$ref": "#/components/schemas/DraftTaskTagGroupUpdateProps" } ] }, "DraftTask": { "oneOf": [ { "$ref": "#/components/schemas/DraftTaskCommentCreate" }, { "$ref": "#/components/schemas/DraftTaskCommentUpdate" }, { "$ref": "#/components/schemas/DraftTaskCommentDelete" }, { "$ref": "#/components/schemas/DraftTaskCommentReplyCreate" }, { "$ref": "#/components/schemas/DraftTaskCommentReplyUpdate" }, { "$ref": "#/components/schemas/DraftTaskCommentReplyDelete" }, { "$ref": "#/components/schemas/DraftTaskDiagramCreate" }, { "$ref": "#/components/schemas/DraftTaskDiagramUpdate" }, { "$ref": "#/components/schemas/DraftTaskDiagramDelete" }, { "$ref": "#/components/schemas/DraftTaskDiagramContentUpdate" }, { "$ref": "#/components/schemas/DraftTaskDiagramGroupCreate" }, { "$ref": "#/components/schemas/DraftTaskDiagramGroupUpdate" }, { "$ref": "#/components/schemas/DraftTaskDiagramGroupDelete" }, { "$ref": "#/components/schemas/DraftTaskModelObjectCreate" }, { "$ref": "#/components/schemas/DraftTaskModelObjectUpdate" }, { "$ref": "#/components/schemas/DraftTaskModelObjectDelete" }, { "$ref": "#/components/schemas/DraftTaskModelConnectionCreate" }, { "$ref": "#/components/schemas/DraftTaskModelConnectionUpdate" }, { "$ref": "#/components/schemas/DraftTaskModelConnectionDelete" }, { "$ref": "#/components/schemas/DraftTaskFlowCreate" }, { "$ref": "#/components/schemas/DraftTaskFlowUpdate" }, { "$ref": "#/components/schemas/DraftTaskFlowDelete" }, { "$ref": "#/components/schemas/DraftTaskTagCreate" }, { "$ref": "#/components/schemas/DraftTaskTagUpdate" }, { "$ref": "#/components/schemas/DraftTaskTagDelete" }, { "$ref": "#/components/schemas/DraftTaskTagGroupCreate" }, { "$ref": "#/components/schemas/DraftTaskTagGroupUpdate" }, { "$ref": "#/components/schemas/DraftTaskTagGroupDelete" } ] }, "DraftTaskList": { "items": { "$ref": "#/components/schemas/DraftTask" }, "type": "array" }, "DraftTaskRequired": { "properties": { "commit": { "type": "number" }, "task": { "$ref": "#/components/schemas/DraftTask" } }, "required": [ "task" ], "type": "object" }, "DraftTaskJson": { "properties": { "commit": { "type": "number" }, "task": { "$ref": "#/components/schemas/DraftTask" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "draftId": { "type": "string" }, "id": { "type": "string" }, "landscapeId": { "type": "string" }, "latestEntityId": { "type": "string" }, "versionId": { "type": "string" } }, "required": [ "task", "commit", "createdAt", "createdBy", "createdById", "draftId", "id", "landscapeId", "versionId" ], "type": "object" }, "ExperimentStage": { "enum": [ "concept", "alpha", "beta" ], "type": "string" }, "Experiment": { "properties": { "description": { "type": "string" }, "docsUrl": { "format": "uri", "type": "string" }, "flagKey": { "type": "string" }, "id": { "type": "string" }, "internal": { "type": "boolean" }, "name": { "type": "string" }, "stage": { "$ref": "#/components/schemas/ExperimentStage" } }, "required": [ "flagKey", "id", "name", "stage" ], "type": "object" }, "FlowFilter": { "properties": { "diagramId": { "type": "string" }, "handleId": { "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "maxItems": 30, "type": "array" } ] }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "name": { "type": "string" }, "pinned": { "type": "boolean" } }, "type": "object" }, "FlowThumbnail": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "diagramId": { "description": "diagram id this flow belongs to", "type": "string" }, "expires": { "format": "date-time", "type": "string" }, "handleId": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "url": { "format": "uri", "type": "string" } }, "required": [ "createdAt", "diagramId", "expires", "handleId", "id", "name", "updatedAt", "url" ], "type": "object" }, "FlowPartial": { "properties": { "commit": { "type": "number" }, "index": { "type": "number" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "name": { "maxLength": 4000, "type": "string" }, "pinned": { "type": "boolean" }, "pinnedAt": { "format": "date-time", "type": "string" }, "pinnedIndex": { "type": "number" }, "showAllSteps": { "type": "boolean" }, "showConnectionNames": { "type": "boolean" }, "steps": { "properties": { "$add": { "additionalProperties": { "$ref": "#/components/schemas/FlowStep" }, "type": "object" }, "$remove": { "items": { "type": "string" }, "type": "array" }, "$replace": { "additionalProperties": { "$ref": "#/components/schemas/FlowStep" }, "type": "object" }, "$update": { "additionalProperties": { "$ref": "#/components/schemas/FlowStepPartial" }, "type": "object" } }, "type": "object" } }, "type": "object" }, "FlowRequired": { "properties": { "commit": { "type": "number" }, "index": { "type": "number" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "name": { "maxLength": 4000, "type": "string" }, "pinned": { "type": "boolean" }, "pinnedAt": { "format": "date-time", "type": "string" }, "pinnedIndex": { "type": "number" }, "showAllSteps": { "type": "boolean" }, "showConnectionNames": { "type": "boolean" }, "steps": { "additionalProperties": { "$ref": "#/components/schemas/FlowStep" }, "type": "object" }, "diagramId": { "type": "string" }, "handleId": { "type": "string" } }, "required": [ "diagramId", "name" ], "type": "object" }, "Flow": { "properties": { "commit": { "type": "number" }, "index": { "type": "number" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "name": { "maxLength": 4000, "type": "string" }, "pinned": { "type": "boolean" }, "pinnedAt": { "format": "date-time", "type": "string" }, "pinnedIndex": { "type": "number" }, "showAllSteps": { "type": "boolean" }, "showConnectionNames": { "type": "boolean" }, "steps": { "additionalProperties": { "$ref": "#/components/schemas/FlowStep" }, "type": "object" }, "diagramId": { "type": "string" }, "handleId": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "deletedAt": { "format": "date-time", "type": "string" }, "deletedBy": { "$ref": "#/components/schemas/AuthType" }, "deletedById": { "type": "string" }, "id": { "type": "string" }, "landscapeId": { "type": "string" }, "latestEntityId": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/AuthType" }, "updatedById": { "type": "string" }, "version": { "type": "number" }, "versionId": { "type": "string" }, "viewedAt": { "format": "date-time", "type": "string" }, "viewedBy": { "$ref": "#/components/schemas/AuthType" }, "viewedById": { "type": "string" } }, "required": [ "diagramId", "name", "commit", "createdAt", "createdBy", "createdById", "handleId", "id", "index", "labels", "landscapeId", "pinned", "showAllSteps", "showConnectionNames", "steps", "updatedAt", "updatedBy", "updatedById", "version", "versionId" ], "type": "object" }, "FlowStepType": { "description": "Enum representing the types of flow steps", "enum": [ "alternate-path", "subflow", "outgoing", "parallel-path", "reply", "self-action", "introduction", "information", "conclusion" ], "type": "string" }, "FlowStepPath": { "properties": { "id": { "type": "string" }, "index": { "type": "number" }, "name": { "type": "string" } }, "required": [ "id", "index", "name" ], "type": "object" }, "FlowStepPaths": { "additionalProperties": { "$ref": "#/components/schemas/FlowStepPath" }, "type": "object" }, "FlowStepPathsNullable": { "oneOf": [ { "$ref": "#/components/schemas/FlowStepPaths" }, { "type": "null" } ] }, "FlowStepPartial": { "properties": { "description": { "description": "Descriptive name for the flow step", "maxLength": 20000, "type": "string" }, "detailedDescription": { "description": "Long description for the flow step", "maxLength": 20000, "type": "string" }, "flowId": { "nullable": true, "type": "string" }, "id": { "type": "string" }, "index": { "type": "number" }, "originId": { "nullable": true, "type": "string" }, "parentId": { "nullable": true, "type": "string" }, "paths": { "$ref": "#/components/schemas/FlowStepPathsNullable" }, "targetId": { "nullable": true, "type": "string" }, "type": { "description": "Type of flow step - deprecated values: reply", "enum": [ "alternate-path", "subflow", "outgoing", "parallel-path", "reply", "self-action", "introduction", "information", "conclusion", null ], "nullable": true, "type": "string" }, "viaId": { "nullable": true, "type": "string" } }, "type": "object" }, "FlowStep": { "properties": { "description": { "description": "Descriptive name for the flow step", "maxLength": 20000, "type": "string" }, "detailedDescription": { "description": "Long description for the flow step", "maxLength": 20000, "type": "string" }, "flowId": { "nullable": true, "type": "string" }, "id": { "type": "string" }, "index": { "type": "number" }, "originId": { "nullable": true, "type": "string" }, "parentId": { "nullable": true, "type": "string" }, "paths": { "$ref": "#/components/schemas/FlowStepPathsNullable" }, "targetId": { "nullable": true, "type": "string" }, "type": { "description": "Type of flow step - deprecated values: reply", "enum": [ "alternate-path", "subflow", "outgoing", "parallel-path", "reply", "self-action", "introduction", "information", "conclusion", null ], "nullable": true, "type": "string" }, "viaId": { "nullable": true, "type": "string" } }, "required": [ "description", "id", "index", "originId", "parentId", "paths", "flowId", "targetId", "type", "viaId" ], "type": "object" }, "GithubInstallType": { "enum": [ "bot", "user", "organization" ], "type": "string" }, "GithubInstall": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "githubId": { "type": "number" }, "id": { "type": "string" }, "organizationId": { "type": "string" }, "ownerId": { "type": "number" }, "ownerLogin": { "type": "string" }, "ownerType": { "$ref": "#/components/schemas/GithubInstallType" }, "senderId": { "type": "number" }, "senderLogin": { "type": "string" }, "senderType": { "$ref": "#/components/schemas/GithubInstallType" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "createdAt", "createdBy", "createdById", "githubId", "id", "organizationId", "ownerId", "ownerLogin", "ownerType", "senderId", "senderLogin", "senderType", "updatedAt" ], "type": "object" }, "GitlabAuthorizationPartial": { "properties": { "groupId": { "type": "number" } }, "type": "object" }, "GitlabAuthorization": { "properties": { "groupId": { "type": "number" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "groupName": { "type": "string" }, "id": { "type": "string" }, "organizationId": { "type": "string" }, "senderId": { "type": "number" }, "senderUsername": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/AuthType" }, "updatedById": { "type": "string" } }, "required": [ "createdAt", "createdBy", "createdById", "id", "organizationId", "senderId", "senderUsername", "updatedAt", "updatedBy", "updatedById" ], "type": "object" }, "LandscapePartial": { "properties": { "name": { "maxLength": 4000, "type": "string" }, "organizationId": { "type": "string" }, "scheduledVersions": { "type": "boolean" } }, "type": "object" }, "LandscapeRequired": { "properties": { "name": { "maxLength": 4000, "type": "string" }, "scheduledVersions": { "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "Landscape": { "properties": { "name": { "maxLength": 4000, "type": "string" }, "scheduledVersions": { "type": "boolean" }, "organizationId": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "id": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/AuthType" }, "updatedById": { "type": "string" } }, "required": [ "name", "createdAt", "createdBy", "createdById", "id", "scheduledVersions", "organizationId", "updatedAt", "updatedBy", "updatedById" ], "type": "object" }, "LandscapeNullable": { "oneOf": [ { "$ref": "#/components/schemas/Landscape" }, { "type": "null" } ] }, "LandscapeExportType": { "enum": [ "pdf", "markdown", "html", "llms", "json", "object-csv", "connection-csv" ], "type": "string" }, "LandscapeExportSchema": { "default": "v1", "description": "Schema version to use for JSON exports.\n\n`v1` (default) produces the legacy format where entities are keyed objects.\n\n`v2` produces the same structure as the `LandscapeImportData` used by the import endpoint, so an export can be imported directly.", "enum": [ "v1", "v2" ], "type": "string" }, "LandscapeExportOrientation": { "enum": [ "portrait", "landscape" ], "type": "string" }, "LandscapeExportFilter": { "properties": { "diagramId": { "type": "string" }, "flowId": { "type": "string" }, "includeDiagrams": { "description": "Whether or not to include diagrams in PDF exports, defaults to true", "type": "boolean" }, "includeFlows": { "description": "Whether or not to include flows in PDF exports, defaults to true", "type": "boolean" }, "modelObjectId": { "type": "string" } }, "type": "object" }, "LandscapeExportOptions": { "properties": { "draftId": { "description": "Fetch and apply draft tasks before producing the export", "type": "string" }, "orientation": { "$ref": "#/components/schemas/LandscapeExportOrientation", "default": "portrait", "description": "Orientation to use when exporting to PDF" }, "schema": { "$ref": "#/components/schemas/LandscapeExportSchema", "default": "v1", "description": "Schema version to use for JSON exports" } }, "type": "object" }, "LandscapeExport": { "properties": { "completedAt": { "format": "date-time", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "deleteAt": { "format": "date-time", "type": "string" }, "error": { "nullable": true, "type": "string" }, "fileUrl": { "format": "uri", "nullable": true, "type": "string" }, "filter": { "$ref": "#/components/schemas/LandscapeExportFilter" }, "id": { "type": "string" }, "landscapeId": { "type": "string" }, "options": { "$ref": "#/components/schemas/LandscapeExportOptions" }, "type": { "$ref": "#/components/schemas/LandscapeExportType" }, "versionId": { "type": "string" } }, "required": [ "createdAt", "deleteAt", "error", "fileUrl", "id", "landscapeId", "type", "versionId" ], "type": "object" }, "LandscapeImportStatus": { "enum": [ "in-progress", "completed", "error" ], "type": "string" }, "LandscapeImportError": { "properties": { "code": { "type": "string" }, "entityId": { "description": "The id of the entity where the error occurred", "type": "string" }, "entityOriginalId": { "description": "The not using the standard id format, this will be the original import identifier", "type": "string" }, "entityType": { "$ref": "#/components/schemas/ImportEntityType" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" }, "LandscapeImport": { "properties": { "completedAt": { "format": "date-time", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "deleteAt": { "format": "date-time", "type": "string" }, "errors": { "items": { "$ref": "#/components/schemas/LandscapeImportError" }, "type": "array" }, "id": { "type": "string" }, "landscapeId": { "type": "string" }, "prune": { "description": "When enabled, entities that are missing from the import will be deleted.", "type": "boolean" }, "status": { "$ref": "#/components/schemas/LandscapeImportStatus" }, "versionId": { "type": "string" } }, "required": [ "createdAt", "createdById", "createdBy", "deleteAt", "status", "id", "landscapeId", "versionId" ], "type": "object" }, "LandscapeTemplatePartial": { "properties": { "caption": { "maxLength": 50000, "type": "string" }, "imageUrl": { "format": "uri", "type": "string" }, "landscapeId": { "type": "string" }, "name": { "maxLength": 4000, "type": "string" } }, "type": "object" }, "LandscapeTemplateRequired": { "properties": { "caption": { "maxLength": 50000, "type": "string" }, "imageUrl": { "format": "uri", "type": "string" }, "landscapeId": { "type": "string" }, "name": { "maxLength": 4000, "type": "string" } }, "required": [ "caption", "imageUrl", "landscapeId", "name" ], "type": "object" }, "LandscapeTemplate": { "properties": { "caption": { "maxLength": 50000, "type": "string" }, "imageUrl": { "format": "uri", "type": "string" }, "landscapeId": { "type": "string" }, "name": { "maxLength": 4000, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "caption", "imageUrl", "landscapeId", "name", "createdAt", "id", "updatedAt" ], "type": "object" }, "ModelConnectionFilter": { "properties": { "direction": { "$ref": "#/components/schemas/ModelConnectionDirection" }, "handleId": { "oneOf": [ { "type": "string" }, { "description": "Filter any connections with this handle id", "items": { "type": "string" }, "maxItems": 30, "type": "array" } ] }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "linked": { "type": "boolean" }, "name": { "type": "string" }, "originId": { "oneOf": [ { "type": "string" }, { "description": "Filter any connections with this origin id", "items": { "type": "string" }, "maxItems": 30, "type": "array" } ] }, "status": { "oneOf": [ { "$ref": "#/components/schemas/ModelConnectionStatus" }, { "description": "Filter any connections with this status", "items": { "$ref": "#/components/schemas/ModelConnectionStatus" }, "maxItems": 30, "type": "array" } ] }, "tagIds": { "oneOf": [ { "type": "string" }, { "description": "Filter any connections with this tag id", "items": { "type": "string" }, "maxItems": 30, "type": "array" } ] }, "targetId": { "oneOf": [ { "type": "string" }, { "description": "Filter any connections with this target id", "items": { "type": "string" }, "maxItems": 30, "type": "array" } ] }, "technologyIds": { "oneOf": [ { "type": "string" }, { "description": "Filter any with this technology id", "items": { "type": "string" }, "maxItems": 30, "type": "array" } ] }, "viaId": { "oneOf": [ { "type": "string" }, { "description": "Filter any connections with this via id", "items": { "type": "string" }, "maxItems": 30, "type": "array" } ] } }, "type": "object" }, "ModelConnectionDirection": { "enum": [ "outgoing", "bidirectional" ], "type": "string" }, "ModelConnectionDirectionNullable": { "oneOf": [ { "$ref": "#/components/schemas/ModelConnectionDirection" }, { "type": "null" } ] }, "ModelConnectionStatus": { "enum": [ "deprecated", "future", "live", "removed" ], "type": "string" }, "ModelConnectionDiagram": { "properties": { "connectionId": { "type": "string" }, "id": { "type": "string" }, "originModelId": { "type": "string" }, "targetModelId": { "type": "string" } }, "required": [ "connectionId", "id", "originModelId", "targetModelId" ], "type": "object" }, "ModelConnectionFlow": { "properties": { "id": { "type": "string" }, "stepId": { "type": "string" } }, "required": [ "id", "stepId" ], "type": "object" }, "ModelConnectionPartial": { "properties": { "commit": { "type": "number" }, "description": { "maxLength": 950000, "type": "string" }, "direction": { "$ref": "#/components/schemas/ModelConnectionDirectionNullable" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "links": { "properties": { "$add": { "additionalProperties": { "$ref": "#/components/schemas/RealityLinkRequired" }, "type": "object" }, "$remove": { "items": { "type": "string" }, "type": "array" }, "$replace": { "additionalProperties": { "$ref": "#/components/schemas/RealityLinkRequired" }, "type": "object" }, "$update": { "additionalProperties": { "$ref": "#/components/schemas/RealityLinkPartial" }, "type": "object" } }, "type": "object" }, "name": { "maxLength": 4000, "type": "string" }, "originId": { "description": "Model object that initiates the connection", "type": "string" }, "status": { "$ref": "#/components/schemas/ModelConnectionStatus" }, "tagIds": { "oneOf": [ { "description": "Tag IDs assigned to this model", "items": { "type": "string" }, "type": "array" }, { "description": "Update individual tag IDs", "properties": { "$add": { "description": "Append tag IDs to the list", "items": { "type": "string" }, "type": "array" }, "$remove": { "description": "Remove tag IDs from the list", "items": { "type": "string" }, "type": "array" } }, "type": "object" } ] }, "targetId": { "description": "Model object that receives the message", "type": "string" }, "technologyIds": { "oneOf": [ { "description": "Technology IDs assigned to this model", "items": { "type": "string" }, "type": "array" }, { "description": "Update individual technology IDs", "properties": { "$add": { "description": "Append technology IDs to the list", "items": { "type": "string" }, "type": "array" }, "$remove": { "description": "Remove technology IDs from the list", "items": { "type": "string" }, "type": "array" } }, "type": "object" } ] }, "viaId": { "description": "Model object that facilitates the connection, such as a Kafka topic, or RabbitMQ queue", "nullable": true, "type": "string" } }, "type": "object" }, "ModelConnectionRequired": { "properties": { "commit": { "type": "number" }, "description": { "maxLength": 950000, "type": "string" }, "direction": { "$ref": "#/components/schemas/ModelConnectionDirectionNullable" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "links": { "additionalProperties": { "$ref": "#/components/schemas/RealityLinkRequired" }, "type": "object" }, "name": { "maxLength": 4000, "type": "string" }, "originId": { "description": "Model object that initiates the connection", "type": "string" }, "status": { "$ref": "#/components/schemas/ModelConnectionStatus" }, "tagIds": { "description": "Tag IDs assigned to this model", "items": { "type": "string" }, "type": "array" }, "targetId": { "description": "Model object that receives the message", "type": "string" }, "technologyIds": { "description": "Technology IDs assigned to this model", "items": { "type": "string" }, "type": "array" }, "viaId": { "description": "Model object that facilitates the connection, such as a Kafka topic, or RabbitMQ queue", "nullable": true, "type": "string" }, "handleId": { "type": "string" } }, "required": [ "direction", "name", "originId", "targetId" ], "type": "object" }, "ModelConnectionUpsert": { "allOf": [ { "$ref": "#/components/schemas/ModelConnectionRequired" }, { "$ref": "#/components/schemas/ModelConnectionPartial" } ] }, "ModelConnection": { "properties": { "commit": { "type": "number" }, "description": { "maxLength": 950000, "type": "string" }, "direction": { "$ref": "#/components/schemas/ModelConnectionDirectionNullable" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "links": { "additionalProperties": { "$ref": "#/components/schemas/RealityLink" }, "type": "object" }, "name": { "maxLength": 4000, "type": "string" }, "originId": { "description": "Model object that initiates the connection", "type": "string" }, "status": { "$ref": "#/components/schemas/ModelConnectionStatus" }, "tagIds": { "description": "Tag IDs assigned to this model", "items": { "type": "string" }, "type": "array" }, "targetId": { "description": "Model object that receives the message", "type": "string" }, "technologyIds": { "description": "Technology IDs assigned to this model", "items": { "type": "string" }, "type": "array" }, "viaId": { "description": "Model object that facilitates the connection, such as a Kafka topic, or RabbitMQ queue", "nullable": true, "type": "string" }, "handleId": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "deletedAt": { "format": "date-time", "type": "string" }, "deletedBy": { "$ref": "#/components/schemas/AuthType" }, "deletedById": { "type": "string" }, "diagrams": { "additionalProperties": { "$ref": "#/components/schemas/ModelConnectionDiagram" }, "type": "object" }, "flows": { "additionalProperties": { "$ref": "#/components/schemas/ModelConnectionFlow" }, "type": "object" }, "id": { "type": "string" }, "landscapeId": { "type": "string" }, "latestEntityId": { "type": "string" }, "linked": { "type": "boolean" }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/AuthType" }, "updatedById": { "type": "string" }, "version": { "type": "number" }, "versionId": { "type": "string" } }, "required": [ "direction", "name", "originId", "targetId", "commit", "createdAt", "createdBy", "createdById", "diagrams", "flows", "handleId", "id", "labels", "landscapeId", "links", "linked", "status", "tagIds", "technologyIds", "updatedAt", "updatedBy", "updatedById", "version", "versionId", "viaId" ], "type": "object" }, "ModelConnectionExpandKey": { "enum": [ "technologies", "tags" ], "type": "string" }, "ModelConnectionExpanded": { "allOf": [ { "$ref": "#/components/schemas/ModelConnection" }, { "properties": { "tags": { "additionalProperties": { "$ref": "#/components/schemas/TagExport" }, "type": "object" }, "technologies": { "additionalProperties": { "$ref": "#/components/schemas/TechnologyExport" }, "type": "object" } }, "type": "object" } ] }, "ModelDependenciesFilter": { "properties": { "objectIds": { "description": "Array of model object IDs to return dependency data for. Non-existent IDs are silently ignored.", "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "objectLabels": { "additionalProperties": { "type": "string" }, "description": "Key-value label pairs used to select objects. Objects matching any of the provided pairs are returned (OR semantics).", "type": "object" }, "tagIds": { "description": "Filter dependency objects to those matching any of the given tag IDs.", "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "technologyIds": { "description": "Filter dependency objects to those matching any of the given technology IDs.", "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] } }, "type": "object" }, "ModelObjectFilter": { "properties": { "domainId": { "oneOf": [ { "type": "string" }, { "description": "Filter any objects with this domain id", "items": { "type": "string" }, "maxItems": 30, "type": "array" } ] }, "external": { "type": "boolean" }, "groupIds": { "oneOf": [ { "type": "string" }, { "description": "Filter any objects with this group id", "items": { "type": "string" }, "maxItems": 30, "type": "array" } ] }, "handleId": { "oneOf": [ { "type": "string" }, { "description": "Filter any objects with this handle id", "items": { "type": "string" }, "maxItems": 30, "type": "array" } ] }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "linked": { "type": "boolean" }, "name": { "type": "string" }, "parentId": { "description": "Filter objects with this parent id", "nullable": true, "type": "string" }, "parentIds": { "description": "Filter objects or child objects with this parent id", "type": "string" }, "status": { "oneOf": [ { "$ref": "#/components/schemas/ModelObjectStatus" }, { "description": "Filter any objects with this status", "items": { "$ref": "#/components/schemas/ModelObjectStatus" }, "maxItems": 30, "type": "array" } ] }, "tagIds": { "oneOf": [ { "type": "string" }, { "description": "Filter any objects with this technology id", "items": { "type": "string" }, "maxItems": 30, "type": "array" } ] }, "teamIds": { "oneOf": [ { "type": "string" }, { "description": "Filter any objects with this team id", "items": { "type": "string" }, "maxItems": 30, "type": "array" } ] }, "technologyIds": { "oneOf": [ { "type": "string" }, { "description": "Filter any objects with this technology id", "items": { "type": "string" }, "maxItems": 30, "type": "array" } ] }, "type": { "oneOf": [ { "$ref": "#/components/schemas/ModelObjectType" }, { "description": "Filter any objects with this type", "items": { "$ref": "#/components/schemas/ModelObjectType" }, "maxItems": 30, "type": "array" } ] } }, "type": "object" }, "ModelObjectType": { "enum": [ "actor", "app", "component", "group", "root", "store", "system" ], "type": "string" }, "ModelObjectStatus": { "enum": [ "deprecated", "future", "live", "removed" ], "type": "string" }, "ModelObjectIcon": { "properties": { "catalogTechnologyId": { "type": "string" }, "name": { "type": "string" }, "url": { "deprecated": true, "description": "Use either urlDark or urlLight", "type": "string" }, "urlDark": { "description": "Icon that only works on dark backgrounds", "example": [ "/organizations/{organizationId}/dark/{catalogTechnologyId}.png", "/dark/{catalogTechnologyId}.png" ], "type": "string" }, "urlLight": { "description": "Icon that only works on light backgrounds", "example": [ "/organizations/{organizationId}/light/{catalogTechnologyId}.png", "/light/{catalogTechnologyId}.png" ], "type": "string" } }, "required": [ "catalogTechnologyId", "name" ], "type": "object" }, "ModelObjectIconNullable": { "oneOf": [ { "$ref": "#/components/schemas/ModelObjectIcon" }, { "type": "null" } ] }, "ModelObjectDiagram": { "properties": { "id": { "type": "string" }, "objectId": { "type": "string" } }, "required": [ "id", "objectId" ], "type": "object" }, "ModelObjectFlow": { "properties": { "id": { "type": "string" }, "stepId": { "type": "string" } }, "required": [ "id", "stepId" ], "type": "object" }, "ModelObjectPartial": { "properties": { "caption": { "description": "Short summary of the object shown as the display description", "maxLength": 50000, "type": "string" }, "commit": { "type": "number" }, "description": { "maxLength": 950000, "type": "string" }, "external": { "type": "boolean" }, "groupIds": { "oneOf": [ { "description": "IDs of the groups this model object belongs to", "items": { "type": "string" }, "type": "array" }, { "description": "Update individual group ids", "properties": { "$add": { "description": "Append group ids to the list", "items": { "type": "string" }, "type": "array" }, "$remove": { "description": "Remove group ids from the list", "items": { "type": "string" }, "type": "array" } }, "type": "object" } ] }, "icon": { "$ref": "#/components/schemas/ModelObjectIconNullable" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "description": "Generic key value store used for creating custom integrations", "maxProperties": 50, "type": "object" }, "links": { "properties": { "$add": { "additionalProperties": { "$ref": "#/components/schemas/RealityLinkRequired" }, "type": "object" }, "$remove": { "items": { "type": "string" }, "type": "array" }, "$replace": { "additionalProperties": { "$ref": "#/components/schemas/RealityLinkRequired" }, "type": "object" }, "$update": { "additionalProperties": { "$ref": "#/components/schemas/RealityLinkPartial" }, "type": "object" } }, "type": "object" }, "name": { "maxLength": 4000, "type": "string" }, "parentId": { "description": "Parent model object ID, null for the root level model object", "nullable": true, "type": "string" }, "status": { "$ref": "#/components/schemas/ModelObjectStatus" }, "tagIds": { "oneOf": [ { "description": "Tag IDs assigned to this model", "items": { "type": "string" }, "type": "array" }, { "description": "Update individual tag ids", "properties": { "$add": { "description": "Append tag ids to the list", "items": { "type": "string" }, "type": "array" }, "$remove": { "description": "Remove tag ids from the list", "items": { "type": "string" }, "type": "array" } }, "type": "object" } ] }, "teamIds": { "oneOf": [ { "description": "Team IDs that own this model object, does not propergate up or down", "items": { "type": "string" }, "type": "array" }, { "description": "Update individual team ids", "properties": { "$add": { "description": "Append team ids to the list", "items": { "type": "string" }, "type": "array" }, "$remove": { "description": "Remove team ids from the list", "items": { "type": "string" }, "type": "array" } }, "type": "object" } ] }, "teamOnlyEditing": { "description": "Model object (+child diagram, diagram groups and flows) can only be edited by owners and admins", "type": "boolean" }, "technologyIds": { "oneOf": [ { "description": "Technology ids assigned to this model", "items": { "type": "string" }, "type": "array" }, { "description": "Update individual technology ids", "properties": { "$add": { "description": "Append technology ids to the list", "items": { "type": "string" }, "type": "array" }, "$remove": { "description": "Remove technology ids from the list", "items": { "type": "string" }, "type": "array" } }, "type": "object" } ] }, "type": { "$ref": "#/components/schemas/ModelObjectType" } }, "type": "object" }, "ModelObjectRequired": { "properties": { "caption": { "description": "Short summary of the object shown as the display description", "maxLength": 50000, "type": "string" }, "commit": { "type": "number" }, "description": { "maxLength": 950000, "type": "string" }, "external": { "type": "boolean" }, "groupIds": { "description": "IDs of the groups this model object belongs to", "items": { "type": "string" }, "type": "array" }, "icon": { "$ref": "#/components/schemas/ModelObjectIconNullable" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "description": "Generic key value store used for creating custom integrations", "maxProperties": 50, "type": "object" }, "links": { "additionalProperties": { "$ref": "#/components/schemas/RealityLinkRequired" }, "type": "object" }, "name": { "maxLength": 4000, "type": "string" }, "parentId": { "description": "Parent model object ID, null for the root level model object", "nullable": true, "type": "string" }, "status": { "$ref": "#/components/schemas/ModelObjectStatus" }, "tagIds": { "description": "Tag IDs assigned to this model", "items": { "type": "string" }, "type": "array" }, "teamIds": { "description": "Team IDs that own this model object, does not propergate up or down", "items": { "type": "string" }, "type": "array" }, "teamOnlyEditing": { "description": "Model object (+child diagram, diagram groups and flows) can only be edited by owners and admins", "type": "boolean" }, "technologyIds": { "description": "Technology IDs assigned to this model", "items": { "type": "string" }, "type": "array" }, "type": { "$ref": "#/components/schemas/ModelObjectType" }, "domainId": { "type": "string" }, "handleId": { "type": "string" } }, "required": [ "name", "parentId", "type" ], "type": "object" }, "ModelObjectUpsert": { "allOf": [ { "$ref": "#/components/schemas/ModelObjectRequired" }, { "$ref": "#/components/schemas/ModelObjectPartial" } ] }, "ModelObject": { "properties": { "caption": { "description": "Short summary of the object shown as the display description", "maxLength": 50000, "type": "string" }, "commit": { "type": "number" }, "description": { "maxLength": 950000, "type": "string" }, "external": { "type": "boolean" }, "groupIds": { "description": "IDs of the groups this model object belongs to", "items": { "type": "string" }, "type": "array" }, "icon": { "$ref": "#/components/schemas/ModelObjectIconNullable" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "description": "Generic key value store used for creating custom integrations", "maxProperties": 50, "type": "object" }, "links": { "additionalProperties": { "$ref": "#/components/schemas/RealityLink" }, "type": "object" }, "name": { "maxLength": 4000, "type": "string" }, "parentId": { "description": "Parent model object ID, null for the root level model object", "nullable": true, "type": "string" }, "status": { "$ref": "#/components/schemas/ModelObjectStatus" }, "tagIds": { "description": "Tag IDs assigned to this model", "items": { "type": "string" }, "type": "array" }, "teamIds": { "description": "Team IDs that own this model object, does not propergate up or down", "items": { "type": "string" }, "type": "array" }, "teamOnlyEditing": { "description": "Model object (+child diagram, diagram groups and flows) can only be edited by owners and admins", "type": "boolean" }, "technologyIds": { "description": "Technology IDs assigned to this model", "items": { "type": "string" }, "type": "array" }, "type": { "$ref": "#/components/schemas/ModelObjectType" }, "domainId": { "type": "string" }, "handleId": { "type": "string" }, "childDiagramIds": { "description": "Child diagram IDs", "items": { "type": "string" }, "type": "array" }, "childIds": { "description": "Child model object IDs, only one level down", "items": { "type": "string" }, "type": "array" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "deletedAt": { "format": "date-time", "type": "string" }, "deletedBy": { "$ref": "#/components/schemas/AuthType" }, "deletedById": { "type": "string" }, "diagrams": { "additionalProperties": { "$ref": "#/components/schemas/ModelObjectDiagram" }, "type": "object" }, "flows": { "additionalProperties": { "$ref": "#/components/schemas/ModelObjectFlow" }, "type": "object" }, "id": { "type": "string" }, "landscapeId": { "type": "string" }, "latestEntityId": { "type": "string" }, "linked": { "type": "boolean" }, "parentIds": { "description": "Parent model object IDs for the whole hierarchy, ending with the root model object", "items": { "type": "string" }, "type": "array" }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/AuthType" }, "updatedById": { "type": "string" }, "version": { "type": "number" }, "versionId": { "type": "string" } }, "required": [ "name", "parentId", "type", "childDiagramIds", "childIds", "commit", "createdAt", "createdBy", "createdById", "diagrams", "domainId", "external", "flows", "groupIds", "handleId", "icon", "id", "labels", "landscapeId", "linked", "links", "parentIds", "status", "tagIds", "teamIds", "teamOnlyEditing", "technologyIds", "updatedAt", "updatedBy", "updatedById", "version", "versionId" ], "type": "object" }, "ModelObjectExpandKey": { "enum": [ "domain", "flows", "tags", "technologies" ], "type": "string" }, "ModelObjectExpanded": { "allOf": [ { "$ref": "#/components/schemas/ModelObject" }, { "properties": { "domain": { "$ref": "#/components/schemas/DomainExport" }, "flowsExpanded": { "additionalProperties": { "$ref": "#/components/schemas/FlowExport" }, "description": "Expanded flow exports keyed by flow ID.", "type": "object" }, "tags": { "additionalProperties": { "$ref": "#/components/schemas/TagExport" }, "type": "object" }, "technologies": { "additionalProperties": { "$ref": "#/components/schemas/TechnologyExport" }, "type": "object" } }, "type": "object" } ] }, "ModelStatusType": { "enum": [ "deprecated", "future", "live", "removed" ], "type": "string" }, "ModelStatus": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/ModelStatusType" } }, "required": [ "handleId", "id", "name", "type" ], "type": "object" }, "OrganizationPlan": { "enum": [ "free", "indie", "pilot", "growth", "scale", "isolation" ], "type": "string" }, "OrganizationCollectionMethod": { "enum": [ "charge", "invoice" ], "type": "string" }, "OrganizationStatus": { "enum": [ "active", "canceled", "incomplete_expired", "incomplete", "past_due", "paused", "trialing", "unpaid" ], "type": "string" }, "OrganizationLanguage": { "enum": [ "en-US", "en-GB", "fr-FR", "es-ES", "es-419" ], "type": "string" }, "OrganizationUser": { "properties": { "landscapePermissions": { "additionalProperties": { "type": "boolean" }, "type": "object" }, "permission": { "$ref": "#/components/schemas/PermissionType" } }, "required": [ "permission" ], "type": "object" }, "OrganizationBrand": { "properties": { "name": { "maxLength": 4000, "type": "string" } }, "required": [ "name" ], "type": "object" }, "OrganizationUserInfo": { "properties": { "email": { "format": "email", "type": "string" }, "jobRole": { "type": "string" }, "lastActiveAt": { "format": "date-time", "type": "string" }, "name": { "maxLength": 4000, "type": "string" } }, "required": [ "email", "lastActiveAt" ], "type": "object" }, "OrganizationAIFeatures": { "description": "AI features that are enabled for the organization", "properties": { "generateDetailedDescriptions": { "description": "Whether to enable detailed descriptions for objects, connections, and diagrams", "type": "boolean" }, "generateDisplayDescriptions": { "description": "Whether to enable display descriptions for objects", "type": "boolean" }, "generateDraftSummary": { "description": "Whether to enable draft summaries for diagrams", "type": "boolean" }, "generateObjectSummary": { "description": "Whether to enable object summaries for objects and connections in the right click context menu", "type": "boolean" } }, "type": "object" }, "OrganizationAiModel": { "enum": [ "gpt-5", "gpt-5-mini", "gpt-5-nano" ], "type": "string" }, "OrganizationPartial": { "properties": { "aiFeatures": { "$ref": "#/components/schemas/OrganizationAIFeatures" }, "aiFeaturesEnabled": { "description": "Whether to enable all AI features for the organization", "type": "boolean" }, "aiModel": { "$ref": "#/components/schemas/OrganizationAiModel" }, "billingCurrency": { "$ref": "#/components/schemas/OrganizationBillingCurrency" }, "billingCycle": { "$ref": "#/components/schemas/OrganizationBillingCycle" }, "billingEmail": { "format": "email", "type": "string" }, "experiments": { "additionalProperties": { "type": "boolean" }, "type": "object" }, "language": { "$ref": "#/components/schemas/OrganizationLanguage" }, "lineShapeDefault": { "$ref": "#/components/schemas/LineShape" }, "name": { "maxLength": 4000, "type": "string" }, "oauthLandscapeWriteEnabled": { "description": "Whether OAuth connections can make changes to landscape data", "type": "boolean" }, "shareLinkAuthDomains": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "shareLinksEnabled": { "type": "boolean" } }, "type": "object" }, "OrganizationRequired": { "properties": { "aiFeatures": { "$ref": "#/components/schemas/OrganizationAIFeatures" }, "aiFeaturesEnabled": { "description": "Whether to enable all AI features for the organization", "type": "boolean" }, "aiModel": { "$ref": "#/components/schemas/OrganizationAiModel" }, "billingCurrency": { "$ref": "#/components/schemas/OrganizationBillingCurrency" }, "billingCycle": { "$ref": "#/components/schemas/OrganizationBillingCycle" }, "billingEmail": { "format": "email", "type": "string" }, "experiments": { "additionalProperties": { "type": "boolean" }, "type": "object" }, "language": { "$ref": "#/components/schemas/OrganizationLanguage" }, "lineShapeDefault": { "$ref": "#/components/schemas/LineShape" }, "name": { "maxLength": 4000, "type": "string" }, "oauthLandscapeWriteEnabled": { "description": "Whether OAuth connections can make changes to landscape data", "type": "boolean" }, "shareLinkAuthDomains": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "shareLinksEnabled": { "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "Organization": { "properties": { "aiFeatures": { "$ref": "#/components/schemas/OrganizationAIFeatures" }, "aiFeaturesEnabled": { "description": "Whether to enable all AI features for the organization", "type": "boolean" }, "aiModel": { "$ref": "#/components/schemas/OrganizationAiModel" }, "billingCurrency": { "$ref": "#/components/schemas/OrganizationBillingCurrency" }, "billingCycle": { "$ref": "#/components/schemas/OrganizationBillingCycle" }, "billingEmail": { "format": "email", "type": "string" }, "experiments": { "additionalProperties": { "type": "boolean" }, "type": "object" }, "language": { "$ref": "#/components/schemas/OrganizationLanguage" }, "lineShapeDefault": { "$ref": "#/components/schemas/LineShape" }, "name": { "maxLength": 4000, "type": "string" }, "oauthLandscapeWriteEnabled": { "description": "Whether OAuth connections can make changes to landscape data", "type": "boolean" }, "shareLinkAuthDomains": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "shareLinksEnabled": { "type": "boolean" }, "autoInviteDomains": { "items": { "type": "string" }, "type": "array" }, "billingCollectionMethod": { "$ref": "#/components/schemas/OrganizationCollectionMethod" }, "billingMonthlyCost": { "type": "number" }, "billingPaymentMethod": { "type": "boolean" }, "cancelAt": { "format": "date-time", "type": "string" }, "canceledAt": { "format": "date-time", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "id": { "type": "string" }, "plan": { "$ref": "#/components/schemas/OrganizationPlan" }, "planEndsAt": { "format": "date-time", "type": "string" }, "seats": { "type": "number" }, "status": { "$ref": "#/components/schemas/OrganizationStatus" }, "trialEndsAt": { "format": "date-time", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/AuthType" }, "updatedById": { "type": "string" }, "userIds": { "items": { "type": "string" }, "type": "array" }, "users": { "additionalProperties": { "$ref": "#/components/schemas/OrganizationUser" }, "type": "object" } }, "required": [ "name", "autoInviteDomains", "billingPaymentMethod", "createdAt", "createdBy", "createdById", "id", "lineShapeDefault", "oauthLandscapeWriteEnabled", "plan", "seats", "shareLinkAuthDomains", "shareLinksEnabled", "status", "updatedAt", "updatedBy", "updatedById", "userIds", "users" ], "type": "object" }, "OrganizationBillingCurrency": { "enum": [ "usd", "cad", "eur", "gbp" ], "type": "string" }, "OrganizationBillingCycle": { "enum": [ "monthly", "annually" ], "type": "string" }, "OrganizationBillingLinks": { "properties": { "paymentMethodsUrl": { "format": "uri", "type": "string" }, "updateSubscriptionPlanUrl": { "format": "uri", "type": "string" }, "url": { "format": "uri", "type": "string" } }, "required": [ "paymentMethodsUrl", "url" ], "type": "object" }, "OrganizationBillingSubscriptionCreate": { "properties": { "billingCurrency": { "$ref": "#/components/schemas/OrganizationBillingCurrency" }, "billingCycle": { "$ref": "#/components/schemas/OrganizationBillingCycle" }, "plan": { "$ref": "#/components/schemas/OrganizationPlan" }, "seats": { "type": "number" }, "trial": { "type": "boolean" } }, "type": "object" }, "OrganizationBillingSubscriptionUpdate": { "properties": { "cancelAtPeriodEnd": { "type": "boolean" }, "plan": { "$ref": "#/components/schemas/OrganizationPlan" }, "seats": { "type": "number" }, "trial": { "type": "boolean" }, "trialEnd": { "type": "boolean" } }, "type": "object" }, "OrganizationLogFilterActionType": { "description": "type of action that was performed, eg: diagram-content-update or model-object-create", "oneOf": [ { "$ref": "#/components/schemas/ActionType" }, { "items": { "$ref": "#/components/schemas/ActionType" }, "maxItems": 100, "type": "array" }, { "properties": { "$not": { "oneOf": [ { "$ref": "#/components/schemas/ActionType" }, { "items": { "$ref": "#/components/schemas/ActionType" }, "maxItems": 100, "type": "array" } ] } }, "type": "object" } ] }, "OrganizationLogFilter": { "properties": { "actionId": { "description": "id of the entity to lookup, eg: id of the tag being created, or id of the model object being updated", "type": "string" }, "actionType": { "$ref": "#/components/schemas/OrganizationLogFilterActionType" }, "endAtDate": { "format": "date-time", "type": "string" }, "endAtId": { "deprecated": true, "description": "use cursor instead", "type": "string" }, "endBeforeDate": { "format": "date-time", "type": "string" }, "endBeforeId": { "deprecated": true, "description": "use cursor instead", "type": "string" }, "includeActionsInContext": { "description": "include actions from objects inside the context, eg: update of a model connection that is connected to a model object", "type": "boolean" }, "performedBy": { "oneOf": [ { "$ref": "#/components/schemas/AuthType" }, { "items": { "$ref": "#/components/schemas/AuthType" }, "maxItems": 100, "type": "array" } ] }, "performedById": { "description": "id of the user or api key who performed the action", "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "maxItems": 100, "type": "array" } ] }, "startAfterDate": { "format": "date-time", "type": "string" }, "startAfterId": { "deprecated": true, "description": "use cursor instead", "type": "string" }, "startAtDate": { "format": "date-time", "type": "string" }, "startAtId": { "deprecated": true, "description": "use cursor instead", "type": "string" } }, "type": "object" }, "OrganizationLog": { "properties": { "action": { "$ref": "#/components/schemas/Action", "description": "full description of the action that happened" }, "actionIds": { "description": "id of the action and any related ids that were part of the action", "items": { "type": "string" }, "type": "array" }, "id": { "type": "string" }, "landscapeId": { "type": "string" }, "parentId": { "description": "parent action log id that caused this action to happen, eg: update of a diagram caused by a model object delete", "nullable": true, "type": "string" }, "performedAt": { "format": "date-time", "type": "string" }, "performedBy": { "$ref": "#/components/schemas/AuthType" }, "performedByAuthProvider": { "type": "string" }, "performedByClientId": { "type": "string" }, "performedById": { "type": "string" }, "performedByIp": { "description": "ip address of the user or api key who performed the action", "type": "string" }, "performedByName": { "type": "string" }, "performedByUserAgent": { "type": "string" } }, "required": [ "action", "actionIds", "id", "parentId", "performedAt", "performedBy", "performedById" ], "type": "object" }, "OrganizationLogStatsFilter": { "properties": { "actionType": { "description": "type of action that was performed, eg: diagram-content-update or model-object-create", "oneOf": [ { "$ref": "#/components/schemas/ActionType" }, { "items": { "$ref": "#/components/schemas/ActionType" }, "maxItems": 100, "type": "array" } ] }, "endAtDate": { "format": "date-time", "type": "string" }, "entityId": { "description": "id of the entity to lookup, eg: id of the tag being created, or id of the model object being updated", "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "maxItems": 100, "type": "array" } ] }, "performedBy": { "oneOf": [ { "$ref": "#/components/schemas/AuthType" }, { "items": { "$ref": "#/components/schemas/AuthType" }, "maxItems": 100, "type": "array" } ] }, "performedById": { "description": "id of the user or api key who performed the action", "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "maxItems": 100, "type": "array" } ] }, "startAtDate": { "format": "date-time", "type": "string" } }, "type": "object" }, "OrganizationLogStatsItemByType": { "properties": { "contributors": { "additionalProperties": { "$ref": "#/components/schemas/ActionLogStatsContributor" }, "type": "object" }, "count": { "type": "number" }, "type": { "$ref": "#/components/schemas/ActionType", "description": "type of action that was performed, eg: diagram-content-update or model-object-create" } }, "required": [ "contributors", "count", "type" ], "type": "object" }, "OrganizationLogStatsDateByType": { "properties": { "actions": { "additionalProperties": { "$ref": "#/components/schemas/OrganizationLogStatsItemByType" }, "type": "object" }, "date": { "format": "date-time", "type": "string" } }, "required": [ "actions", "date" ], "type": "object" }, "OrganizationLogStatsListByType": { "properties": { "contributors": { "additionalProperties": { "$ref": "#/components/schemas/ActionLogStatsContributor" }, "type": "object" }, "dates": { "items": { "$ref": "#/components/schemas/OrganizationLogStatsDateByType" }, "type": "array" }, "totalCount": { "type": "number" } }, "required": [ "contributors", "dates", "totalCount" ], "type": "object" }, "OrganizationUserInvitePartial": { "properties": { "email": { "type": "string" }, "expiresAt": { "format": "date-time", "type": "string" }, "landscapePermissions": { "additionalProperties": { "type": "boolean" }, "type": "object" }, "permission": { "$ref": "#/components/schemas/PermissionType" } }, "type": "object" }, "OrganizationUserInviteRequired": { "properties": { "email": { "type": "string" }, "expiresAt": { "format": "date-time", "type": "string" }, "landscapePermissions": { "additionalProperties": { "type": "boolean" }, "type": "object" }, "permission": { "$ref": "#/components/schemas/PermissionType" } }, "required": [ "email", "expiresAt", "permission" ], "type": "object" }, "OrganizationUserInvite": { "properties": { "email": { "type": "string" }, "expiresAt": { "format": "date-time", "type": "string" }, "landscapePermissions": { "additionalProperties": { "type": "boolean" }, "type": "object" }, "permission": { "$ref": "#/components/schemas/PermissionType" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "id": { "type": "string" }, "organizationId": { "type": "string" }, "revokedAt": { "format": "date-time", "type": "string" }, "revokedBy": { "$ref": "#/components/schemas/AuthType" }, "revokedById": { "type": "string" }, "usedAt": { "format": "date-time", "type": "string" }, "usedByUserId": { "type": "string" } }, "required": [ "email", "expiresAt", "permission", "createdAt", "createdBy", "createdById", "id", "organizationId" ], "type": "object" }, "SAMLProviderPartial": { "properties": { "certificates": { "description": "IDP provided public X.509 signing certificate(s) or public key(s) in RFC7468 stricttextualmsg PEM format", "items": { "type": "string" }, "maxItems": 5, "type": "array" }, "domains": { "description": "Email domains that are bound to the provider", "items": { "format": "hostname", "type": "string" }, "maxItems": 30, "minItems": 1, "type": "array" }, "enabled": { "description": "Whether the provider is enabled", "type": "boolean" }, "entityId": { "description": "Entity ID provided by the IDP", "type": "string" }, "loginUrl": { "description": "Single sign-on login URL provided by the IDP", "format": "uri", "type": "string" }, "name": { "description": "Name for the provider, only for display purposes", "maxLength": 1000, "type": "string" } }, "type": "object" }, "SAMLProviderRequired": { "properties": { "certificates": { "description": "IDP provided public X.509 signing certificate(s) or public key(s) in RFC7468 stricttextualmsg PEM format", "items": { "type": "string" }, "maxItems": 5, "type": "array" }, "domains": { "description": "Email domains that are bound to the provider", "items": { "format": "hostname", "type": "string" }, "maxItems": 30, "minItems": 1, "type": "array" }, "enabled": { "description": "Whether the provider is enabled", "type": "boolean" }, "entityId": { "description": "Entity ID provided by the IDP", "type": "string" }, "loginUrl": { "description": "Single sign-on login URL provided by the IDP", "format": "uri", "type": "string" }, "name": { "description": "Name for the provider, only for display purposes", "maxLength": 1000, "type": "string" } }, "required": [ "certificates", "domains" ], "type": "object" }, "SAMLProvider": { "properties": { "certificates": { "description": "IDP provided public X.509 signing certificate(s) or public key(s) in RFC7468 stricttextualmsg PEM format", "items": { "type": "string" }, "maxItems": 5, "type": "array" }, "domains": { "description": "Email domains that are bound to the provider", "items": { "format": "hostname", "type": "string" }, "maxItems": 30, "minItems": 1, "type": "array" }, "enabled": { "description": "Whether the provider is enabled", "type": "boolean" }, "entityId": { "description": "Entity ID provided by the IDP", "type": "string" }, "loginUrl": { "description": "Single sign-on login URL provided by the IDP", "format": "uri", "type": "string" }, "name": { "description": "Name for the provider, only for display purposes", "maxLength": 1000, "type": "string" }, "acsUrl": { "description": "Assertion Consumer Service URL provided by the SP", "format": "uri", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "id", "type": "string" }, "issuerId": { "description": "Entity/Issuer ID provided by the SP", "type": "string" }, "organizationId": { "format": "id", "nullable": true, "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "required": [ "certificates", "domains", "acsUrl", "createdAt", "id", "issuerId", "organizationId" ], "type": "object" }, "SAMLRequest": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "id": { "description": "SAML request identifier generated by the SP", "format": "id", "type": "string" }, "value": { "description": "SAML request value, usually the date it was created", "type": "string" } }, "required": [ "createdAt", "id", "value" ], "type": "object" }, "SendEbookRequired": { "properties": { "email": { "description": "The email address to send the ebook to", "format": "email", "type": "string" } }, "required": [ "email" ], "type": "object" }, "ShareLinkFrameLocation": { "enum": [ "notion", "miro", "confluence", "sharepoint", "powerpoint" ], "type": "string" }, "ShareLinkStats": { "properties": { "totalVisitorCount": { "type": "number" }, "viewedAt": { "format": "date-time", "type": "string" } }, "required": [ "totalVisitorCount" ], "type": "object" }, "ShareLinkPartial": { "properties": { "password": { "format": "password", "maxLength": 64, "minLength": 8, "type": "string" }, "protected": { "type": "boolean" } }, "type": "object" }, "ShareLinkRequired": { "properties": { "password": { "format": "password", "maxLength": 64, "minLength": 8, "type": "string" }, "protected": { "type": "boolean" }, "draftId": { "nullable": true, "type": "string" } }, "required": [ "protected" ], "type": "object" }, "ShareLink": { "properties": { "password": { "format": "password", "maxLength": 64, "minLength": 8, "type": "string" }, "protected": { "type": "boolean" }, "draftId": { "nullable": true, "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "id": { "type": "string" }, "landscapeId": { "type": "string" }, "shortId": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/AuthType" }, "updatedById": { "type": "string" }, "versionId": { "type": "string" } }, "required": [ "protected", "createdAt", "createdBy", "createdById", "id", "landscapeId", "shortId", "updatedAt", "updatedBy", "updatedById", "versionId" ], "type": "object" }, "ShareLinkOptionsOverlayTab": { "enum": [ "tags", "technology", "status" ], "type": "string" }, "ShareLinkOptionsMode": { "enum": [ "overview", "diagrams", "flows", "model-objects", "model-viewer", "model-connections", "dependencies", "technologies", "diagram", "flow", "adrs" ], "type": "string" }, "ShareLinkOptionsObjectTab": { "enum": [ "details", "connections", "history" ], "type": "string" }, "ShareLinkOptionsDrawer": { "enum": [ "expanded", "collapsed" ], "type": "string" }, "ShareLinkOptionsDrawerObject": { "enum": [ "expanded", "collapsed" ], "type": "string" }, "ShareLinkOptionsRequired": { "properties": { "adrId": { "nullable": true, "type": "string" }, "connectionIds": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "diagramId": { "nullable": true, "type": "string" }, "domainId": { "nullable": true, "type": "string" }, "drawer": { "enum": [ "expanded", "collapsed", null ], "nullable": true, "type": "string" }, "expandedIds": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "filterIds": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "filterIdsExcluded": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "filterIdsIncluded": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "flowId": { "nullable": true, "type": "string" }, "flowParentIds": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "flowPathIds": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "flowStepId": { "nullable": true, "type": "string" }, "mode": { "$ref": "#/components/schemas/ShareLinkOptionsMode" }, "modelId": { "nullable": true, "type": "string" }, "objectIds": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "objectIdsFocused": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "objectTab": { "enum": [ "details", "connections", "history", null ], "nullable": true, "type": "string" }, "overlayGroupId": { "nullable": true, "type": "string" }, "overlayIdsFocused": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "overlayIdsHidden": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "overlayIdsPinned": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "overlayTab": { "enum": [ "tags", "technology", "status", null ], "nullable": true, "type": "string" }, "preventNavigation": { "type": "boolean" }, "search": { "nullable": true, "type": "string" }, "viaId": { "nullable": true, "type": "string" }, "x1": { "nullable": true, "type": "number" }, "x2": { "nullable": true, "type": "number" }, "y": { "nullable": true, "type": "number" }, "y1": { "nullable": true, "type": "number" }, "y2": { "nullable": true, "type": "number" } }, "required": [ "adrId", "connectionIds", "diagramId", "domainId", "drawer", "expandedIds", "filterIds", "filterIdsExcluded", "filterIdsIncluded", "flowId", "flowParentIds", "flowPathIds", "flowStepId", "mode", "modelId", "objectIds", "objectIdsFocused", "objectTab", "overlayGroupId", "overlayIdsFocused", "overlayIdsHidden", "overlayIdsPinned", "overlayTab", "preventNavigation", "search", "viaId", "x1", "x2", "y", "y1", "y2" ], "type": "object" }, "ShareLinkOptions": { "properties": { "adrId": { "nullable": true, "type": "string" }, "connectionIds": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "diagramId": { "nullable": true, "type": "string" }, "domainId": { "nullable": true, "type": "string" }, "drawer": { "enum": [ "expanded", "collapsed", null ], "nullable": true, "type": "string" }, "expandedIds": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "filterIds": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "filterIdsExcluded": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "filterIdsIncluded": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "flowId": { "nullable": true, "type": "string" }, "flowParentIds": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "flowPathIds": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "flowStepId": { "nullable": true, "type": "string" }, "mode": { "$ref": "#/components/schemas/ShareLinkOptionsMode" }, "modelId": { "nullable": true, "type": "string" }, "objectIds": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "objectIdsFocused": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "objectTab": { "enum": [ "details", "connections", "history", null ], "nullable": true, "type": "string" }, "overlayGroupId": { "nullable": true, "type": "string" }, "overlayIdsFocused": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "overlayIdsHidden": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "overlayIdsPinned": { "items": { "type": "string" }, "nullable": true, "type": "array" }, "overlayTab": { "enum": [ "tags", "technology", "status", null ], "nullable": true, "type": "string" }, "preventNavigation": { "type": "boolean" }, "search": { "nullable": true, "type": "string" }, "viaId": { "nullable": true, "type": "string" }, "x1": { "nullable": true, "type": "number" }, "x2": { "nullable": true, "type": "number" }, "y": { "nullable": true, "type": "number" }, "y1": { "nullable": true, "type": "number" }, "y2": { "nullable": true, "type": "number" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "hash": { "type": "string" }, "id": { "type": "string" }, "shareLinkId": { "type": "string" }, "shortId": { "type": "string" } }, "required": [ "adrId", "connectionIds", "diagramId", "domainId", "drawer", "expandedIds", "filterIds", "filterIdsExcluded", "filterIdsIncluded", "flowId", "flowParentIds", "flowPathIds", "flowStepId", "mode", "modelId", "objectIds", "objectIdsFocused", "objectTab", "overlayGroupId", "overlayIdsFocused", "overlayIdsHidden", "overlayIdsPinned", "overlayTab", "preventNavigation", "search", "viaId", "x1", "x2", "y", "y1", "y2", "createdAt", "createdBy", "createdById", "hash", "id", "shareLinkId", "shortId" ], "type": "object" }, "SupportMessageRequired": { "properties": { "body": { "$ref": "#/components/schemas/SupportMessageBody" }, "email": { "description": "The email address of the user, preferrably this should be set by providing an authorization header, using this will mark the message as anonymous", "format": "email", "type": "string" }, "landscapeId": { "description": "The landscape that the message is regarding, only available when the user is authenticated", "type": "string" }, "name": { "maxLength": 4000, "type": "string" }, "organizationId": { "description": "The organization that the message is regarding, only available when the user is authenticated", "type": "string" }, "url": { "description": "The url of the page that was viewed when the message is created", "format": "uri", "type": "string" } }, "required": [ "body" ], "type": "object" }, "SupportMessage": { "properties": { "body": { "$ref": "#/components/schemas/SupportMessageBody" }, "email": { "description": "The email address of the user, preferrably this should be set by providing an authorization header, using this will mark the message as anonymous", "format": "email", "type": "string" }, "landscapeId": { "description": "The landscape that the message is regarding, only available when the user is authenticated", "type": "string" }, "name": { "maxLength": 4000, "type": "string" }, "organizationId": { "description": "The organization that the message is regarding, only available when the user is authenticated", "type": "string" }, "url": { "description": "The url of the page that was viewed when the message is created", "format": "uri", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "userId": { "description": "The user that created the message if the request was authenticated", "type": "string" } }, "required": [ "body", "createdAt", "id" ], "type": "object" }, "SupportMessageType": { "enum": [ "bug", "general", "partnerships", "sales", "sso-saml-registration", "support" ], "type": "string" }, "SupportMessageAttachment": { "properties": { "data": { "type": "string" }, "filename": { "type": "string" }, "size": { "type": "number" }, "type": { "type": "string" } }, "required": [ "data", "filename" ], "type": "object" }, "SupportMessageBodyBug": { "properties": { "attachments": { "items": { "$ref": "#/components/schemas/SupportMessageAttachment" }, "type": "array" }, "message": { "maxLength": 20000, "type": "string" }, "subject": { "maxLength": 1000, "type": "string" }, "type": { "enum": [ "bug" ], "type": "string" } }, "required": [ "message", "subject", "type" ], "type": "object" }, "SupportMessageBodyGeneral": { "properties": { "attachments": { "items": { "$ref": "#/components/schemas/SupportMessageAttachment" }, "type": "array" }, "feeling": { "type": "string" }, "message": { "maxLength": 20000, "type": "string" }, "subject": { "maxLength": 1000, "type": "string" }, "type": { "enum": [ "general" ], "type": "string" } }, "required": [ "message", "subject", "type" ], "type": "object" }, "SupportMessageBodySales": { "properties": { "feeling": { "type": "string" }, "message": { "maxLength": 20000, "type": "string" }, "subject": { "maxLength": 1000, "type": "string" }, "type": { "enum": [ "sales" ], "type": "string" } }, "required": [ "message", "subject", "type" ], "type": "object" }, "SupportMessageBodyPartnerships": { "properties": { "feeling": { "type": "string" }, "message": { "maxLength": 20000, "type": "string" }, "subject": { "maxLength": 1000, "type": "string" }, "type": { "enum": [ "partnerships" ], "type": "string" } }, "required": [ "message", "subject", "type" ], "type": "object" }, "SupportMessageBodySSOSamlRegistration": { "properties": { "autoInvite": { "type": "boolean" }, "certificate": { "type": "string" }, "companyDomain": { "type": "string" }, "entityId": { "type": "string" }, "ssoUrl": { "format": "uri", "type": "string" }, "type": { "enum": [ "sso-saml-registration" ], "type": "string" } }, "required": [ "autoInvite", "certificate", "companyDomain", "entityId", "ssoUrl", "type" ], "type": "object" }, "SupportMessageBodySupport": { "properties": { "attachments": { "items": { "$ref": "#/components/schemas/SupportMessageAttachment" }, "type": "array" }, "feeling": { "type": "string" }, "message": { "maxLength": 20000, "type": "string" }, "subject": { "maxLength": 1000, "type": "string" }, "type": { "enum": [ "support" ], "type": "string" } }, "required": [ "message", "subject", "type" ], "type": "object" }, "SupportMessageBody": { "oneOf": [ { "$ref": "#/components/schemas/SupportMessageBodyBug" }, { "$ref": "#/components/schemas/SupportMessageBodyGeneral" }, { "$ref": "#/components/schemas/SupportMessageBodySales" }, { "$ref": "#/components/schemas/SupportMessageBodySSOSamlRegistration" }, { "$ref": "#/components/schemas/SupportMessageBodySupport" }, { "$ref": "#/components/schemas/SupportMessageBodyPartnerships" } ] }, "TagFilter": { "properties": { "groupId": { "type": "string" }, "handleId": { "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "maxItems": 30, "type": "array" } ] }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "name": { "type": "string" } }, "type": "object" }, "TagColor": { "enum": [ "blue", "green", "yellow", "orange", "red", "beaver", "dark-blue", "purple", "pink", "white", "grey", "black" ], "type": "string" }, "TagPartial": { "properties": { "color": { "$ref": "#/components/schemas/TagColor" }, "commit": { "type": "number" }, "groupId": { "type": "string" }, "index": { "type": "number" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "name": { "maxLength": 4000, "type": "string" } }, "type": "object" }, "TagRequired": { "properties": { "color": { "$ref": "#/components/schemas/TagColor" }, "commit": { "type": "number" }, "groupId": { "type": "string" }, "index": { "type": "number" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "name": { "maxLength": 4000, "type": "string" }, "handleId": { "type": "string" } }, "required": [ "color", "groupId", "index", "name" ], "type": "object" }, "TagUpsert": { "allOf": [ { "$ref": "#/components/schemas/TagRequired" }, { "$ref": "#/components/schemas/TagPartial" } ] }, "Tag": { "properties": { "color": { "$ref": "#/components/schemas/TagColor" }, "commit": { "type": "number" }, "groupId": { "type": "string" }, "index": { "type": "number" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "name": { "maxLength": 4000, "type": "string" }, "handleId": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "deletedAt": { "format": "date-time", "type": "string" }, "deletedBy": { "$ref": "#/components/schemas/AuthType" }, "deletedById": { "type": "string" }, "id": { "type": "string" }, "landscapeId": { "type": "string" }, "latestEntityId": { "type": "string" }, "modelConnectionIds": { "items": { "type": "string" }, "type": "array" }, "modelObjectIds": { "items": { "type": "string" }, "type": "array" }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/AuthType" }, "updatedById": { "type": "string" }, "version": { "type": "number" }, "versionId": { "type": "string" } }, "required": [ "color", "groupId", "index", "name", "commit", "createdAt", "createdBy", "createdById", "handleId", "id", "labels", "landscapeId", "modelConnectionIds", "modelObjectIds", "updatedAt", "updatedBy", "updatedById", "version", "versionId" ], "type": "object" }, "TagGroupFilter": { "properties": { "handleId": { "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "maxItems": 30, "type": "array" } ] }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "name": { "type": "string" } }, "type": "object" }, "TagGroupIcon": { "enum": [ "bug", "calendar-check", "calendar-times", "cloud", "cog", "database", "exclamation-triangle", "file", "globe", "laptop-code", "lightbulb", "lock", "microchip", "minus", "mobile", "network-wired", "plus", "poo", "robot", "rocket", "sack-dollar", "server", "sledding", "snowman", "star", "times", "toolbox", "trash", "users", "wifi" ], "type": "string" }, "TagGroupPartial": { "properties": { "commit": { "type": "number" }, "icon": { "$ref": "#/components/schemas/TagGroupIcon" }, "index": { "type": "number" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "name": { "maxLength": 4000, "type": "string" } }, "type": "object" }, "TagGroupRequired": { "properties": { "commit": { "type": "number" }, "icon": { "$ref": "#/components/schemas/TagGroupIcon" }, "index": { "type": "number" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "name": { "maxLength": 4000, "type": "string" }, "handleId": { "type": "string" } }, "required": [ "icon", "index", "name" ], "type": "object" }, "TagGroupUpsert": { "allOf": [ { "$ref": "#/components/schemas/TagGroupRequired" }, { "$ref": "#/components/schemas/TagGroupPartial" } ] }, "TagGroup": { "properties": { "commit": { "type": "number" }, "icon": { "$ref": "#/components/schemas/TagGroupIcon" }, "index": { "type": "number" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "name": { "maxLength": 4000, "type": "string" }, "handleId": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "deletedAt": { "format": "date-time", "type": "string" }, "deletedBy": { "$ref": "#/components/schemas/AuthType" }, "deletedById": { "type": "string" }, "id": { "type": "string" }, "landscapeId": { "type": "string" }, "latestEntityId": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/AuthType" }, "updatedById": { "type": "string" }, "version": { "type": "number" }, "versionId": { "type": "string" } }, "required": [ "icon", "index", "name", "commit", "createdAt", "createdBy", "createdById", "handleId", "id", "labels", "landscapeId", "updatedAt", "updatedBy", "updatedById", "version", "versionId" ], "type": "object" }, "TaskType": { "enum": [ "adr-create", "adr-delete", "adr-update", "batch", "comment-create", "comment-delete", "comment-reply-create", "comment-reply-delete", "comment-reply-update", "comment-update", "concurrency", "diagram-content-update", "diagram-create", "diagram-delete", "diagram-group-create", "diagram-group-delete", "diagram-group-update", "diagram-update", "domain-create", "domain-delete", "domain-update", "draft-create", "draft-delete", "draft-task-create", "draft-update", "flow-create", "flow-delete", "flow-update", "model-connection-create", "model-connection-delete", "model-connection-update", "model-object-create", "model-object-delete", "model-object-update", "navigation", "tag-create", "tag-delete", "tag-group-create", "tag-group-delete", "tag-group-update", "tag-update", "team-update" ], "type": "string" }, "TaskConcurrency": { "properties": { "concurrency": { "type": "number" }, "type": { "enum": [ "concurrency" ], "type": "string" } }, "required": [ "concurrency", "type" ], "type": "object" }, "TaskBatch": { "properties": { "tasks": { "items": { "$ref": "#/components/schemas/Task" }, "type": "array" }, "type": { "enum": [ "batch" ], "type": "string" } }, "required": [ "tasks", "type" ], "type": "object" }, "TaskNavigation": { "properties": { "route": { "$ref": "#/components/schemas/TaskNavigationRoute" }, "type": { "enum": [ "navigation" ], "type": "string" } }, "required": [ "route", "type" ], "type": "object" }, "TaskNavigationRoute": { "properties": { "name": { "nullable": true, "type": "string" }, "params": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "type": "object" }, "query": { "additionalProperties": { "anyOf": [ { "nullable": true, "type": "string" }, { "items": { "nullable": true, "type": "string" }, "type": "array" } ] }, "type": "object" } }, "type": "object" }, "TaskCommentCreate": { "properties": { "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/CommentRequired" }, "type": { "enum": [ "comment-create" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "TaskCommentUpdate": { "properties": { "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/CommentPartial" }, "type": { "enum": [ "comment-update" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "TaskCommentDelete": { "properties": { "id": { "type": "string" }, "type": { "enum": [ "comment-delete" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "TaskCommentReplyCreate": { "properties": { "commentId": { "type": "string" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/CommentReplyRequired" }, "type": { "enum": [ "comment-reply-create" ], "type": "string" } }, "required": [ "id", "props", "type", "commentId" ], "type": "object" }, "TaskCommentReplyUpdate": { "properties": { "commentId": { "type": "string" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/CommentReplyPartial" }, "type": { "enum": [ "comment-reply-update" ], "type": "string" } }, "required": [ "id", "props", "type", "commentId" ], "type": "object" }, "TaskCommentReplyDelete": { "properties": { "commentId": { "type": "string" }, "id": { "type": "string" }, "type": { "enum": [ "comment-reply-delete" ], "type": "string" } }, "required": [ "id", "type", "commentId" ], "type": "object" }, "TaskDiagramCreate": { "properties": { "id": { "type": "string" }, "props": { "allOf": [ { "$ref": "#/components/schemas/DiagramRequired" }, { "$ref": "#/components/schemas/DiagramContentRequired" } ] }, "type": { "enum": [ "diagram-create" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "TaskDiagramUpdate": { "properties": { "id": { "type": "string" }, "props": { "allOf": [ { "$ref": "#/components/schemas/DiagramPartial" }, { "$ref": "#/components/schemas/DiagramContentPartial" } ] }, "type": { "enum": [ "diagram-update" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "TaskDiagramDelete": { "properties": { "id": { "type": "string" }, "type": { "enum": [ "diagram-delete" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "TaskDiagramContentUpdate": { "properties": { "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/DiagramContentPartial" }, "type": { "enum": [ "diagram-content-update" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "TaskDiagramGroupCreate": { "properties": { "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/DiagramGroupRequired" }, "type": { "enum": [ "diagram-group-create" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "TaskDiagramGroupUpdate": { "properties": { "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/DiagramGroupPartial" }, "type": { "enum": [ "diagram-group-update" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "TaskDiagramGroupDelete": { "properties": { "id": { "type": "string" }, "type": { "enum": [ "diagram-group-delete" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "TaskAdrCreate": { "properties": { "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/ADRRequired" }, "type": { "enum": [ "adr-create" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "TaskAdrUpdate": { "properties": { "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/ADRPartial" }, "type": { "enum": [ "adr-update" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "TaskAdrDelete": { "properties": { "id": { "type": "string" }, "type": { "enum": [ "adr-delete" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "TaskDraftCreate": { "properties": { "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/DraftRequired" }, "type": { "enum": [ "draft-create" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "TaskDraftUpdate": { "properties": { "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/DraftPartial" }, "type": { "enum": [ "draft-update" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "TaskDraftDelete": { "properties": { "id": { "type": "string" }, "type": { "enum": [ "draft-delete" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "TaskDomainCreate": { "properties": { "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/DomainRequired" }, "type": { "enum": [ "domain-create" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "TaskDomainUpdate": { "properties": { "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/DomainPartial" }, "type": { "enum": [ "domain-update" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "TaskDomainDelete": { "properties": { "id": { "type": "string" }, "type": { "enum": [ "domain-delete" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "TaskModelObjectCreate": { "properties": { "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/ModelObjectRequired" }, "type": { "enum": [ "model-object-create" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "TaskModelObjectUpdate": { "properties": { "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/ModelObjectPartial" }, "type": { "enum": [ "model-object-update" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "TaskModelObjectDelete": { "properties": { "id": { "type": "string" }, "type": { "enum": [ "model-object-delete" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "TaskModelConnectionCreate": { "properties": { "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/ModelConnectionRequired" }, "type": { "enum": [ "model-connection-create" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "TaskModelConnectionUpdate": { "properties": { "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/ModelConnectionPartial" }, "type": { "enum": [ "model-connection-update" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "TaskModelConnectionDelete": { "properties": { "id": { "type": "string" }, "type": { "enum": [ "model-connection-delete" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "TaskFlowCreate": { "properties": { "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/FlowRequired" }, "type": { "enum": [ "flow-create" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "TaskFlowUpdate": { "properties": { "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/FlowPartial" }, "type": { "enum": [ "flow-update" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "TaskFlowDelete": { "properties": { "id": { "type": "string" }, "type": { "enum": [ "flow-delete" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "TaskTagCreate": { "properties": { "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/TagRequired" }, "type": { "enum": [ "tag-create" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "TaskTagUpdate": { "properties": { "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/TagPartial" }, "type": { "enum": [ "tag-update" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "TaskTagDelete": { "properties": { "id": { "type": "string" }, "type": { "enum": [ "tag-delete" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "TaskTeamUpdate": { "properties": { "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/TeamPartial" }, "type": { "enum": [ "team-update" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "TaskDraftTaskCreate": { "properties": { "draftId": { "type": "string" }, "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/DraftTaskRequired" }, "type": { "enum": [ "draft-task-create" ], "type": "string" } }, "required": [ "id", "props", "type", "draftId" ], "type": "object" }, "TaskTagGroupCreate": { "properties": { "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/TagGroupRequired" }, "type": { "enum": [ "tag-group-create" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "TaskTagGroupUpdate": { "properties": { "id": { "type": "string" }, "props": { "$ref": "#/components/schemas/TagGroupPartial" }, "type": { "enum": [ "tag-group-update" ], "type": "string" } }, "required": [ "id", "props", "type" ], "type": "object" }, "TaskTagGroupDelete": { "properties": { "id": { "type": "string" }, "type": { "enum": [ "tag-group-delete" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "Task": { "oneOf": [ { "$ref": "#/components/schemas/TaskConcurrency" }, { "$ref": "#/components/schemas/TaskBatch" }, { "$ref": "#/components/schemas/TaskNavigation" }, { "$ref": "#/components/schemas/TaskCommentCreate" }, { "$ref": "#/components/schemas/TaskCommentUpdate" }, { "$ref": "#/components/schemas/TaskCommentDelete" }, { "$ref": "#/components/schemas/TaskCommentReplyCreate" }, { "$ref": "#/components/schemas/TaskCommentReplyUpdate" }, { "$ref": "#/components/schemas/TaskCommentReplyDelete" }, { "$ref": "#/components/schemas/TaskDiagramCreate" }, { "$ref": "#/components/schemas/TaskDiagramUpdate" }, { "$ref": "#/components/schemas/TaskDiagramDelete" }, { "$ref": "#/components/schemas/TaskDiagramContentUpdate" }, { "$ref": "#/components/schemas/TaskDiagramGroupCreate" }, { "$ref": "#/components/schemas/TaskDiagramGroupUpdate" }, { "$ref": "#/components/schemas/TaskDiagramGroupDelete" }, { "$ref": "#/components/schemas/TaskAdrCreate" }, { "$ref": "#/components/schemas/TaskAdrUpdate" }, { "$ref": "#/components/schemas/TaskAdrDelete" }, { "$ref": "#/components/schemas/TaskDraftCreate" }, { "$ref": "#/components/schemas/TaskDraftUpdate" }, { "$ref": "#/components/schemas/TaskDraftDelete" }, { "$ref": "#/components/schemas/TaskDraftTaskCreate" }, { "$ref": "#/components/schemas/TaskDomainCreate" }, { "$ref": "#/components/schemas/TaskDomainUpdate" }, { "$ref": "#/components/schemas/TaskDomainDelete" }, { "$ref": "#/components/schemas/TaskModelObjectCreate" }, { "$ref": "#/components/schemas/TaskModelObjectUpdate" }, { "$ref": "#/components/schemas/TaskModelObjectDelete" }, { "$ref": "#/components/schemas/TaskModelConnectionCreate" }, { "$ref": "#/components/schemas/TaskModelConnectionUpdate" }, { "$ref": "#/components/schemas/TaskModelConnectionDelete" }, { "$ref": "#/components/schemas/TaskFlowCreate" }, { "$ref": "#/components/schemas/TaskFlowUpdate" }, { "$ref": "#/components/schemas/TaskFlowDelete" }, { "$ref": "#/components/schemas/TaskTagCreate" }, { "$ref": "#/components/schemas/TaskTagUpdate" }, { "$ref": "#/components/schemas/TaskTagDelete" }, { "$ref": "#/components/schemas/TaskTagGroupCreate" }, { "$ref": "#/components/schemas/TaskTagGroupUpdate" }, { "$ref": "#/components/schemas/TaskTagGroupDelete" }, { "$ref": "#/components/schemas/TaskTeamUpdate" } ] }, "TaskList": { "items": { "$ref": "#/components/schemas/Task" }, "type": "array" }, "TaskListRevertable": { "properties": { "revertTasks": { "$ref": "#/components/schemas/TaskList" }, "tasks": { "$ref": "#/components/schemas/TaskList" } }, "required": [ "revertTasks", "tasks" ], "type": "object" }, "TeamPartial": { "properties": { "color": { "$ref": "#/components/schemas/TagColor" }, "name": { "maxLength": 4000, "type": "string" }, "userIds": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "TeamRequired": { "properties": { "color": { "$ref": "#/components/schemas/TagColor" }, "name": { "maxLength": 4000, "type": "string" }, "userIds": { "items": { "type": "string" }, "type": "array" } }, "required": [ "name" ], "type": "object" }, "Team": { "properties": { "color": { "$ref": "#/components/schemas/TagColor" }, "name": { "maxLength": 4000, "type": "string" }, "userIds": { "items": { "type": "string" }, "type": "array" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "id": { "type": "string" }, "modelObjectHandleIds": { "items": { "type": "string" }, "type": "array" }, "organizationId": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/AuthType" }, "updatedById": { "type": "string" } }, "required": [ "name", "color", "createdAt", "createdBy", "createdById", "id", "modelObjectHandleIds", "organizationId", "updatedAt", "updatedBy", "updatedById", "userIds" ], "type": "object" }, "UserNotificationsPartial": { "description": "Subscribe the user to specific types of notifications", "properties": { "catalogTechnology": { "description": "Subscribe to updates about catalog technology interactions", "type": "boolean" }, "comments": { "description": "Subscribe to comments, mentions, replies and resolutions", "type": "boolean" }, "exports": { "description": "Subscribe to PDF export completions or failures", "type": "boolean" }, "invites": { "description": "Subscribe to user invites to organizations", "type": "boolean" }, "onboarding": { "description": "Subscribe to user registration onboarding help and tips", "type": "boolean" } }, "type": "object" }, "UserNotifications": { "description": "Subscribe the user to specific types of notifications", "properties": { "catalogTechnology": { "description": "Subscribe to updates about catalog technology interactions", "type": "boolean" }, "comments": { "description": "Subscribe to comments, mentions, replies and resolutions", "type": "boolean" }, "exports": { "description": "Subscribe to PDF export completions or failures", "type": "boolean" }, "invites": { "description": "Subscribe to user invites to organizations", "type": "boolean" }, "onboarding": { "description": "Subscribe to user registration onboarding help and tips", "type": "boolean" } }, "required": [ "catalogTechnology", "comments", "exports", "invites", "onboarding" ], "type": "object" }, "UserTheme": { "enum": [ "light", "dark", "system" ], "type": "string" }, "UserPartial": { "properties": { "c4ModelExperience": { "type": "string" }, "defaultDomainHandleIds": { "additionalProperties": { "format": "short-id", "nullable": true, "type": "string" }, "description": "Map of landscape id to the default domain handle id for that landscape", "nullable": true, "type": "object" }, "defaultOrganizationId": { "format": "id", "nullable": true, "type": "string" }, "defaultOrganizationLandscapeIds": { "additionalProperties": { "format": "id", "nullable": true, "type": "string" }, "nullable": true, "type": "object" }, "email": { "format": "email", "type": "string" }, "jobRole": { "type": "string" }, "name": { "maxLength": 128, "minLength": 1, "type": "string" }, "referredBy": { "type": "string" }, "referredByOrganizationId": { "type": "string" }, "referredByUserId": { "type": "string" }, "theme": { "$ref": "#/components/schemas/UserTheme" } }, "type": "object" }, "UserRequired": { "properties": { "c4ModelExperience": { "type": "string" }, "defaultDomainHandleIds": { "additionalProperties": { "format": "short-id", "nullable": true, "type": "string" }, "description": "Map of landscape id to the default domain handle id for that landscape", "nullable": true, "type": "object" }, "defaultOrganizationId": { "format": "id", "nullable": true, "type": "string" }, "defaultOrganizationLandscapeIds": { "additionalProperties": { "format": "id", "nullable": true, "type": "string" }, "nullable": true, "type": "object" }, "email": { "format": "email", "type": "string" }, "jobRole": { "type": "string" }, "name": { "maxLength": 128, "minLength": 1, "type": "string" }, "referredBy": { "type": "string" }, "referredByOrganizationId": { "type": "string" }, "referredByUserId": { "type": "string" }, "theme": { "$ref": "#/components/schemas/UserTheme" } }, "required": [ "email" ], "type": "object" }, "User": { "properties": { "c4ModelExperience": { "type": "string" }, "defaultDomainHandleIds": { "additionalProperties": { "format": "short-id", "nullable": true, "type": "string" }, "description": "Map of landscape id to the default domain handle id for that landscape", "nullable": true, "type": "object" }, "defaultOrganizationId": { "format": "id", "nullable": true, "type": "string" }, "defaultOrganizationLandscapeIds": { "additionalProperties": { "format": "id", "nullable": true, "type": "string" }, "nullable": true, "type": "object" }, "email": { "format": "email", "type": "string" }, "jobRole": { "type": "string" }, "name": { "maxLength": 128, "minLength": 1, "type": "string" }, "referredBy": { "type": "string" }, "referredByOrganizationId": { "type": "string" }, "referredByUserId": { "type": "string" }, "theme": { "$ref": "#/components/schemas/UserTheme" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "lastActiveAt": { "format": "date-time", "type": "string" }, "notifications": { "$ref": "#/components/schemas/UserNotifications" } }, "required": [ "email", "createdAt", "defaultDomainHandleIds", "defaultOrganizationId", "defaultOrganizationLandscapeIds", "id", "lastActiveAt", "notifications", "theme" ], "type": "object" }, "UserGoalStatus": { "enum": [ "incomplete", "complete" ], "type": "string" }, "UserGoalName": { "enum": [ "create-comment", "flows", "model-objects", "open-context-diagram", "zoom-into-object" ], "type": "string" }, "UserGoal": { "properties": { "completedAt": { "format": "date-time", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "name": { "$ref": "#/components/schemas/UserGoalName" }, "progress": { "minimum": 0, "type": "number" }, "progressData": { "items": { "type": "string" }, "type": "array" }, "status": { "$ref": "#/components/schemas/UserGoalStatus" }, "steps": { "minimum": 1, "type": "number" }, "updatedAt": { "format": "date-time", "type": "string" }, "userId": { "type": "string" } }, "required": [ "createdAt", "id", "name", "progress", "progressData", "status", "steps", "updatedAt", "userId" ], "type": "object" }, "OAuthScope": { "enum": [ "landscape.read", "landscape.write" ], "type": "string" }, "UserSession": { "properties": { "clientId": { "description": "Client ID for OAuth sessions", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "expiresAt": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "ip": { "description": "IP address of the client", "type": "string" }, "landscapeId": { "description": "Landscape ID for OAuth sessions", "type": "string" }, "providerId": { "description": "ID for the auth provider", "type": "string" }, "revokedAt": { "format": "date-time", "type": "string" }, "scopes": { "items": { "$ref": "#/components/schemas/OAuthScope" }, "type": "array" }, "userAgent": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "createdAt", "expiresAt", "id", "providerId", "userId" ], "type": "object" }, "VersionFilter": { "properties": { "name": { "type": "string" }, "tag": { "oneOf": [ { "type": "string" }, { "items": { "type": "string" }, "maxItems": 30, "minItems": 1, "type": "array" } ] } }, "type": "object" }, "VersionUpdate": { "properties": { "modelHandleId": { "nullable": true, "type": "string" }, "name": { "maxLength": 4000, "minLength": 1, "type": "string" }, "notes": { "maxLength": 20000, "minLength": 10, "type": "string" } }, "type": "object" }, "VersionRequired": { "properties": { "modelHandleId": { "nullable": true, "type": "string" }, "name": { "maxLength": 4000, "minLength": 1, "type": "string" }, "notes": { "maxLength": 20000, "minLength": 10, "type": "string" } }, "required": [ "modelHandleId", "name", "notes" ], "type": "object" }, "Version": { "properties": { "modelHandleId": { "nullable": true, "type": "string" }, "name": { "maxLength": 4000, "minLength": 1, "type": "string" }, "notes": { "maxLength": 20000, "minLength": 10, "type": "string" }, "completedAt": { "format": "date-time", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "id": { "type": "string" }, "landscapeId": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/AuthType" }, "updatedById": { "type": "string" } }, "required": [ "modelHandleId", "name", "notes", "createdAt", "createdBy", "createdById", "id", "landscapeId", "tags", "updatedAt", "updatedBy", "updatedById" ], "type": "object" }, "VersionField": { "enum": [ "modelHandleId", "name", "notes", "completedAt", "createdAt", "createdBy", "createdById", "landscapeId", "tags", "updatedAt", "updatedBy", "updatedById" ], "type": "string" }, "VersionOptional": { "properties": { "modelHandleId": { "nullable": true, "type": "string" }, "name": { "maxLength": 4000, "minLength": 1, "type": "string" }, "notes": { "maxLength": 20000, "minLength": 10, "type": "string" }, "completedAt": { "format": "date-time", "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "id": { "type": "string" }, "landscapeId": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/AuthType" }, "updatedById": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "VersionRevertPartial": { "properties": { "notes": { "minLength": 10, "type": "string" } }, "type": "object" }, "VersionRevertRequired": { "properties": { "notes": { "minLength": 10, "type": "string" }, "versionId": { "type": "string" } }, "required": [ "notes", "versionId" ], "type": "object" }, "VersionRevert": { "properties": { "notes": { "minLength": 10, "type": "string" }, "versionId": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "id": { "type": "string" }, "landscapeId": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/AuthType" }, "updatedById": { "type": "string" } }, "required": [ "notes", "versionId", "createdAt", "createdBy", "createdById", "id", "landscapeId", "updatedAt", "updatedBy", "updatedById" ], "type": "object" }, "WebhookEventCollection": { "enum": [ "adr", "domain", "model-connection", "model-object" ], "type": "string" }, "WebhookEventOperation": { "enum": [ "created", "deleted", "updated" ], "type": "string" }, "WebhookEventType": { "enum": [ "adr:created", "adr:deleted", "adr:updated", "domain:created", "domain:deleted", "domain:updated", "model-connection:created", "model-connection:deleted", "model-connection:updated", "model-object:created", "model-object:deleted", "model-object:updated" ], "type": "string" }, "WebhookEvent": { "properties": { "collection": { "$ref": "#/components/schemas/WebhookEventCollection" }, "createdAt": { "format": "date-time", "type": "string" }, "operation": { "$ref": "#/components/schemas/WebhookEventOperation" }, "organizationId": { "type": "string" }, "resourceId": { "type": "string" }, "subscriptionId": { "type": "string" } }, "required": [ "createdAt", "operation", "collection", "organizationId", "subscriptionId", "resourceId" ], "type": "object" }, "WebhookSubscriptionPartial": { "properties": { "enabled": { "type": "boolean" }, "name": { "maxLength": 100, "minLength": 1, "type": "string" } }, "type": "object" }, "WebhookSubscriptionRequired": { "properties": { "enabled": { "type": "boolean" }, "name": { "maxLength": 100, "minLength": 1, "type": "string" }, "url": { "type": "string" } }, "required": [ "name", "url" ], "type": "object" }, "WebhookSubscription": { "properties": { "enabled": { "type": "boolean" }, "name": { "maxLength": 100, "minLength": 1, "type": "string" }, "url": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/AuthType" }, "createdById": { "type": "string" }, "id": { "type": "string" }, "organizationId": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/AuthType" }, "updatedById": { "type": "string" } }, "required": [ "name", "url", "createdAt", "createdBy", "createdById", "enabled", "id", "organizationId", "updatedAt", "updatedBy", "updatedById" ], "type": "object" }, "PubSubEditorLocation": { "properties": { "location": { "$ref": "#/components/schemas/EditorLocation" }, "socketId": { "type": "string" }, "type": { "enum": [ "added", "modified" ], "type": "string" } }, "required": [ "location", "socketId", "type" ], "type": "object" }, "PubSubEditorTyping": { "properties": { "socketId": { "type": "string" }, "type": { "enum": [ "added", "modified" ], "type": "string" }, "typing": { "$ref": "#/components/schemas/EditorTyping" } }, "required": [ "socketId", "type", "typing" ], "type": "object" }, "SocketClientEvents": { "allOf": [ { "$ref": "#/components/schemas/SocketClientAdrsEvents" }, { "$ref": "#/components/schemas/SocketClientCommentEvents" }, { "$ref": "#/components/schemas/SocketClientDiagramEvents" }, { "$ref": "#/components/schemas/SocketClientDraftEvents" }, { "$ref": "#/components/schemas/SocketClientDomainEvents" }, { "$ref": "#/components/schemas/SocketClientEditorEvents" }, { "$ref": "#/components/schemas/SocketClientFlowEvents" }, { "$ref": "#/components/schemas/SocketClientLandscapeEvents" }, { "$ref": "#/components/schemas/SocketClientModelEvents" }, { "$ref": "#/components/schemas/SocketClientTagEvents" }, { "$ref": "#/components/schemas/SocketClientVersionEvents" } ] }, "SocketServerEvents": { "allOf": [ { "$ref": "#/components/schemas/SocketServerAdrsEvents" }, { "$ref": "#/components/schemas/SocketServerCommentEvents" }, { "$ref": "#/components/schemas/SocketServerDiagramEvents" }, { "$ref": "#/components/schemas/SocketServerDraftEvents" }, { "$ref": "#/components/schemas/SocketServerDomainEvents" }, { "$ref": "#/components/schemas/SocketServerEditorEvents" }, { "$ref": "#/components/schemas/SocketServerFlowEvents" }, { "$ref": "#/components/schemas/SocketServerLandscapeEvents" }, { "$ref": "#/components/schemas/SocketServerModelEvents" }, { "$ref": "#/components/schemas/SocketServerTagEvents" }, { "$ref": "#/components/schemas/SocketServerVersionEvents" } ] }, "SocketMessages": { "properties": { "DiagramContentBroadcast": { "$ref": "#/components/schemas/SocketMessageDiagramContentBroadcast" }, "DiagramContentClientSubscribe": { "$ref": "#/components/schemas/SocketMessageDiagramContentClientSubscribe" }, "DiagramContentClientUnsubscribe": { "$ref": "#/components/schemas/SocketMessageDiagramContentClientUnsubscribe" } }, "required": [ "DiagramContentBroadcast", "DiagramContentClientSubscribe", "DiagramContentClientUnsubscribe" ], "type": "object" }, "SocketMessageType": { "enum": [ "DiagramContentBroadcast", "DiagramContentClientSubscribe", "DiagramContentClientUnsubscribe" ], "type": "string" }, "SocketClientAdrsListBody": { "properties": { "batchSize": { "default": 1000, "maximum": 10000, "minimum": 1, "type": "number" }, "landscapeId": { "type": "string" }, "stream": { "type": "boolean" }, "versionId": { "type": "string" } }, "required": [ "landscapeId", "versionId" ], "type": "object" }, "SocketClientAdrsListReply": { "properties": { "adrs": { "items": { "$ref": "#/components/schemas/ADR" }, "type": "array" }, "requestId": { "type": "string" } }, "required": [ "adrs", "requestId" ], "type": "object" }, "SocketClientAdrsSubscribeBody": { "properties": { "initialValue": { "type": "boolean" }, "landscapeId": { "type": "string" }, "versionId": { "type": "string" } }, "required": [ "landscapeId", "versionId" ], "type": "object" }, "SocketClientAdrsSubscribeReply": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientAdrsUnsubscribeBody": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientAdrsEvents": { "properties": { "adrs-list": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientAdrsListBody" }, "reply": { "$ref": "#/components/schemas/SocketClientAdrsListReply" } }, "required": [ "body", "reply" ], "type": "object" }, "adrs-subscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientAdrsSubscribeBody" }, "reply": { "$ref": "#/components/schemas/SocketClientAdrsSubscribeReply" } }, "required": [ "body", "reply" ], "type": "object" }, "adrs-unsubscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientAdrsUnsubscribeBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" } }, "required": [ "adrs-list", "adrs-subscribe", "adrs-unsubscribe" ], "type": "object" }, "SocketServerAdrsListStreamBody": { "properties": { "adrs": { "items": { "$ref": "#/components/schemas/ADR" }, "type": "array" }, "lastBatch": { "type": "boolean" }, "requestId": { "type": "string" } }, "required": [ "adrs", "lastBatch", "requestId" ], "type": "object" }, "SocketServerAdrInitialValueBody": { "properties": { "adrs": { "items": { "$ref": "#/components/schemas/ADR" }, "type": "array" }, "finalValue": { "type": "boolean" }, "subscriptionId": { "type": "string" } }, "required": [ "adrs", "finalValue", "subscriptionId" ], "type": "object" }, "SocketServerAdrAddedBody": { "properties": { "adr": { "$ref": "#/components/schemas/ADR" }, "subscriptionId": { "type": "string" } }, "required": [ "adr", "subscriptionId" ], "type": "object" }, "SocketServerAdrModifiedBody": { "properties": { "adr": { "$ref": "#/components/schemas/ADR" }, "subscriptionId": { "type": "string" } }, "required": [ "adr", "subscriptionId" ], "type": "object" }, "SocketServerAdrRemovedBody": { "properties": { "adr": { "$ref": "#/components/schemas/ADR" }, "subscriptionId": { "type": "string" } }, "required": [ "adr", "subscriptionId" ], "type": "object" }, "SocketServerAdrsEvents": { "properties": { "adr-added": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerAdrAddedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "adr-initial-value": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerAdrInitialValueBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "adr-modified": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerAdrModifiedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "adr-removed": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerAdrRemovedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "adrs-list-stream": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerAdrsListStreamBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" } }, "required": [ "adr-added", "adr-initial-value", "adr-modified", "adr-removed", "adrs-list-stream" ], "type": "object" }, "SocketClientCommentsListBody": { "properties": { "batchSize": { "default": 1000, "maximum": 10000, "minimum": 1, "type": "number" }, "landscapeId": { "type": "string" }, "stream": { "type": "boolean" }, "versionId": { "type": "string" } }, "required": [ "landscapeId", "versionId" ], "type": "object" }, "SocketClientCommentsListReply": { "properties": { "comments": { "items": { "$ref": "#/components/schemas/Comment" }, "type": "array" }, "requestId": { "type": "string" } }, "required": [ "comments", "requestId" ], "type": "object" }, "SocketClientCommentsReplyListBody": { "properties": { "batchSize": { "default": 1000, "maximum": 10000, "minimum": 1, "type": "number" }, "landscapeId": { "type": "string" }, "stream": { "type": "boolean" }, "versionId": { "type": "string" } }, "required": [ "landscapeId", "versionId" ], "type": "object" }, "SocketClientCommentsReplyListReply": { "properties": { "commentReplies": { "items": { "$ref": "#/components/schemas/CommentReply" }, "type": "array" }, "requestId": { "type": "string" } }, "required": [ "commentReplies", "requestId" ], "type": "object" }, "SocketClientCommentsSubscribeBody": { "properties": { "initialValue": { "type": "boolean" }, "landscapeId": { "type": "string" }, "status": { "items": { "$ref": "#/components/schemas/CommentBodyStatus" }, "type": "array" }, "versionId": { "type": "string" } }, "required": [ "landscapeId", "versionId" ], "type": "object" }, "SocketClientCommentsReplySubscribeBody": { "properties": { "initialValue": { "type": "boolean" }, "landscapeId": { "type": "string" }, "versionId": { "type": "string" } }, "required": [ "landscapeId", "versionId" ], "type": "object" }, "SocketClientCommentsSubscribeReply": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientCommentsReplySubscribeReply": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientCommentsUnsubscribeBody": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientCommentsReplyUnsubscribeBody": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientCommentEvents": { "properties": { "comments-list": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientCommentsListBody" }, "reply": { "$ref": "#/components/schemas/SocketClientCommentsListReply" } }, "required": [ "body", "reply" ], "type": "object" }, "comments-reply-list": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientCommentsReplyListBody" }, "reply": { "$ref": "#/components/schemas/SocketClientCommentsReplyListReply" } }, "required": [ "body", "reply" ], "type": "object" }, "comments-reply-subscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientCommentsReplySubscribeBody" }, "reply": { "$ref": "#/components/schemas/SocketClientCommentsReplySubscribeReply" } }, "required": [ "body", "reply" ], "type": "object" }, "comments-reply-unsubscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientCommentsReplyUnsubscribeBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "comments-subscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientCommentsSubscribeBody" }, "reply": { "$ref": "#/components/schemas/SocketClientCommentsSubscribeReply" } }, "required": [ "body", "reply" ], "type": "object" }, "comments-unsubscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientCommentsUnsubscribeBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" } }, "required": [ "comments-list", "comments-reply-list", "comments-reply-subscribe", "comments-reply-unsubscribe", "comments-subscribe", "comments-unsubscribe" ], "type": "object" }, "SocketServerCommentsListStreamBody": { "properties": { "comments": { "items": { "$ref": "#/components/schemas/Comment" }, "type": "array" }, "lastBatch": { "type": "boolean" }, "requestId": { "type": "string" } }, "required": [ "comments", "lastBatch", "requestId" ], "type": "object" }, "SocketServerCommentsReplyListStreamBody": { "properties": { "commentReplies": { "items": { "$ref": "#/components/schemas/CommentReply" }, "type": "array" }, "lastBatch": { "type": "boolean" }, "requestId": { "type": "string" } }, "required": [ "commentReplies", "lastBatch", "requestId" ], "type": "object" }, "SocketServerCommentInitialValueBody": { "properties": { "comments": { "items": { "$ref": "#/components/schemas/Comment" }, "type": "array" }, "finalValue": { "type": "boolean" }, "subscriptionId": { "type": "string" } }, "required": [ "comments", "finalValue", "subscriptionId" ], "type": "object" }, "SocketServerCommentReplyInitialValueBody": { "properties": { "commentReplies": { "items": { "$ref": "#/components/schemas/CommentReply" }, "type": "array" }, "finalValue": { "type": "boolean" }, "subscriptionId": { "type": "string" } }, "required": [ "commentReplies", "finalValue", "subscriptionId" ], "type": "object" }, "SocketServerCommentAddedBody": { "properties": { "comment": { "$ref": "#/components/schemas/Comment" }, "subscriptionId": { "type": "string" } }, "required": [ "comment", "subscriptionId" ], "type": "object" }, "SocketServerCommentReplyAddedBody": { "properties": { "commentReply": { "$ref": "#/components/schemas/CommentReply" }, "subscriptionId": { "type": "string" } }, "required": [ "commentReply", "subscriptionId" ], "type": "object" }, "SocketServerCommentModifiedBody": { "properties": { "comment": { "$ref": "#/components/schemas/Comment" }, "subscriptionId": { "type": "string" } }, "required": [ "comment", "subscriptionId" ], "type": "object" }, "SocketServerCommentReplyModifiedBody": { "properties": { "commentReply": { "$ref": "#/components/schemas/CommentReply" }, "subscriptionId": { "type": "string" } }, "required": [ "commentReply", "subscriptionId" ], "type": "object" }, "SocketServerCommentRemovedBody": { "properties": { "comment": { "$ref": "#/components/schemas/Comment" }, "subscriptionId": { "type": "string" } }, "required": [ "comment", "subscriptionId" ], "type": "object" }, "SocketServerCommentReplyRemovedBody": { "properties": { "commentReply": { "$ref": "#/components/schemas/CommentReply" }, "subscriptionId": { "type": "string" } }, "required": [ "commentReply", "subscriptionId" ], "type": "object" }, "SocketServerCommentEvents": { "properties": { "comment-added": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerCommentAddedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "comment-initial-value": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerCommentInitialValueBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "comment-modified": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerCommentModifiedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "comment-removed": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerCommentRemovedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "comment-reply-added": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerCommentReplyAddedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "comment-reply-initial-value": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerCommentReplyInitialValueBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "comment-reply-modified": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerCommentReplyModifiedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "comment-reply-removed": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerCommentReplyRemovedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "comments-list-stream": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerCommentsListStreamBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "comments-reply-list-stream": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerCommentsReplyListStreamBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" } }, "required": [ "comment-added", "comment-initial-value", "comment-modified", "comment-removed", "comment-reply-added", "comment-reply-initial-value", "comment-reply-modified", "comment-reply-removed", "comments-reply-list-stream", "comments-list-stream" ], "type": "object" }, "SocketClientDiagramsListBody": { "properties": { "batchSize": { "default": 1000, "maximum": 10000, "minimum": 1, "type": "number" }, "landscapeId": { "type": "string" }, "stream": { "type": "boolean" }, "versionId": { "type": "string" } }, "required": [ "landscapeId", "versionId" ], "type": "object" }, "SocketClientDiagramsListReply": { "properties": { "diagrams": { "items": { "$ref": "#/components/schemas/Diagram" }, "type": "array" }, "requestId": { "type": "string" } }, "required": [ "diagrams", "requestId" ], "type": "object" }, "SocketClientDiagramContentsListBody": { "properties": { "batchSize": { "default": 1000, "maximum": 10000, "minimum": 1, "type": "number" }, "landscapeId": { "type": "string" }, "stream": { "type": "boolean" }, "versionId": { "type": "string" } }, "required": [ "landscapeId", "versionId" ], "type": "object" }, "SocketClientDiagramContentsListReply": { "properties": { "diagramContents": { "items": { "$ref": "#/components/schemas/DiagramContent" }, "type": "array" }, "requestId": { "type": "string" } }, "required": [ "diagramContents", "requestId" ], "type": "object" }, "SocketClientDiagramGroupsListBody": { "properties": { "batchSize": { "default": 1000, "maximum": 10000, "minimum": 1, "type": "number" }, "landscapeId": { "type": "string" }, "stream": { "type": "boolean" }, "versionId": { "type": "string" } }, "required": [ "landscapeId", "versionId" ], "type": "object" }, "SocketClientDiagramGroupsListReply": { "properties": { "diagramGroups": { "items": { "$ref": "#/components/schemas/DiagramGroup" }, "type": "array" }, "requestId": { "type": "string" } }, "required": [ "diagramGroups", "requestId" ], "type": "object" }, "SocketClientDiagramsSubscribeBody": { "properties": { "initialValue": { "type": "boolean" }, "landscapeId": { "type": "string" }, "versionId": { "type": "string" } }, "required": [ "landscapeId", "versionId" ], "type": "object" }, "SocketClientDiagramsSubscribeReply": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientDiagramsUnsubscribeBody": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientDiagramContentsSubscribeReply": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientDiagramContentsUnsubscribeBody": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientDiagramContentsSubscribeBody": { "properties": { "filter": { "properties": { "afterViewedAtDate": { "type": "string" } }, "type": "object" }, "initialValue": { "type": "boolean" }, "landscapeId": { "type": "string" }, "versionId": { "type": "string" } }, "required": [ "landscapeId", "versionId" ], "type": "object" }, "SocketClientDiagramGroupsSubscribeBody": { "properties": { "initialValue": { "type": "boolean" }, "landscapeId": { "type": "string" }, "versionId": { "type": "string" } }, "required": [ "landscapeId", "versionId" ], "type": "object" }, "SocketClientDiagramGroupsSubscribeReply": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientDiagramGroupsUnsubscribeBody": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientDiagramEvents": { "properties": { "diagram-contents-list": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientDiagramContentsListBody" }, "reply": { "$ref": "#/components/schemas/SocketClientDiagramContentsListReply" } }, "required": [ "body", "reply" ], "type": "object" }, "diagram-contents-subscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientDiagramContentsSubscribeBody" }, "reply": { "$ref": "#/components/schemas/SocketClientDiagramContentsSubscribeReply" } }, "required": [ "body", "reply" ], "type": "object" }, "diagram-contents-unsubscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientDiagramContentsUnsubscribeBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "diagram-groups-list": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientDiagramGroupsListBody" }, "reply": { "$ref": "#/components/schemas/SocketClientDiagramGroupsListReply" } }, "required": [ "body", "reply" ], "type": "object" }, "diagram-groups-subscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientDiagramGroupsSubscribeBody" }, "reply": { "$ref": "#/components/schemas/SocketClientDiagramGroupsSubscribeReply" } }, "required": [ "body", "reply" ], "type": "object" }, "diagram-groups-unsubscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientDiagramGroupsUnsubscribeBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "diagrams-list": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientDiagramsListBody" }, "reply": { "$ref": "#/components/schemas/SocketClientDiagramsListReply" } }, "required": [ "body", "reply" ], "type": "object" }, "diagrams-subscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientDiagramsSubscribeBody" }, "reply": { "$ref": "#/components/schemas/SocketClientDiagramsSubscribeReply" } }, "required": [ "body", "reply" ], "type": "object" }, "diagrams-unsubscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientDiagramsUnsubscribeBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" } }, "required": [ "diagram-contents-list", "diagram-contents-subscribe", "diagram-contents-unsubscribe", "diagram-groups-list", "diagram-groups-subscribe", "diagram-groups-unsubscribe", "diagrams-list", "diagrams-subscribe", "diagrams-unsubscribe" ], "type": "object" }, "SocketServerDiagramsListStreamBody": { "properties": { "diagrams": { "items": { "$ref": "#/components/schemas/Diagram" }, "type": "array" }, "lastBatch": { "type": "boolean" }, "requestId": { "type": "string" } }, "required": [ "diagrams", "lastBatch", "requestId" ], "type": "object" }, "SocketServerDiagramContentsListStreamBody": { "properties": { "diagramContents": { "items": { "$ref": "#/components/schemas/DiagramContent" }, "type": "array" }, "lastBatch": { "type": "boolean" }, "requestId": { "type": "string" } }, "required": [ "diagramContents", "lastBatch", "requestId" ], "type": "object" }, "SocketServerDiagramGroupsListStreamBody": { "properties": { "diagramGroups": { "items": { "$ref": "#/components/schemas/DiagramGroup" }, "type": "array" }, "lastBatch": { "type": "boolean" }, "requestId": { "type": "string" } }, "required": [ "diagramGroups", "lastBatch", "requestId" ], "type": "object" }, "SocketServerDiagramInitialValueBody": { "properties": { "diagrams": { "items": { "$ref": "#/components/schemas/Diagram" }, "type": "array" }, "finalValue": { "type": "boolean" }, "subscriptionId": { "type": "string" } }, "required": [ "finalValue", "diagrams", "subscriptionId" ], "type": "object" }, "SocketServerDiagramAddedBody": { "properties": { "diagram": { "$ref": "#/components/schemas/Diagram" }, "subscriptionId": { "type": "string" } }, "required": [ "diagram", "subscriptionId" ], "type": "object" }, "SocketServerDiagramModifiedBody": { "properties": { "diagram": { "$ref": "#/components/schemas/Diagram" }, "subscriptionId": { "type": "string" } }, "required": [ "diagram", "subscriptionId" ], "type": "object" }, "SocketServerDiagramRemovedBody": { "properties": { "diagram": { "$ref": "#/components/schemas/Diagram" }, "subscriptionId": { "type": "string" } }, "required": [ "diagram", "subscriptionId" ], "type": "object" }, "SocketServerDiagramContentInitialValueBody": { "properties": { "diagramContents": { "items": { "$ref": "#/components/schemas/DiagramContent" }, "type": "array" }, "finalValue": { "type": "boolean" }, "subscriptionId": { "type": "string" } }, "required": [ "diagramContents", "finalValue", "subscriptionId" ], "type": "object" }, "SocketServerDiagramContentAddedBody": { "properties": { "diagramContent": { "$ref": "#/components/schemas/DiagramContent" }, "subscriptionId": { "type": "string" } }, "required": [ "diagramContent", "subscriptionId" ], "type": "object" }, "SocketServerDiagramContentModifiedBody": { "properties": { "diagramContent": { "$ref": "#/components/schemas/DiagramContent" }, "subscriptionId": { "type": "string" } }, "required": [ "diagramContent", "subscriptionId" ], "type": "object" }, "SocketServerDiagramContentRemovedBody": { "properties": { "diagramContent": { "$ref": "#/components/schemas/DiagramContent" }, "subscriptionId": { "type": "string" } }, "required": [ "diagramContent", "subscriptionId" ], "type": "object" }, "SocketServerDiagramGroupInitialValueBody": { "properties": { "diagramGroups": { "items": { "$ref": "#/components/schemas/DiagramGroup" }, "type": "array" }, "finalValue": { "type": "boolean" }, "subscriptionId": { "type": "string" } }, "required": [ "diagramGroups", "finalValue", "subscriptionId" ], "type": "object" }, "SocketServerDiagramGroupAddedBody": { "properties": { "diagramGroup": { "$ref": "#/components/schemas/DiagramGroup" }, "subscriptionId": { "type": "string" } }, "required": [ "diagramGroup", "subscriptionId" ], "type": "object" }, "SocketServerDiagramGroupModifiedBody": { "properties": { "diagramGroup": { "$ref": "#/components/schemas/DiagramGroup" }, "subscriptionId": { "type": "string" } }, "required": [ "diagramGroup", "subscriptionId" ], "type": "object" }, "SocketServerDiagramGroupRemovedBody": { "properties": { "diagramGroup": { "$ref": "#/components/schemas/DiagramGroup" }, "subscriptionId": { "type": "string" } }, "required": [ "diagramGroup", "subscriptionId" ], "type": "object" }, "SocketServerDiagramEvents": { "properties": { "diagram-added": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerDiagramAddedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "diagram-content-added": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerDiagramContentAddedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "diagram-content-initial-value": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerDiagramContentInitialValueBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "diagram-content-modified": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerDiagramContentModifiedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "diagram-content-removed": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerDiagramContentRemovedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "diagram-contents-list-stream": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerDiagramContentsListStreamBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "diagram-group-added": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerDiagramGroupAddedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "diagram-group-initial-value": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerDiagramGroupInitialValueBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "diagram-group-modified": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerDiagramGroupModifiedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "diagram-group-removed": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerDiagramGroupRemovedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "diagram-groups-list-stream": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerDiagramGroupsListStreamBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "diagram-initial-value": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerDiagramInitialValueBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "diagram-modified": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerDiagramModifiedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "diagram-removed": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerDiagramRemovedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "diagrams-list-stream": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerDiagramsListStreamBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" } }, "required": [ "diagram-added", "diagram-content-added", "diagram-content-initial-value", "diagram-content-modified", "diagram-content-removed", "diagram-contents-list-stream", "diagram-group-added", "diagram-group-initial-value", "diagram-group-modified", "diagram-group-removed", "diagram-groups-list-stream", "diagram-initial-value", "diagram-modified", "diagram-removed", "diagrams-list-stream" ], "type": "object" }, "SocketDiagramContentClientSubscription": { "properties": { "diagramId": { "format": "id", "type": "string" }, "landscapeId": { "format": "id", "type": "string" }, "versionId": { "format": "id", "type": "string" } }, "required": [ "landscapeId", "versionId", "diagramId" ], "type": "object" }, "SocketMessageDiagramContentClientSubscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketDiagramContentClientSubscription" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "SocketMessageDiagramContentClientUnsubscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketDiagramContentClientSubscription" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "SocketDiagramContentClientEventName": { "enum": [ "diagram-content-subscribe", "diagram-content-unsubscribe" ], "type": "string" }, "SocketDiagramContentClientEvents": { "properties": { "diagram-content-subscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketDiagramContentClientSubscription" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "diagram-content-unsubscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketDiagramContentClientSubscription" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" } }, "required": [ "diagram-content-subscribe", "diagram-content-unsubscribe" ], "type": "object" }, "SocketMessageDiagramContentBroadcast": { "properties": { "body": { "properties": { "diagramContent": { "$ref": "#/components/schemas/DiagramContent" }, "id": { "format": "id", "type": "string" }, "type": { "$ref": "#/components/schemas/DocumentBroadcastType" } }, "required": [ "diagramContent", "id", "type" ], "type": "object" } }, "required": [ "body" ], "type": "object" }, "SocketDiagramContentServerEventName": { "enum": [ "diagram-content-broadcast" ], "type": "string" }, "SocketDiagramContentServerEvents": { "properties": { "diagram-content-broadcast": { "properties": { "body": { "properties": { "diagramContent": { "$ref": "#/components/schemas/DiagramContent" }, "id": { "format": "id", "type": "string" }, "type": { "$ref": "#/components/schemas/DocumentBroadcastType" } }, "required": [ "diagramContent", "id", "type" ], "type": "object" } }, "required": [ "body" ], "type": "object" } }, "required": [ "diagram-content-broadcast" ], "type": "object" }, "SocketClientDomainsListBody": { "properties": { "batchSize": { "default": 1000, "maximum": 10000, "minimum": 1, "type": "number" }, "landscapeId": { "type": "string" }, "stream": { "type": "boolean" }, "versionId": { "type": "string" } }, "required": [ "landscapeId", "versionId" ], "type": "object" }, "SocketClientDomainsListReply": { "properties": { "domains": { "items": { "$ref": "#/components/schemas/Domain" }, "type": "array" }, "requestId": { "type": "string" } }, "required": [ "domains", "requestId" ], "type": "object" }, "SocketClientDomainsSubscribeBody": { "properties": { "initialValue": { "type": "boolean" }, "landscapeId": { "type": "string" }, "versionId": { "type": "string" } }, "required": [ "landscapeId", "versionId" ], "type": "object" }, "SocketClientDomainsSubscribeReply": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientDomainsUnsubscribeBody": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientDomainEvents": { "properties": { "domains-list": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientDomainsListBody" }, "reply": { "$ref": "#/components/schemas/SocketClientDomainsListReply" } }, "required": [ "body", "reply" ], "type": "object" }, "domains-subscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientDomainsSubscribeBody" }, "reply": { "$ref": "#/components/schemas/SocketClientDomainsSubscribeReply" } }, "required": [ "body", "reply" ], "type": "object" }, "domains-unsubscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientDomainsUnsubscribeBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" } }, "required": [ "domains-list", "domains-subscribe", "domains-unsubscribe" ], "type": "object" }, "SocketServerDomainsListStreamBody": { "properties": { "domains": { "items": { "$ref": "#/components/schemas/Domain" }, "type": "array" }, "lastBatch": { "type": "boolean" }, "requestId": { "type": "string" } }, "required": [ "domains", "lastBatch", "requestId" ], "type": "object" }, "SocketServerDomainInitialValueBody": { "properties": { "domains": { "items": { "$ref": "#/components/schemas/Domain" }, "type": "array" }, "finalValue": { "type": "boolean" }, "subscriptionId": { "type": "string" } }, "required": [ "domains", "finalValue", "subscriptionId" ], "type": "object" }, "SocketServerDomainAddedBody": { "properties": { "domain": { "$ref": "#/components/schemas/Domain" }, "subscriptionId": { "type": "string" } }, "required": [ "domain", "subscriptionId" ], "type": "object" }, "SocketServerDomainModifiedBody": { "properties": { "domain": { "$ref": "#/components/schemas/Domain" }, "subscriptionId": { "type": "string" } }, "required": [ "domain", "subscriptionId" ], "type": "object" }, "SocketServerDomainRemovedBody": { "properties": { "domain": { "$ref": "#/components/schemas/Domain" }, "subscriptionId": { "type": "string" } }, "required": [ "domain", "subscriptionId" ], "type": "object" }, "SocketServerDomainEvents": { "properties": { "domain-added": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerDomainAddedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "domain-initial-value": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerDomainInitialValueBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "domain-modified": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerDomainModifiedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "domain-removed": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerDomainRemovedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "domains-list-stream": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerDomainsListStreamBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" } }, "required": [ "domain-added", "domain-initial-value", "domain-modified", "domain-removed", "domains-list-stream" ], "type": "object" }, "SocketClientDraftsListBody": { "properties": { "batchSize": { "default": 1000, "maximum": 10000, "minimum": 1, "type": "number" }, "landscapeId": { "type": "string" }, "stream": { "type": "boolean" }, "versionId": { "type": "string" } }, "required": [ "landscapeId", "versionId" ], "type": "object" }, "SocketClientDraftsListReply": { "properties": { "drafts": { "items": { "$ref": "#/components/schemas/Draft" }, "type": "array" }, "requestId": { "type": "string" } }, "required": [ "drafts", "requestId" ], "type": "object" }, "SocketClientDraftsSubscribeBody": { "properties": { "initialValue": { "type": "boolean" }, "landscapeId": { "type": "string" }, "versionId": { "type": "string" } }, "required": [ "landscapeId", "versionId" ], "type": "object" }, "SocketClientDraftsSubscribeReply": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientDraftsUnsubscribeBody": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientDraftEvents": { "properties": { "drafts-list": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientDraftsListBody" }, "reply": { "$ref": "#/components/schemas/SocketClientDraftsListReply" } }, "required": [ "body", "reply" ], "type": "object" }, "drafts-subscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientDraftsSubscribeBody" }, "reply": { "$ref": "#/components/schemas/SocketClientDraftsSubscribeReply" } }, "required": [ "body", "reply" ], "type": "object" }, "drafts-unsubscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientDraftsUnsubscribeBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" } }, "required": [ "drafts-list", "drafts-subscribe", "drafts-unsubscribe" ], "type": "object" }, "SocketServerDraftsListStreamBody": { "properties": { "drafts": { "items": { "$ref": "#/components/schemas/Draft" }, "type": "array" }, "lastBatch": { "type": "boolean" }, "requestId": { "type": "string" } }, "required": [ "drafts", "lastBatch", "requestId" ], "type": "object" }, "SocketServerDraftInitialValueBody": { "properties": { "draftTasks": { "items": { "$ref": "#/components/schemas/DraftTaskJson" }, "type": "array" }, "drafts": { "items": { "$ref": "#/components/schemas/Draft" }, "type": "array" }, "finalValue": { "type": "boolean" }, "subscriptionId": { "type": "string" } }, "required": [ "draftTasks", "drafts", "finalValue", "subscriptionId" ], "type": "object" }, "SocketServerDraftAddedBody": { "properties": { "draft": { "$ref": "#/components/schemas/Draft" }, "subscriptionId": { "type": "string" } }, "required": [ "draft", "subscriptionId" ], "type": "object" }, "SocketServerDraftTaskAddedBody": { "properties": { "draftTask": { "$ref": "#/components/schemas/DraftTaskJson" }, "subscriptionId": { "type": "string" } }, "required": [ "draftTask", "subscriptionId" ], "type": "object" }, "SocketServerDraftModifiedBody": { "properties": { "draft": { "$ref": "#/components/schemas/Draft" }, "subscriptionId": { "type": "string" } }, "required": [ "draft", "subscriptionId" ], "type": "object" }, "SocketServerDraftRemovedBody": { "properties": { "draft": { "$ref": "#/components/schemas/Draft" }, "subscriptionId": { "type": "string" } }, "required": [ "draft", "subscriptionId" ], "type": "object" }, "SocketServerDraftEvents": { "properties": { "draft-added": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerDraftAddedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "draft-initial-value": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerDraftInitialValueBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "draft-modified": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerDraftModifiedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "draft-removed": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerDraftRemovedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "draft-task-added": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerDraftTaskAddedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "drafts-list-stream": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerDraftsListStreamBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" } }, "required": [ "draft-added", "draft-initial-value", "draft-modified", "draft-removed", "draft-task-added", "drafts-list-stream" ], "type": "object" }, "SocketClientEditorLocationUpdateBody": { "properties": { "landscapeId": { "type": "string" }, "location": { "$ref": "#/components/schemas/EditorLocationUpdate" } }, "required": [ "landscapeId", "location" ], "type": "object" }, "SocketClientEditorTypingUpdateBody": { "properties": { "landscapeId": { "type": "string" }, "typing": { "$ref": "#/components/schemas/EditorTypingUpdate" } }, "required": [ "landscapeId", "typing" ], "type": "object" }, "SocketClientEditorSubscribeBody": { "properties": { "landscapeId": { "type": "string" } }, "required": [ "landscapeId" ], "type": "object" }, "SocketClientEditorSubscribeReply": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientEditorUnsubscribeBody": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientEditorEvents": { "properties": { "editor-location-update": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientEditorLocationUpdateBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "editor-subscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientEditorSubscribeBody" }, "reply": { "$ref": "#/components/schemas/SocketClientEditorSubscribeReply" } }, "required": [ "body", "reply" ], "type": "object" }, "editor-typing-update": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientEditorTypingUpdateBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "editor-unsubscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientEditorUnsubscribeBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" } }, "required": [ "editor-location-update", "editor-subscribe", "editor-typing-update", "editor-unsubscribe" ], "type": "object" }, "SocketServerEditorLocationAddedBody": { "properties": { "location": { "$ref": "#/components/schemas/EditorLocation" }, "subscriptionId": { "type": "string" } }, "required": [ "location", "subscriptionId" ], "type": "object" }, "SocketServerEditorLocationModifiedBody": { "properties": { "location": { "$ref": "#/components/schemas/EditorLocation" }, "subscriptionId": { "type": "string" } }, "required": [ "location", "subscriptionId" ], "type": "object" }, "SocketServerEditorLocationsBody": { "properties": { "locations": { "items": { "$ref": "#/components/schemas/EditorLocation" }, "type": "array" }, "subscriptionId": { "type": "string" } }, "required": [ "locations", "subscriptionId" ], "type": "object" }, "SocketServerEditorTypingAddedBody": { "properties": { "subscriptionId": { "type": "string" }, "typing": { "$ref": "#/components/schemas/EditorTyping" } }, "required": [ "subscriptionId", "typing" ], "type": "object" }, "SocketServerEditorTypingModifiedBody": { "properties": { "subscriptionId": { "type": "string" }, "typing": { "$ref": "#/components/schemas/EditorTyping" } }, "required": [ "subscriptionId", "typing" ], "type": "object" }, "SocketServerEditorTypingBody": { "properties": { "subscriptionId": { "type": "string" }, "typing": { "items": { "$ref": "#/components/schemas/EditorTyping" }, "type": "array" } }, "required": [ "subscriptionId", "typing" ], "type": "object" }, "SocketServerEditorEvents": { "properties": { "editor-location-added": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerEditorLocationAddedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "editor-location-modified": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerEditorLocationModifiedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "editor-locations": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerEditorLocationsBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "editor-typing": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerEditorTypingBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "editor-typing-added": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerEditorTypingAddedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "editor-typing-modified": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerEditorTypingModifiedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" } }, "required": [ "editor-location-added", "editor-location-modified", "editor-locations", "editor-typing-added", "editor-typing-modified", "editor-typing" ], "type": "object" }, "SocketClientFlowsListBody": { "properties": { "batchSize": { "default": 1000, "maximum": 10000, "minimum": 1, "type": "number" }, "landscapeId": { "type": "string" }, "stream": { "type": "boolean" }, "versionId": { "type": "string" } }, "required": [ "landscapeId", "versionId" ], "type": "object" }, "SocketClientFlowsListReply": { "properties": { "flows": { "items": { "$ref": "#/components/schemas/Flow" }, "type": "array" }, "requestId": { "type": "string" } }, "required": [ "flows", "requestId" ], "type": "object" }, "SocketClientFlowsSubscribeBody": { "properties": { "initialValue": { "type": "boolean" }, "landscapeId": { "type": "string" }, "versionId": { "type": "string" } }, "required": [ "landscapeId", "versionId" ], "type": "object" }, "SocketClientFlowsSubscribeReply": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientFlowsUnsubscribeBody": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientFlowEvents": { "properties": { "flows-list": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientFlowsListBody" }, "reply": { "$ref": "#/components/schemas/SocketClientFlowsListReply" } }, "required": [ "body", "reply" ], "type": "object" }, "flows-subscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientFlowsSubscribeBody" }, "reply": { "$ref": "#/components/schemas/SocketClientFlowsSubscribeReply" } }, "required": [ "body", "reply" ], "type": "object" }, "flows-unsubscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientFlowsUnsubscribeBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" } }, "required": [ "flows-list", "flows-subscribe", "flows-unsubscribe" ], "type": "object" }, "SocketServerFlowsListStreamBody": { "properties": { "flows": { "items": { "$ref": "#/components/schemas/Flow" }, "type": "array" }, "lastBatch": { "type": "boolean" }, "requestId": { "type": "string" } }, "required": [ "flows", "lastBatch", "requestId" ], "type": "object" }, "SocketServerFlowInitialValueBody": { "properties": { "finalValue": { "type": "boolean" }, "flows": { "items": { "$ref": "#/components/schemas/Flow" }, "type": "array" }, "subscriptionId": { "type": "string" } }, "required": [ "finalValue", "flows", "subscriptionId" ], "type": "object" }, "SocketServerFlowAddedBody": { "properties": { "flow": { "$ref": "#/components/schemas/Flow" }, "subscriptionId": { "type": "string" } }, "required": [ "flow", "subscriptionId" ], "type": "object" }, "SocketServerFlowModifiedBody": { "properties": { "flow": { "$ref": "#/components/schemas/Flow" }, "subscriptionId": { "type": "string" } }, "required": [ "flow", "subscriptionId" ], "type": "object" }, "SocketServerFlowRemovedBody": { "properties": { "flow": { "$ref": "#/components/schemas/Flow" }, "subscriptionId": { "type": "string" } }, "required": [ "flow", "subscriptionId" ], "type": "object" }, "SocketServerFlowEvents": { "properties": { "flow-added": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerFlowAddedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "flow-initial-value": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerFlowInitialValueBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "flow-modified": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerFlowModifiedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "flow-removed": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerFlowRemovedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "flows-list-stream": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerFlowsListStreamBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" } }, "required": [ "flow-added", "flow-initial-value", "flow-modified", "flow-removed", "flows-list-stream" ], "type": "object" }, "SocketClientLandscapeSubscribeBody": { "properties": { "landscapeId": { "type": "string" } }, "required": [ "landscapeId" ], "type": "object" }, "SocketClientLandscapeSubscribeReply": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientLandscapeUnsubscribeBody": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientLandscapeEvents": { "properties": { "landscape-subscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientLandscapeSubscribeBody" }, "reply": { "$ref": "#/components/schemas/SocketClientLandscapeSubscribeReply" } }, "required": [ "body", "reply" ], "type": "object" }, "landscape-unsubscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientLandscapeUnsubscribeBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" } }, "required": [ "landscape-subscribe", "landscape-unsubscribe" ], "type": "object" }, "SocketServerLandscapeBody": { "properties": { "landscape": { "$ref": "#/components/schemas/LandscapeNullable" }, "subscriptionId": { "type": "string" } }, "required": [ "landscape", "subscriptionId" ], "type": "object" }, "SocketServerLandscapeEvents": { "properties": { "landscape": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerLandscapeBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" } }, "required": [ "landscape" ], "type": "object" }, "SocketClientModelObjectsListBody": { "properties": { "batchSize": { "default": 1000, "maximum": 10000, "minimum": 1, "type": "number" }, "landscapeId": { "type": "string" }, "stream": { "type": "boolean" }, "versionId": { "type": "string" } }, "required": [ "landscapeId", "versionId" ], "type": "object" }, "SocketClientModelObjectsListReply": { "properties": { "modelObjects": { "items": { "$ref": "#/components/schemas/ModelObject" }, "type": "array" }, "requestId": { "type": "string" } }, "required": [ "modelObjects", "requestId" ], "type": "object" }, "SocketClientModelConnectionsListBody": { "properties": { "batchSize": { "default": 1000, "maximum": 10000, "minimum": 1, "type": "number" }, "landscapeId": { "type": "string" }, "stream": { "type": "boolean" }, "versionId": { "type": "string" } }, "required": [ "landscapeId", "versionId" ], "type": "object" }, "SocketClientModelConnectionsListReply": { "properties": { "modelConnections": { "items": { "$ref": "#/components/schemas/ModelConnection" }, "type": "array" }, "requestId": { "type": "string" } }, "required": [ "modelConnections", "requestId" ], "type": "object" }, "SocketClientModelObjectsSubscribeBody": { "properties": { "initialValue": { "type": "boolean" }, "landscapeId": { "type": "string" }, "versionId": { "type": "string" } }, "required": [ "landscapeId", "versionId" ], "type": "object" }, "SocketClientModelObjectsSubscribeReply": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientModelObjectsUnsubscribeBody": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientModelConnectionsSubscribeBody": { "properties": { "initialValue": { "type": "boolean" }, "landscapeId": { "type": "string" }, "versionId": { "type": "string" } }, "required": [ "landscapeId", "versionId" ], "type": "object" }, "SocketClientModelConnectionsSubscribeReply": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientModelConnectionsUnsubscribeBody": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientModelEvents": { "properties": { "model-connections-list": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientModelConnectionsListBody" }, "reply": { "$ref": "#/components/schemas/SocketClientModelConnectionsListReply" } }, "required": [ "body", "reply" ], "type": "object" }, "model-connections-subscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientModelConnectionsSubscribeBody" }, "reply": { "$ref": "#/components/schemas/SocketClientModelConnectionsSubscribeReply" } }, "required": [ "body", "reply" ], "type": "object" }, "model-connections-unsubscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientModelConnectionsUnsubscribeBody" }, "reply": { "$ref": "#/components/schemas/SocketClientModelObjectsListReply" } }, "required": [ "body", "reply" ], "type": "object" }, "model-objects-list": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientModelObjectsListBody" }, "reply": { "$ref": "#/components/schemas/SocketClientModelObjectsListReply" } }, "required": [ "body", "reply" ], "type": "object" }, "model-objects-subscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientModelObjectsSubscribeBody" }, "reply": { "$ref": "#/components/schemas/SocketClientModelObjectsSubscribeReply" } }, "required": [ "body", "reply" ], "type": "object" }, "model-objects-unsubscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientModelObjectsUnsubscribeBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" } }, "required": [ "model-connections-list", "model-connections-subscribe", "model-connections-unsubscribe", "model-objects-list", "model-objects-subscribe", "model-objects-unsubscribe" ], "type": "object" }, "SocketServerModelObjectsListStreamBody": { "properties": { "lastBatch": { "type": "boolean" }, "modelObjects": { "items": { "$ref": "#/components/schemas/ModelObject" }, "type": "array" }, "requestId": { "type": "string" } }, "required": [ "modelObjects", "lastBatch", "requestId" ], "type": "object" }, "SocketServerModelConnectionsListStreamBody": { "properties": { "lastBatch": { "type": "boolean" }, "modelConnections": { "items": { "$ref": "#/components/schemas/ModelConnection" }, "type": "array" }, "requestId": { "type": "string" } }, "required": [ "modelConnections", "lastBatch", "requestId" ], "type": "object" }, "SocketServerModelObjectAddedBody": { "properties": { "modelObject": { "$ref": "#/components/schemas/ModelObject" }, "subscriptionId": { "type": "string" } }, "required": [ "modelObject", "subscriptionId" ], "type": "object" }, "SocketServerModelObjectModifiedBody": { "properties": { "modelObject": { "$ref": "#/components/schemas/ModelObject" }, "subscriptionId": { "type": "string" } }, "required": [ "modelObject", "subscriptionId" ], "type": "object" }, "SocketServerModelObjectRemovedBody": { "properties": { "modelObject": { "$ref": "#/components/schemas/ModelObject" }, "subscriptionId": { "type": "string" } }, "required": [ "modelObject", "subscriptionId" ], "type": "object" }, "SocketServerModelObjectInitialValueBody": { "properties": { "finalValue": { "type": "boolean" }, "modelObjects": { "items": { "$ref": "#/components/schemas/ModelObject" }, "type": "array" }, "subscriptionId": { "type": "string" } }, "required": [ "finalValue", "modelObjects", "subscriptionId" ], "type": "object" }, "SocketServerModelConnectionAddedBody": { "properties": { "modelConnection": { "$ref": "#/components/schemas/ModelConnection" }, "subscriptionId": { "type": "string" } }, "required": [ "modelConnection", "subscriptionId" ], "type": "object" }, "SocketServerModelConnectionModifiedBody": { "properties": { "modelConnection": { "$ref": "#/components/schemas/ModelConnection" }, "subscriptionId": { "type": "string" } }, "required": [ "modelConnection", "subscriptionId" ], "type": "object" }, "SocketServerModelConnectionRemovedBody": { "properties": { "modelConnection": { "$ref": "#/components/schemas/ModelConnection" }, "subscriptionId": { "type": "string" } }, "required": [ "modelConnection", "subscriptionId" ], "type": "object" }, "SocketServerModelConnectionInitialValueBody": { "properties": { "finalValue": { "type": "boolean" }, "modelConnections": { "items": { "$ref": "#/components/schemas/ModelConnection" }, "type": "array" }, "subscriptionId": { "type": "string" } }, "required": [ "finalValue", "modelConnections", "subscriptionId" ], "type": "object" }, "SocketServerModelEvents": { "properties": { "model-connection-added": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerModelConnectionAddedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "model-connection-initial-value": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerModelConnectionInitialValueBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "model-connection-modified": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerModelConnectionModifiedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "model-connection-removed": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerModelConnectionRemovedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "model-connections-list-stream": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerModelConnectionsListStreamBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "model-object-added": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerModelObjectAddedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "model-object-initial-value": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerModelObjectInitialValueBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "model-object-modified": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerModelObjectModifiedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "model-object-removed": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerModelObjectRemovedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "model-objects-list-stream": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerModelObjectsListStreamBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" } }, "required": [ "model-connection-added", "model-connection-initial-value", "model-connection-modified", "model-connection-removed", "model-connections-list-stream", "model-object-added", "model-object-initial-value", "model-object-modified", "model-object-removed", "model-objects-list-stream" ], "type": "object" }, "SocketClientTagsListBody": { "properties": { "batchSize": { "default": 1000, "maximum": 10000, "minimum": 1, "type": "number" }, "landscapeId": { "type": "string" }, "stream": { "type": "boolean" }, "versionId": { "type": "string" } }, "required": [ "landscapeId", "versionId" ], "type": "object" }, "SocketClientTagsListReply": { "properties": { "requestId": { "type": "string" }, "tags": { "items": { "$ref": "#/components/schemas/Tag" }, "type": "array" } }, "required": [ "requestId", "tags" ], "type": "object" }, "SocketClientTagGroupsListBody": { "properties": { "batchSize": { "default": 1000, "maximum": 10000, "minimum": 1, "type": "number" }, "landscapeId": { "type": "string" }, "stream": { "type": "boolean" }, "versionId": { "type": "string" } }, "required": [ "landscapeId", "versionId" ], "type": "object" }, "SocketClientTagGroupsListReply": { "properties": { "requestId": { "type": "string" }, "tagGroups": { "items": { "$ref": "#/components/schemas/TagGroup" }, "type": "array" } }, "required": [ "tagGroups" ], "type": "object" }, "SocketClientTagsSubscribeBody": { "properties": { "initialValue": { "type": "boolean" }, "landscapeId": { "type": "string" }, "versionId": { "type": "string" } }, "required": [ "landscapeId", "versionId" ], "type": "object" }, "SocketClientTagsSubscribeReply": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientTagsUnsubscribeBody": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientTagGroupsSubscribeBody": { "properties": { "initialValue": { "type": "boolean" }, "landscapeId": { "type": "string" }, "versionId": { "type": "string" } }, "required": [ "landscapeId", "versionId" ], "type": "object" }, "SocketClientTagGroupsSubscribeReply": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientTagGroupsUnsubscribeBody": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientTagEvents": { "properties": { "tag-groups-list": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientTagGroupsListBody" }, "reply": { "$ref": "#/components/schemas/SocketClientTagGroupsListReply" } }, "required": [ "body", "reply" ], "type": "object" }, "tag-groups-subscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientTagGroupsSubscribeBody" }, "reply": { "$ref": "#/components/schemas/SocketClientTagGroupsSubscribeReply" } }, "required": [ "body", "reply" ], "type": "object" }, "tag-groups-unsubscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientTagGroupsUnsubscribeBody" }, "reply": { "$ref": "#/components/schemas/SocketClientTagGroupsListReply" } }, "required": [ "body", "reply" ], "type": "object" }, "tags-list": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientTagsListBody" }, "reply": { "$ref": "#/components/schemas/SocketClientTagsListReply" } }, "required": [ "body", "reply" ], "type": "object" }, "tags-subscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientTagsSubscribeBody" }, "reply": { "$ref": "#/components/schemas/SocketClientTagsSubscribeReply" } }, "required": [ "body", "reply" ], "type": "object" }, "tags-unsubscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientTagsUnsubscribeBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" } }, "required": [ "tag-groups-list", "tag-groups-subscribe", "tag-groups-unsubscribe", "tags-list", "tags-subscribe", "tags-unsubscribe" ], "type": "object" }, "SocketServerTagGroupsListStreamBody": { "properties": { "lastBatch": { "type": "boolean" }, "requestId": { "type": "string" }, "tagGroups": { "items": { "$ref": "#/components/schemas/TagGroup" }, "type": "array" } }, "required": [ "tagGroups", "lastBatch", "requestId" ], "type": "object" }, "SocketServerTagsListStreamBody": { "properties": { "lastBatch": { "type": "boolean" }, "requestId": { "type": "string" }, "tags": { "items": { "$ref": "#/components/schemas/Tag" }, "type": "array" } }, "required": [ "tags", "lastBatch", "requestId" ], "type": "object" }, "SocketServerTagAddedBody": { "properties": { "subscriptionId": { "type": "string" }, "tag": { "$ref": "#/components/schemas/Tag" } }, "required": [ "subscriptionId", "tag" ], "type": "object" }, "SocketServerTagModifiedBody": { "properties": { "subscriptionId": { "type": "string" }, "tag": { "$ref": "#/components/schemas/Tag" } }, "required": [ "subscriptionId", "tag" ], "type": "object" }, "SocketServerTagRemovedBody": { "properties": { "subscriptionId": { "type": "string" }, "tag": { "$ref": "#/components/schemas/Tag" } }, "required": [ "subscriptionId", "tag" ], "type": "object" }, "SocketServerTagInitialValueBody": { "properties": { "finalValue": { "type": "boolean" }, "subscriptionId": { "type": "string" }, "tags": { "items": { "$ref": "#/components/schemas/Tag" }, "type": "array" } }, "required": [ "finalValue", "subscriptionId", "tags" ], "type": "object" }, "SocketServerTagGroupAddedBody": { "properties": { "subscriptionId": { "type": "string" }, "tagGroup": { "$ref": "#/components/schemas/TagGroup" } }, "required": [ "subscriptionId", "tagGroup" ], "type": "object" }, "SocketServerTagGroupModifiedBody": { "properties": { "subscriptionId": { "type": "string" }, "tagGroup": { "$ref": "#/components/schemas/TagGroup" } }, "required": [ "subscriptionId", "tagGroup" ], "type": "object" }, "SocketServerTagGroupRemovedBody": { "properties": { "subscriptionId": { "type": "string" }, "tagGroup": { "$ref": "#/components/schemas/TagGroup" } }, "required": [ "subscriptionId", "tagGroup" ], "type": "object" }, "SocketServerTagGroupInitialValueBody": { "properties": { "finalValue": { "type": "boolean" }, "subscriptionId": { "type": "string" }, "tagGroups": { "items": { "$ref": "#/components/schemas/TagGroup" }, "type": "array" } }, "required": [ "finalValue", "subscriptionId", "tagGroups" ], "type": "object" }, "SocketServerTagEvents": { "properties": { "tag-added": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerTagAddedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "tag-group-added": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerTagGroupAddedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "tag-group-initial-value": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerTagGroupInitialValueBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "tag-group-modified": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerTagGroupModifiedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "tag-group-removed": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerTagGroupRemovedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "tag-groups-list-stream": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerTagGroupsListStreamBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "tag-initial-value": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerTagInitialValueBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "tag-modified": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerTagModifiedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "tag-removed": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerTagRemovedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "tags-list-stream": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerTagsListStreamBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" } }, "required": [ "tag-added", "tag-group-added", "tag-group-initial-value", "tag-group-modified", "tag-group-removed", "tag-groups-list-stream", "tag-initial-value", "tag-modified", "tag-removed", "tags-list-stream" ], "type": "object" }, "SocketClientVersionsListBody": { "properties": { "landscapeId": { "type": "string" } }, "required": [ "landscapeId" ], "type": "object" }, "SocketClientVersionsListReply": { "properties": { "versions": { "items": { "$ref": "#/components/schemas/Version" }, "type": "array" } }, "required": [ "versions" ], "type": "object" }, "SocketClientVersionsSubscribeBody": { "properties": { "initialValue": { "type": "boolean" }, "landscapeId": { "type": "string" } }, "required": [ "landscapeId" ], "type": "object" }, "SocketClientVersionsSubscribeReply": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientVersionsUnsubscribeBody": { "properties": { "subscriptionId": { "type": "string" } }, "required": [ "subscriptionId" ], "type": "object" }, "SocketClientVersionEvents": { "properties": { "versions-list": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientVersionsListBody" }, "reply": { "$ref": "#/components/schemas/SocketClientVersionsListReply" } }, "required": [ "body", "reply" ], "type": "object" }, "versions-subscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientVersionsSubscribeBody" }, "reply": { "$ref": "#/components/schemas/SocketClientVersionsSubscribeReply" } }, "required": [ "body", "reply" ], "type": "object" }, "versions-unsubscribe": { "properties": { "body": { "$ref": "#/components/schemas/SocketClientVersionsUnsubscribeBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" } }, "required": [ "versions-list", "versions-subscribe", "versions-unsubscribe" ], "type": "object" }, "SocketServerVersionInitialValueBody": { "properties": { "finalValue": { "type": "boolean" }, "subscriptionId": { "type": "string" }, "versions": { "items": { "$ref": "#/components/schemas/Version" }, "type": "array" } }, "required": [ "finalValue", "subscriptionId", "versions" ], "type": "object" }, "SocketServerVersionAddedBody": { "properties": { "subscriptionId": { "type": "string" }, "version": { "$ref": "#/components/schemas/Version" } }, "required": [ "version", "subscriptionId" ], "type": "object" }, "SocketServerVersionModifiedBody": { "properties": { "subscriptionId": { "type": "string" }, "version": { "$ref": "#/components/schemas/Version" } }, "required": [ "version", "subscriptionId" ], "type": "object" }, "SocketServerVersionRemovedBody": { "properties": { "subscriptionId": { "type": "string" }, "version": { "$ref": "#/components/schemas/Version" } }, "required": [ "version", "subscriptionId" ], "type": "object" }, "SocketServerVersionEvents": { "properties": { "version-added": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerVersionAddedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "version-initial-value": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerVersionInitialValueBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "version-modified": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerVersionModifiedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" }, "version-removed": { "properties": { "body": { "$ref": "#/components/schemas/SocketServerVersionRemovedBody" }, "reply": { "type": "object" } }, "required": [ "body", "reply" ], "type": "object" } }, "required": [ "version-added", "version-initial-value", "version-modified", "version-removed" ], "type": "object" }, "AIDescriptionType": { "enum": [ "caption", "detailed" ], "type": "string" }, "AuthType": { "enum": [ "user", "api-key", "notification-key", "service" ], "type": "string" }, "PermissionType": { "enum": [ "billing", "read", "write", "admin" ], "type": "string" }, "EditorLocationUpdate": { "properties": { "diagramId": { "type": "string" }, "draftId": { "type": "string" }, "versionId": { "type": "string" } }, "type": "object" }, "EditorLocation": { "properties": { "diagramId": { "type": "string" }, "draftId": { "type": "string" }, "versionId": { "type": "string" }, "publishedAt": { "type": "number" }, "userId": { "type": "string" } }, "required": [ "publishedAt", "userId" ], "type": "object" }, "EditorTypingUpdate": { "properties": { "id": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "EditorTyping": { "properties": { "id": { "type": "string" }, "value": { "type": "string" }, "publishedAt": { "type": "number" }, "userId": { "type": "string" } }, "required": [ "publishedAt", "userId" ], "type": "object" }, "Error": { "properties": { "code": { "type": "string" }, "errors": { "items": { "type": "string" }, "type": "array" }, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" }, "TechnologyExport": { "properties": { "color": { "$ref": "#/components/schemas/TagColor" }, "description": { "type": "string" }, "docsUrl": { "type": "string" }, "iconUrl": { "deprecated": true, "description": "Use either iconUrlDark or iconUrlLight", "type": "string" }, "iconUrlDark": { "type": "string" }, "iconUrlLight": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "nameShort": { "type": "string" }, "provider": { "$ref": "#/components/schemas/CatalogProviderNullable" }, "type": { "$ref": "#/components/schemas/CatalogTechnologyTypeNullable" }, "updatesUrl": { "type": "string" }, "websiteUrl": { "type": "string" } }, "required": [ "color", "id", "name", "provider", "type" ], "type": "object" }, "DomainExport": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "FlowStepExport": { "properties": { "description": { "description": "Descriptive name for the flow step", "type": "string" }, "detailedDescription": { "description": "Long description for the flow step", "type": "string" }, "id": { "type": "string" }, "index": { "type": "number" }, "originId": { "type": "string" }, "targetId": { "type": "string" }, "type": { "$ref": "#/components/schemas/FlowStepType" }, "viaId": { "type": "string" } }, "required": [ "description", "id", "index", "originId", "targetId", "type", "viaId" ], "type": "object" }, "FlowExport": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "showConnectionNames": { "type": "boolean" }, "steps": { "additionalProperties": { "$ref": "#/components/schemas/FlowStepExport" }, "type": "object" } }, "required": [ "id", "name", "showConnectionNames", "steps" ], "type": "object" }, "ModelConnectionExport": { "properties": { "description": { "type": "string" }, "direction": { "$ref": "#/components/schemas/ModelConnectionDirectionNullable" }, "id": { "type": "string" }, "links": { "additionalProperties": { "$ref": "#/components/schemas/RealityLink" }, "type": "object" }, "name": { "type": "string" }, "originId": { "type": "string" }, "status": { "$ref": "#/components/schemas/ModelConnectionStatus" }, "tagIds": { "items": { "type": "string" }, "type": "array" }, "targetId": { "type": "string" }, "technologyIds": { "items": { "type": "string" }, "type": "array" }, "viaId": { "nullable": true, "type": "string" } }, "required": [ "description", "direction", "id", "name", "originId", "status", "tagIds", "targetId", "technologyIds", "viaId" ], "type": "object" }, "ModelObjectExport": { "properties": { "caption": { "type": "string" }, "description": { "type": "string" }, "domainId": { "type": "string" }, "external": { "type": "boolean" }, "groupIds": { "items": { "type": "string" }, "type": "array" }, "icon": { "$ref": "#/components/schemas/ModelObjectIconNullable" }, "id": { "type": "string" }, "links": { "additionalProperties": { "$ref": "#/components/schemas/RealityLink" }, "type": "object" }, "name": { "type": "string" }, "parentId": { "nullable": true, "type": "string" }, "parentIds": { "items": { "type": "string" }, "type": "array" }, "status": { "$ref": "#/components/schemas/ModelObjectStatus" }, "tagIds": { "items": { "type": "string" }, "type": "array" }, "teamIds": { "items": { "type": "string" }, "type": "array" }, "technologies": { "additionalProperties": { "$ref": "#/components/schemas/TechnologyExport" }, "type": "object" }, "technologyIds": { "items": { "type": "string" }, "type": "array" }, "type": { "$ref": "#/components/schemas/ModelObjectType" } }, "required": [ "caption", "description", "domainId", "external", "icon", "id", "links", "groupIds", "name", "parentId", "parentIds", "status", "tagIds", "teamIds", "technologyIds", "type" ], "type": "object" }, "TagExport": { "properties": { "color": { "$ref": "#/components/schemas/TagColor" }, "groupId": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "color", "groupId", "id", "name" ], "type": "object" }, "TagGroupExport": { "properties": { "icon": { "$ref": "#/components/schemas/TagGroupIcon" }, "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "icon", "id", "name" ], "type": "object" }, "TeamExport": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "ModelObjectDependenciesExport": { "properties": { "incomingConnectionObjects": { "additionalProperties": { "items": { "$ref": "#/components/schemas/ModelObjectExport" }, "type": "array" }, "type": "object" }, "incomingConnections": { "items": { "$ref": "#/components/schemas/ModelConnectionExport" }, "type": "array" }, "outgoingConnectionObjects": { "additionalProperties": { "items": { "$ref": "#/components/schemas/ModelObjectExport" }, "type": "array" }, "type": "object" }, "outgoingConnections": { "items": { "$ref": "#/components/schemas/ModelConnectionExport" }, "type": "array" } }, "required": [ "incomingConnectionObjects", "incomingConnections", "outgoingConnectionObjects", "outgoingConnections" ], "type": "object" }, "VersionExport": { "properties": { "domains": { "additionalProperties": { "$ref": "#/components/schemas/DomainExport" }, "type": "object" }, "flows": { "additionalProperties": { "$ref": "#/components/schemas/FlowExport" }, "type": "object" }, "modelConnections": { "additionalProperties": { "$ref": "#/components/schemas/ModelConnectionExport" }, "type": "object" }, "modelObjects": { "additionalProperties": { "$ref": "#/components/schemas/ModelObjectExport" }, "type": "object" }, "tagGroups": { "additionalProperties": { "$ref": "#/components/schemas/TagGroupExport" }, "type": "object" }, "tags": { "additionalProperties": { "$ref": "#/components/schemas/TagExport" }, "type": "object" }, "teams": { "additionalProperties": { "$ref": "#/components/schemas/TeamExport" }, "type": "object" }, "technologies": { "additionalProperties": { "$ref": "#/components/schemas/TechnologyExport" }, "type": "object" } }, "required": [ "domains", "flows", "modelConnections", "modelObjects", "tagGroups", "tags", "teams", "technologies" ], "type": "object" }, "VersionExportV2": { "description": "Version export in the v2 schema, matching the import endpoint structure.", "properties": { "flows": { "items": { "$ref": "#/components/schemas/FlowExport" }, "type": "array" }, "modelConnections": { "items": { "$ref": "#/components/schemas/ModelConnectionImport" }, "type": "array" }, "modelObjects": { "items": { "$ref": "#/components/schemas/ModelObjectImport" }, "type": "array" }, "tagGroups": { "items": { "$ref": "#/components/schemas/TagGroupImport" }, "type": "array" }, "tags": { "items": { "$ref": "#/components/schemas/TagImport" }, "type": "array" }, "teams": { "items": { "$ref": "#/components/schemas/TeamExport" }, "type": "array" }, "technologies": { "items": { "$ref": "#/components/schemas/TechnologyExport" }, "type": "array" } }, "required": [ "flows", "modelConnections", "modelObjects", "tagGroups", "tags", "teams", "technologies" ], "type": "object" }, "HealthCheckStatus": { "enum": [ "ok", "degraded", "down" ], "type": "string" }, "HealthCheckService": { "properties": { "id": { "type": "string" }, "message": { "type": "string" }, "status": { "$ref": "#/components/schemas/HealthCheckStatus" } }, "required": [ "id", "status" ], "type": "object" }, "HealthCheck": { "properties": { "id": { "type": "string" }, "location": { "type": "string" }, "ok": { "type": "boolean" }, "services": { "additionalProperties": { "$ref": "#/components/schemas/HealthCheckService" }, "type": "object" } }, "required": [ "id", "ok", "services" ], "type": "object" }, "Partial": { "anyOf": [ { "$ref": "#/components/schemas/ADRPartial" }, { "$ref": "#/components/schemas/ApiKeyPartial" }, { "$ref": "#/components/schemas/AutomationRunPartial" }, { "$ref": "#/components/schemas/AzureDevopsAuthorizationPartial" }, { "$ref": "#/components/schemas/BitbucketAuthorizationPartial" }, { "$ref": "#/components/schemas/BitbucketServerTokenPartial" }, { "$ref": "#/components/schemas/CatalogTechnologyPartial" }, { "$ref": "#/components/schemas/CodeRepoPartial" }, { "$ref": "#/components/schemas/CommentPartial" }, { "$ref": "#/components/schemas/CommentReplyPartial" }, { "$ref": "#/components/schemas/DiagramCommentPartial" }, { "$ref": "#/components/schemas/DiagramConnectionPartial" }, { "$ref": "#/components/schemas/DiagramContentPartial" }, { "$ref": "#/components/schemas/DiagramGroupPartial" }, { "$ref": "#/components/schemas/DiagramObjectPartial" }, { "$ref": "#/components/schemas/DiagramPartial" }, { "$ref": "#/components/schemas/DomainPartial" }, { "$ref": "#/components/schemas/DraftPartial" }, { "$ref": "#/components/schemas/FlowPartial" }, { "$ref": "#/components/schemas/FlowStepPartial" }, { "$ref": "#/components/schemas/GitlabAuthorizationPartial" }, { "$ref": "#/components/schemas/LandscapePartial" }, { "$ref": "#/components/schemas/LandscapeTemplatePartial" }, { "$ref": "#/components/schemas/ModelConnectionPartial" }, { "$ref": "#/components/schemas/ModelObjectPartial" }, { "$ref": "#/components/schemas/OrganizationPartial" }, { "$ref": "#/components/schemas/OrganizationUserInvitePartial" }, { "$ref": "#/components/schemas/RealityLinkPartial" }, { "$ref": "#/components/schemas/SAMLProviderPartial" }, { "$ref": "#/components/schemas/ShareLinkPartial" }, { "$ref": "#/components/schemas/TagGroupPartial" }, { "$ref": "#/components/schemas/TagPartial" }, { "$ref": "#/components/schemas/TeamPartial" }, { "$ref": "#/components/schemas/UserNotificationsPartial" }, { "$ref": "#/components/schemas/UserPartial" }, { "$ref": "#/components/schemas/VersionRevertPartial" }, { "$ref": "#/components/schemas/WebhookSubscriptionPartial" } ] }, "Required": { "anyOf": [ { "$ref": "#/components/schemas/ADRRequired" }, { "$ref": "#/components/schemas/ApiKeyRequired" }, { "$ref": "#/components/schemas/AutomationRunRequired" }, { "$ref": "#/components/schemas/BitbucketServerTokenRequired" }, { "$ref": "#/components/schemas/CatalogTechnologyRequired" }, { "$ref": "#/components/schemas/CodeRepoRequired" }, { "$ref": "#/components/schemas/CommentReplyRequired" }, { "$ref": "#/components/schemas/CommentRequired" }, { "$ref": "#/components/schemas/DiagramContentRequired" }, { "$ref": "#/components/schemas/DiagramGroupRequired" }, { "$ref": "#/components/schemas/DiagramRequired" }, { "$ref": "#/components/schemas/DomainRequired" }, { "$ref": "#/components/schemas/DraftRequired" }, { "$ref": "#/components/schemas/DraftTaskRequired" }, { "$ref": "#/components/schemas/FlowRequired" }, { "$ref": "#/components/schemas/LandscapeRequired" }, { "$ref": "#/components/schemas/LandscapeTemplateRequired" }, { "$ref": "#/components/schemas/ModelConnectionRequired" }, { "$ref": "#/components/schemas/ModelObjectRequired" }, { "$ref": "#/components/schemas/OrganizationRequired" }, { "$ref": "#/components/schemas/OrganizationUserInviteRequired" }, { "$ref": "#/components/schemas/RealityLinkRequired" }, { "$ref": "#/components/schemas/SAMLProviderRequired" }, { "$ref": "#/components/schemas/SendEbookRequired" }, { "$ref": "#/components/schemas/ShareLinkOptionsRequired" }, { "$ref": "#/components/schemas/ShareLinkRequired" }, { "$ref": "#/components/schemas/SupportMessageRequired" }, { "$ref": "#/components/schemas/TagGroupRequired" }, { "$ref": "#/components/schemas/TagRequired" }, { "$ref": "#/components/schemas/TeamRequired" }, { "$ref": "#/components/schemas/UserRequired" }, { "$ref": "#/components/schemas/VersionRequired" }, { "$ref": "#/components/schemas/VersionRevertRequired" }, { "$ref": "#/components/schemas/WebhookSubscriptionRequired" } ] }, "All": { "anyOf": [ { "$ref": "#/components/schemas/ADR" }, { "$ref": "#/components/schemas/ADRFilter" }, { "$ref": "#/components/schemas/ADRPartial" }, { "$ref": "#/components/schemas/ADRRelatedItem" }, { "$ref": "#/components/schemas/ADRRelatedItemType" }, { "$ref": "#/components/schemas/ADRRequired" }, { "$ref": "#/components/schemas/ADRStatus" }, { "$ref": "#/components/schemas/ADRStatusChange" }, { "$ref": "#/components/schemas/AIDescriptionType" }, { "$ref": "#/components/schemas/Action" }, { "$ref": "#/components/schemas/ActionApiKey" }, { "$ref": "#/components/schemas/ActionApiKeyContext" }, { "$ref": "#/components/schemas/ActionApiKeyCreate" }, { "$ref": "#/components/schemas/ActionApiKeyDelete" }, { "$ref": "#/components/schemas/ActionApiKeyUpdate" }, { "$ref": "#/components/schemas/ActionCommentCreate" }, { "$ref": "#/components/schemas/ActionCommentCreateContext" }, { "$ref": "#/components/schemas/ActionCommentDelete" }, { "$ref": "#/components/schemas/ActionCommentDeleteContext" }, { "$ref": "#/components/schemas/ActionCommentReplyCreate" }, { "$ref": "#/components/schemas/ActionCommentReplyCreateContext" }, { "$ref": "#/components/schemas/ActionCommentReplyDelete" }, { "$ref": "#/components/schemas/ActionCommentReplyDeleteContext" }, { "$ref": "#/components/schemas/ActionCommentReplyUpdate" }, { "$ref": "#/components/schemas/ActionCommentReplyUpdateContext" }, { "$ref": "#/components/schemas/ActionCommentUpdate" }, { "$ref": "#/components/schemas/ActionCommentUpdateContext" }, { "$ref": "#/components/schemas/ActionContextModelObject" }, { "$ref": "#/components/schemas/ActionDiagram" }, { "$ref": "#/components/schemas/ActionDiagramContentContextComment" }, { "$ref": "#/components/schemas/ActionDiagramContentContextConnection" }, { "$ref": "#/components/schemas/ActionDiagramContentContextObject" }, { "$ref": "#/components/schemas/ActionDiagramContentCreate" }, { "$ref": "#/components/schemas/ActionDiagramContentCreateContext" }, { "$ref": "#/components/schemas/ActionDiagramContentDelete" }, { "$ref": "#/components/schemas/ActionDiagramContentDeleteContext" }, { "$ref": "#/components/schemas/ActionDiagramContentUpdate" }, { "$ref": "#/components/schemas/ActionDiagramContentUpdateContext" }, { "$ref": "#/components/schemas/ActionDiagramContentView" }, { "$ref": "#/components/schemas/ActionDiagramContentViewContext" }, { "$ref": "#/components/schemas/ActionDiagramCreate" }, { "$ref": "#/components/schemas/ActionDiagramCreateContext" }, { "$ref": "#/components/schemas/ActionDiagramDelete" }, { "$ref": "#/components/schemas/ActionDiagramDeleteContext" }, { "$ref": "#/components/schemas/ActionDiagramExport" }, { "$ref": "#/components/schemas/ActionDiagramExportContext" }, { "$ref": "#/components/schemas/ActionDiagramExportProps" }, { "$ref": "#/components/schemas/ActionDiagramGroupCreate" }, { "$ref": "#/components/schemas/ActionDiagramGroupCreateContext" }, { "$ref": "#/components/schemas/ActionDiagramGroupDelete" }, { "$ref": "#/components/schemas/ActionDiagramGroupDeleteContext" }, { "$ref": "#/components/schemas/ActionDiagramGroupUpdate" }, { "$ref": "#/components/schemas/ActionDiagramGroupUpdateContext" }, { "$ref": "#/components/schemas/ActionDiagramUpdate" }, { "$ref": "#/components/schemas/ActionDiagramUpdateContext" }, { "$ref": "#/components/schemas/ActionDomainCreate" }, { "$ref": "#/components/schemas/ActionDomainDelete" }, { "$ref": "#/components/schemas/ActionDomainDeleteContext" }, { "$ref": "#/components/schemas/ActionDomainUpdate" }, { "$ref": "#/components/schemas/ActionDomainUpdateContext" }, { "$ref": "#/components/schemas/ActionDraft" }, { "$ref": "#/components/schemas/ActionDraftCreate" }, { "$ref": "#/components/schemas/ActionDraftCreateContext" }, { "$ref": "#/components/schemas/ActionDraftDelete" }, { "$ref": "#/components/schemas/ActionDraftDeleteContext" }, { "$ref": "#/components/schemas/ActionDraftMerge" }, { "$ref": "#/components/schemas/ActionDraftMergeContext" }, { "$ref": "#/components/schemas/ActionDraftTask" }, { "$ref": "#/components/schemas/ActionDraftTaskCreate" }, { "$ref": "#/components/schemas/ActionDraftTaskCreateContext" }, { "$ref": "#/components/schemas/ActionDraftUpdate" }, { "$ref": "#/components/schemas/ActionDraftUpdateContext" }, { "$ref": "#/components/schemas/ActionDraftView" }, { "$ref": "#/components/schemas/ActionDraftViewContext" }, { "$ref": "#/components/schemas/ActionFlowContextObject" }, { "$ref": "#/components/schemas/ActionFlowCreate" }, { "$ref": "#/components/schemas/ActionFlowCreateContext" }, { "$ref": "#/components/schemas/ActionFlowDelete" }, { "$ref": "#/components/schemas/ActionFlowDeleteContext" }, { "$ref": "#/components/schemas/ActionFlowUpdate" }, { "$ref": "#/components/schemas/ActionFlowUpdateContext" }, { "$ref": "#/components/schemas/ActionFlowView" }, { "$ref": "#/components/schemas/ActionFlowViewContext" }, { "$ref": "#/components/schemas/ActionLandscape" }, { "$ref": "#/components/schemas/ActionLandscapeCopy" }, { "$ref": "#/components/schemas/ActionLandscapeCopyContext" }, { "$ref": "#/components/schemas/ActionLandscapeCreate" }, { "$ref": "#/components/schemas/ActionLandscapeCreateContext" }, { "$ref": "#/components/schemas/ActionLandscapeDelete" }, { "$ref": "#/components/schemas/ActionLandscapeDeleteContext" }, { "$ref": "#/components/schemas/ActionLandscapeDuplicate" }, { "$ref": "#/components/schemas/ActionLandscapeDuplicateContext" }, { "$ref": "#/components/schemas/ActionLandscapeDuplicateProps" }, { "$ref": "#/components/schemas/ActionLandscapeExport" }, { "$ref": "#/components/schemas/ActionLandscapeExportContext" }, { "$ref": "#/components/schemas/ActionLandscapeExportProps" }, { "$ref": "#/components/schemas/ActionLandscapeImport" }, { "$ref": "#/components/schemas/ActionLandscapeImportContext" }, { "$ref": "#/components/schemas/ActionLandscapeImportProps" }, { "$ref": "#/components/schemas/ActionLandscapeUpdate" }, { "$ref": "#/components/schemas/ActionLandscapeUpdateContext" }, { "$ref": "#/components/schemas/ActionLog" }, { "$ref": "#/components/schemas/ActionLogFilter" }, { "$ref": "#/components/schemas/ActionLogFilterActionType" }, { "$ref": "#/components/schemas/ActionLogStatsContributor" }, { "$ref": "#/components/schemas/ActionLogStatsDateByEntity" }, { "$ref": "#/components/schemas/ActionLogStatsDateByType" }, { "$ref": "#/components/schemas/ActionLogStatsFilter" }, { "$ref": "#/components/schemas/ActionLogStatsItemByEntity" }, { "$ref": "#/components/schemas/ActionLogStatsItemByType" }, { "$ref": "#/components/schemas/ActionLogStatsListByEntity" }, { "$ref": "#/components/schemas/ActionLogStatsListByType" }, { "$ref": "#/components/schemas/ActionLogStatsPeriod" }, { "$ref": "#/components/schemas/ActionModelConnection" }, { "$ref": "#/components/schemas/ActionModelConnectionCreate" }, { "$ref": "#/components/schemas/ActionModelConnectionCreateContext" }, { "$ref": "#/components/schemas/ActionModelConnectionDelete" }, { "$ref": "#/components/schemas/ActionModelConnectionDeleteContext" }, { "$ref": "#/components/schemas/ActionModelConnectionUpdate" }, { "$ref": "#/components/schemas/ActionModelConnectionUpdateContext" }, { "$ref": "#/components/schemas/ActionModelConnectionsExport" }, { "$ref": "#/components/schemas/ActionModelConnectionsExportContext" }, { "$ref": "#/components/schemas/ActionModelConnectionsExportProps" }, { "$ref": "#/components/schemas/ActionModelObject" }, { "$ref": "#/components/schemas/ActionModelObjectCreate" }, { "$ref": "#/components/schemas/ActionModelObjectCreateContext" }, { "$ref": "#/components/schemas/ActionModelObjectDelete" }, { "$ref": "#/components/schemas/ActionModelObjectDeleteContext" }, { "$ref": "#/components/schemas/ActionModelObjectDependenciesExport" }, { "$ref": "#/components/schemas/ActionModelObjectDependenciesExportContext" }, { "$ref": "#/components/schemas/ActionModelObjectDependenciesExportProps" }, { "$ref": "#/components/schemas/ActionModelObjectUpdate" }, { "$ref": "#/components/schemas/ActionModelObjectUpdateContext" }, { "$ref": "#/components/schemas/ActionModelObjectsExport" }, { "$ref": "#/components/schemas/ActionModelObjectsExportContext" }, { "$ref": "#/components/schemas/ActionModelObjectsExportProps" }, { "$ref": "#/components/schemas/ActionOAuth" }, { "$ref": "#/components/schemas/ActionOAuthConsentDeny" }, { "$ref": "#/components/schemas/ActionOAuthConsentDenyProps" }, { "$ref": "#/components/schemas/ActionOAuthConsentGrant" }, { "$ref": "#/components/schemas/ActionOAuthConsentGrantProps" }, { "$ref": "#/components/schemas/ActionOrganization" }, { "$ref": "#/components/schemas/ActionOrganizationCreate" }, { "$ref": "#/components/schemas/ActionOrganizationCreateContext" }, { "$ref": "#/components/schemas/ActionOrganizationDelete" }, { "$ref": "#/components/schemas/ActionOrganizationDeleteContext" }, { "$ref": "#/components/schemas/ActionOrganizationDeleteProps" }, { "$ref": "#/components/schemas/ActionOrganizationUpdate" }, { "$ref": "#/components/schemas/ActionOrganizationUpdateContext" }, { "$ref": "#/components/schemas/ActionOrganizationUser" }, { "$ref": "#/components/schemas/ActionOrganizationUserAdd" }, { "$ref": "#/components/schemas/ActionOrganizationUserAddContext" }, { "$ref": "#/components/schemas/ActionOrganizationUserInvite" }, { "$ref": "#/components/schemas/ActionOrganizationUserInviteCreate" }, { "$ref": "#/components/schemas/ActionOrganizationUserInviteCreateContext" }, { "$ref": "#/components/schemas/ActionOrganizationUserInviteRevoke" }, { "$ref": "#/components/schemas/ActionOrganizationUserInviteRevokeContext" }, { "$ref": "#/components/schemas/ActionOrganizationUserRemove" }, { "$ref": "#/components/schemas/ActionOrganizationUserRemoveContext" }, { "$ref": "#/components/schemas/ActionOrganizationUserUpdate" }, { "$ref": "#/components/schemas/ActionOrganizationUserUpdateContext" }, { "$ref": "#/components/schemas/ActionShareLink" }, { "$ref": "#/components/schemas/ActionShareLinkCreate" }, { "$ref": "#/components/schemas/ActionShareLinkCreateContext" }, { "$ref": "#/components/schemas/ActionShareLinkDelete" }, { "$ref": "#/components/schemas/ActionShareLinkDeleteContext" }, { "$ref": "#/components/schemas/ActionShareLinkUpdate" }, { "$ref": "#/components/schemas/ActionShareLinkUpdateContext" }, { "$ref": "#/components/schemas/ActionTagCreate" }, { "$ref": "#/components/schemas/ActionTagCreateContext" }, { "$ref": "#/components/schemas/ActionTagDelete" }, { "$ref": "#/components/schemas/ActionTagDeleteContext" }, { "$ref": "#/components/schemas/ActionTagGroupCreate" }, { "$ref": "#/components/schemas/ActionTagGroupDelete" }, { "$ref": "#/components/schemas/ActionTagGroupDeleteContext" }, { "$ref": "#/components/schemas/ActionTagGroupUpdate" }, { "$ref": "#/components/schemas/ActionTagGroupUpdateContext" }, { "$ref": "#/components/schemas/ActionTagUpdate" }, { "$ref": "#/components/schemas/ActionTagUpdateContext" }, { "$ref": "#/components/schemas/ActionTeam" }, { "$ref": "#/components/schemas/ActionTeamCreate" }, { "$ref": "#/components/schemas/ActionTeamCreateContext" }, { "$ref": "#/components/schemas/ActionTeamDelete" }, { "$ref": "#/components/schemas/ActionTeamDeleteContext" }, { "$ref": "#/components/schemas/ActionTeamUpdate" }, { "$ref": "#/components/schemas/ActionTeamUpdateContext" }, { "$ref": "#/components/schemas/ActionType" }, { "$ref": "#/components/schemas/ActionUser" }, { "$ref": "#/components/schemas/ActionUserLogin" }, { "$ref": "#/components/schemas/ActionUserLoginFailed" }, { "$ref": "#/components/schemas/ActionUserLoginFailedProps" }, { "$ref": "#/components/schemas/ActionUserLogout" }, { "$ref": "#/components/schemas/ActionVersion" }, { "$ref": "#/components/schemas/ActionVersionCreate" }, { "$ref": "#/components/schemas/ActionVersionCreateContext" }, { "$ref": "#/components/schemas/ActionVersionDelete" }, { "$ref": "#/components/schemas/ActionVersionDeleteContext" }, { "$ref": "#/components/schemas/ActionVersionRevertContext" }, { "$ref": "#/components/schemas/ActionVersionRevertCreate" }, { "$ref": "#/components/schemas/ApiKey" }, { "$ref": "#/components/schemas/ApiKeyPartial" }, { "$ref": "#/components/schemas/ApiKeyRequired" }, { "$ref": "#/components/schemas/AuthType" }, { "$ref": "#/components/schemas/AutomationRun" }, { "$ref": "#/components/schemas/AutomationRunPartial" }, { "$ref": "#/components/schemas/AutomationRunRequired" }, { "$ref": "#/components/schemas/AutomationTrigger" }, { "$ref": "#/components/schemas/AutomationTriggerCatalogTechnologyReviewApproved" }, { "$ref": "#/components/schemas/AutomationTriggerCatalogTechnologyReviewRejected" }, { "$ref": "#/components/schemas/AutomationTriggerCommentCreate" }, { "$ref": "#/components/schemas/AutomationTriggerCommentReplyCreate" }, { "$ref": "#/components/schemas/AutomationTriggerCommentStatusUpdate" }, { "$ref": "#/components/schemas/AutomationTriggerExportPdfReady" }, { "$ref": "#/components/schemas/AutomationTriggerOrganizationBillingChargeRefunded" }, { "$ref": "#/components/schemas/AutomationTriggerOrganizationBillingCheckoutSessionCompleted" }, { "$ref": "#/components/schemas/AutomationTriggerOrganizationBillingInvoicePaid" }, { "$ref": "#/components/schemas/AutomationTriggerOrganizationBillingInvoicePaymentFailed" }, { "$ref": "#/components/schemas/AutomationTriggerOrganizationBillingPaymentMethodAttached" }, { "$ref": "#/components/schemas/AutomationTriggerOrganizationBillingPaymentMethodDetached" }, { "$ref": "#/components/schemas/AutomationTriggerOrganizationBillingSubscriptionChanged" }, { "$ref": "#/components/schemas/AutomationTriggerOrganizationCreate" }, { "$ref": "#/components/schemas/AutomationTriggerOrganizationUpdated" }, { "$ref": "#/components/schemas/AutomationTriggerOrganizationUserInviteCreate" }, { "$ref": "#/components/schemas/AutomationTriggerOrganizationUserInviteUsed" }, { "$ref": "#/components/schemas/AutomationTriggerSchedule" }, { "$ref": "#/components/schemas/AutomationTriggerSendC4ModelEbook" }, { "$ref": "#/components/schemas/AutomationTriggerType" }, { "$ref": "#/components/schemas/AutomationTriggerUserEmailVerification" }, { "$ref": "#/components/schemas/AutomationTriggerUserRegister" }, { "$ref": "#/components/schemas/AutomationTriggerUserRequestResetPassword" }, { "$ref": "#/components/schemas/AutomationTriggerUserUpdate" }, { "$ref": "#/components/schemas/AzureDevopsAuthorization" }, { "$ref": "#/components/schemas/AzureDevopsAuthorizationPartial" }, { "$ref": "#/components/schemas/BitbucketAuthorization" }, { "$ref": "#/components/schemas/BitbucketAuthorizationPartial" }, { "$ref": "#/components/schemas/BitbucketServerToken" }, { "$ref": "#/components/schemas/BitbucketServerTokenPartial" }, { "$ref": "#/components/schemas/BitbucketServerTokenRequired" }, { "$ref": "#/components/schemas/CatalogIconType" }, { "$ref": "#/components/schemas/CatalogIconVariant" }, { "$ref": "#/components/schemas/CatalogNewsArticle" }, { "$ref": "#/components/schemas/CatalogNewsArticleFilter" }, { "$ref": "#/components/schemas/CatalogNewsArticleTag" }, { "$ref": "#/components/schemas/CatalogProvider" }, { "$ref": "#/components/schemas/CatalogProviderNullable" }, { "$ref": "#/components/schemas/CatalogRestriction" }, { "$ref": "#/components/schemas/CatalogRestrictionNullable" }, { "$ref": "#/components/schemas/CatalogSuggestionBrand" }, { "$ref": "#/components/schemas/CatalogSuggestionBrandColor" }, { "$ref": "#/components/schemas/CatalogSuggestionBrandLogo" }, { "$ref": "#/components/schemas/CatalogSuggestionBrandLogoFormat" }, { "$ref": "#/components/schemas/CatalogSuggestionInformation" }, { "$ref": "#/components/schemas/CatalogTechnology" }, { "$ref": "#/components/schemas/CatalogTechnologyFilter" }, { "$ref": "#/components/schemas/CatalogTechnologyPartial" }, { "$ref": "#/components/schemas/CatalogTechnologyRequired" }, { "$ref": "#/components/schemas/CatalogTechnologyReviewCreate" }, { "$ref": "#/components/schemas/CatalogTechnologyReviewRejectionReason" }, { "$ref": "#/components/schemas/CatalogTechnologyStatus" }, { "$ref": "#/components/schemas/CatalogTechnologyStatusNullable" }, { "$ref": "#/components/schemas/CatalogTechnologyType" }, { "$ref": "#/components/schemas/CatalogTechnologyTypeNullable" }, { "$ref": "#/components/schemas/CodeRepo" }, { "$ref": "#/components/schemas/CodeRepoFilter" }, { "$ref": "#/components/schemas/CodeRepoPartial" }, { "$ref": "#/components/schemas/CodeRepoRef" }, { "$ref": "#/components/schemas/CodeRepoRefType" }, { "$ref": "#/components/schemas/CodeRepoRequired" }, { "$ref": "#/components/schemas/CodeRepoTreeItem" }, { "$ref": "#/components/schemas/CodeRepoTreeItemType" }, { "$ref": "#/components/schemas/CodeRepoType" }, { "$ref": "#/components/schemas/Comment" }, { "$ref": "#/components/schemas/CommentBody" }, { "$ref": "#/components/schemas/CommentBodyIdea" }, { "$ref": "#/components/schemas/CommentBodyInaccuracy" }, { "$ref": "#/components/schemas/CommentBodyNewIdea" }, { "$ref": "#/components/schemas/CommentBodyNewInaccuracy" }, { "$ref": "#/components/schemas/CommentBodyNewQuestion" }, { "$ref": "#/components/schemas/CommentBodyQuestion" }, { "$ref": "#/components/schemas/CommentBodyStatus" }, { "$ref": "#/components/schemas/CommentBodyType" }, { "$ref": "#/components/schemas/CommentDiagram" }, { "$ref": "#/components/schemas/CommentPartial" }, { "$ref": "#/components/schemas/CommentReply" }, { "$ref": "#/components/schemas/CommentReplyPartial" }, { "$ref": "#/components/schemas/CommentReplyRequired" }, { "$ref": "#/components/schemas/CommentReplyUpsert" }, { "$ref": "#/components/schemas/CommentRequired" }, { "$ref": "#/components/schemas/CommentUpsert" }, { "$ref": "#/components/schemas/Diagram" }, { "$ref": "#/components/schemas/DiagramAction" }, { "$ref": "#/components/schemas/DiagramComment" }, { "$ref": "#/components/schemas/DiagramCommentPartial" }, { "$ref": "#/components/schemas/DiagramConnection" }, { "$ref": "#/components/schemas/DiagramConnectionPartial" }, { "$ref": "#/components/schemas/DiagramContent" }, { "$ref": "#/components/schemas/DiagramContentGenerateDescriptionFilter" }, { "$ref": "#/components/schemas/DiagramContentNullable" }, { "$ref": "#/components/schemas/DiagramContentPartial" }, { "$ref": "#/components/schemas/DiagramContentRequired" }, { "$ref": "#/components/schemas/DiagramCreate" }, { "$ref": "#/components/schemas/DiagramExportImage" }, { "$ref": "#/components/schemas/DiagramExportImageFileType" }, { "$ref": "#/components/schemas/DiagramExportImageFileUrls" }, { "$ref": "#/components/schemas/DiagramExportImageOptions" }, { "$ref": "#/components/schemas/DiagramExportPngOptions" }, { "$ref": "#/components/schemas/DiagramFilter" }, { "$ref": "#/components/schemas/DiagramGroup" }, { "$ref": "#/components/schemas/DiagramGroupFilter" }, { "$ref": "#/components/schemas/DiagramGroupPartial" }, { "$ref": "#/components/schemas/DiagramGroupRequired" }, { "$ref": "#/components/schemas/DiagramGroupUpsert" }, { "$ref": "#/components/schemas/DiagramObject" }, { "$ref": "#/components/schemas/DiagramObjectConnector" }, { "$ref": "#/components/schemas/DiagramObjectCount" }, { "$ref": "#/components/schemas/DiagramObjectPartial" }, { "$ref": "#/components/schemas/DiagramObjectShape" }, { "$ref": "#/components/schemas/DiagramObjectType" }, { "$ref": "#/components/schemas/DiagramPartial" }, { "$ref": "#/components/schemas/DiagramRequired" }, { "$ref": "#/components/schemas/DiagramStatus" }, { "$ref": "#/components/schemas/DiagramThumbnail" }, { "$ref": "#/components/schemas/DiagramType" }, { "$ref": "#/components/schemas/DiagramUpsert" }, { "$ref": "#/components/schemas/DiagramZoomOverrides" }, { "$ref": "#/components/schemas/DiagramZoomOverridesNullable" }, { "$ref": "#/components/schemas/DocumentBroadcastType" }, { "$ref": "#/components/schemas/Domain" }, { "$ref": "#/components/schemas/DomainExport" }, { "$ref": "#/components/schemas/DomainFilter" }, { "$ref": "#/components/schemas/DomainPartial" }, { "$ref": "#/components/schemas/DomainRequired" }, { "$ref": "#/components/schemas/DomainUpsert" }, { "$ref": "#/components/schemas/Draft" }, { "$ref": "#/components/schemas/DraftChangeSummary" }, { "$ref": "#/components/schemas/DraftConflict" }, { "$ref": "#/components/schemas/DraftConflictType" }, { "$ref": "#/components/schemas/DraftConflictsList" }, { "$ref": "#/components/schemas/DraftFilter" }, { "$ref": "#/components/schemas/DraftPartial" }, { "$ref": "#/components/schemas/DraftRequired" }, { "$ref": "#/components/schemas/DraftStatus" }, { "$ref": "#/components/schemas/DraftTask" }, { "$ref": "#/components/schemas/DraftTaskCommentCreate" }, { "$ref": "#/components/schemas/DraftTaskCommentCreateProps" }, { "$ref": "#/components/schemas/DraftTaskCommentDelete" }, { "$ref": "#/components/schemas/DraftTaskCommentReplyCreate" }, { "$ref": "#/components/schemas/DraftTaskCommentReplyCreateProps" }, { "$ref": "#/components/schemas/DraftTaskCommentReplyDelete" }, { "$ref": "#/components/schemas/DraftTaskCommentReplyUpdate" }, { "$ref": "#/components/schemas/DraftTaskCommentReplyUpdateProps" }, { "$ref": "#/components/schemas/DraftTaskCommentUpdate" }, { "$ref": "#/components/schemas/DraftTaskCommentUpdateProps" }, { "$ref": "#/components/schemas/DraftTaskDiagramContentUpdate" }, { "$ref": "#/components/schemas/DraftTaskDiagramContentUpdateProps" }, { "$ref": "#/components/schemas/DraftTaskDiagramCreate" }, { "$ref": "#/components/schemas/DraftTaskDiagramCreateProps" }, { "$ref": "#/components/schemas/DraftTaskDiagramDelete" }, { "$ref": "#/components/schemas/DraftTaskDiagramGroupCreate" }, { "$ref": "#/components/schemas/DraftTaskDiagramGroupCreateProps" }, { "$ref": "#/components/schemas/DraftTaskDiagramGroupDelete" }, { "$ref": "#/components/schemas/DraftTaskDiagramGroupUpdate" }, { "$ref": "#/components/schemas/DraftTaskDiagramGroupUpdateProps" }, { "$ref": "#/components/schemas/DraftTaskDiagramUpdate" }, { "$ref": "#/components/schemas/DraftTaskDiagramUpdateProps" }, { "$ref": "#/components/schemas/DraftTaskFilter" }, { "$ref": "#/components/schemas/DraftTaskFlowCreate" }, { "$ref": "#/components/schemas/DraftTaskFlowCreateProps" }, { "$ref": "#/components/schemas/DraftTaskFlowDelete" }, { "$ref": "#/components/schemas/DraftTaskFlowUpdate" }, { "$ref": "#/components/schemas/DraftTaskFlowUpdateProps" }, { "$ref": "#/components/schemas/DraftTaskJson" }, { "$ref": "#/components/schemas/DraftTaskList" }, { "$ref": "#/components/schemas/DraftTaskModelConnectionCreate" }, { "$ref": "#/components/schemas/DraftTaskModelConnectionCreateProps" }, { "$ref": "#/components/schemas/DraftTaskModelConnectionDelete" }, { "$ref": "#/components/schemas/DraftTaskModelConnectionUpdate" }, { "$ref": "#/components/schemas/DraftTaskModelConnectionUpdateProps" }, { "$ref": "#/components/schemas/DraftTaskModelObjectCreate" }, { "$ref": "#/components/schemas/DraftTaskModelObjectCreateProps" }, { "$ref": "#/components/schemas/DraftTaskModelObjectDelete" }, { "$ref": "#/components/schemas/DraftTaskModelObjectUpdate" }, { "$ref": "#/components/schemas/DraftTaskModelObjectUpdateProps" }, { "$ref": "#/components/schemas/DraftTaskProps" }, { "$ref": "#/components/schemas/DraftTaskRequired" }, { "$ref": "#/components/schemas/DraftTaskTagCreate" }, { "$ref": "#/components/schemas/DraftTaskTagCreateProps" }, { "$ref": "#/components/schemas/DraftTaskTagDelete" }, { "$ref": "#/components/schemas/DraftTaskTagGroupCreate" }, { "$ref": "#/components/schemas/DraftTaskTagGroupCreateProps" }, { "$ref": "#/components/schemas/DraftTaskTagGroupDelete" }, { "$ref": "#/components/schemas/DraftTaskTagGroupUpdate" }, { "$ref": "#/components/schemas/DraftTaskTagGroupUpdateProps" }, { "$ref": "#/components/schemas/DraftTaskTagUpdate" }, { "$ref": "#/components/schemas/DraftTaskTagUpdateProps" }, { "$ref": "#/components/schemas/DraftTaskType" }, { "$ref": "#/components/schemas/EditorLocation" }, { "$ref": "#/components/schemas/EditorLocationUpdate" }, { "$ref": "#/components/schemas/EditorTyping" }, { "$ref": "#/components/schemas/EditorTypingUpdate" }, { "$ref": "#/components/schemas/Error" }, { "$ref": "#/components/schemas/Experiment" }, { "$ref": "#/components/schemas/ExperimentStage" }, { "$ref": "#/components/schemas/Flow" }, { "$ref": "#/components/schemas/FlowExport" }, { "$ref": "#/components/schemas/FlowFilter" }, { "$ref": "#/components/schemas/FlowPartial" }, { "$ref": "#/components/schemas/FlowRequired" }, { "$ref": "#/components/schemas/FlowStep" }, { "$ref": "#/components/schemas/FlowStepExport" }, { "$ref": "#/components/schemas/FlowStepPartial" }, { "$ref": "#/components/schemas/FlowStepPath" }, { "$ref": "#/components/schemas/FlowStepPaths" }, { "$ref": "#/components/schemas/FlowStepPathsNullable" }, { "$ref": "#/components/schemas/FlowStepType" }, { "$ref": "#/components/schemas/FlowThumbnail" }, { "$ref": "#/components/schemas/GithubInstall" }, { "$ref": "#/components/schemas/GithubInstallType" }, { "$ref": "#/components/schemas/GitlabAuthorization" }, { "$ref": "#/components/schemas/GitlabAuthorizationPartial" }, { "$ref": "#/components/schemas/HealthCheck" }, { "$ref": "#/components/schemas/HealthCheckService" }, { "$ref": "#/components/schemas/HealthCheckStatus" }, { "$ref": "#/components/schemas/ImportEntityType" }, { "$ref": "#/components/schemas/ImportIcon" }, { "$ref": "#/components/schemas/ImportIconNullable" }, { "$ref": "#/components/schemas/ImportLink" }, { "$ref": "#/components/schemas/ImportModelObjectType" }, { "$ref": "#/components/schemas/Landscape" }, { "$ref": "#/components/schemas/LandscapeAction" }, { "$ref": "#/components/schemas/LandscapeActionType" }, { "$ref": "#/components/schemas/LandscapeExport" }, { "$ref": "#/components/schemas/LandscapeExportFilter" }, { "$ref": "#/components/schemas/LandscapeExportOptions" }, { "$ref": "#/components/schemas/LandscapeExportOrientation" }, { "$ref": "#/components/schemas/LandscapeExportSchema" }, { "$ref": "#/components/schemas/LandscapeExportType" }, { "$ref": "#/components/schemas/LandscapeImport" }, { "$ref": "#/components/schemas/LandscapeImportData" }, { "$ref": "#/components/schemas/LandscapeImportError" }, { "$ref": "#/components/schemas/LandscapeImportStatus" }, { "$ref": "#/components/schemas/LandscapeNullable" }, { "$ref": "#/components/schemas/LandscapePartial" }, { "$ref": "#/components/schemas/LandscapeRequired" }, { "$ref": "#/components/schemas/LandscapeTemplate" }, { "$ref": "#/components/schemas/LandscapeTemplatePartial" }, { "$ref": "#/components/schemas/LandscapeTemplateRequired" }, { "$ref": "#/components/schemas/LineShape" }, { "$ref": "#/components/schemas/ModelConnection" }, { "$ref": "#/components/schemas/ModelConnectionDiagram" }, { "$ref": "#/components/schemas/ModelConnectionDirection" }, { "$ref": "#/components/schemas/ModelConnectionDirectionNullable" }, { "$ref": "#/components/schemas/ModelConnectionExpandKey" }, { "$ref": "#/components/schemas/ModelConnectionExpanded" }, { "$ref": "#/components/schemas/ModelConnectionExport" }, { "$ref": "#/components/schemas/ModelConnectionFilter" }, { "$ref": "#/components/schemas/ModelConnectionFlow" }, { "$ref": "#/components/schemas/ModelConnectionImport" }, { "$ref": "#/components/schemas/ModelConnectionPartial" }, { "$ref": "#/components/schemas/ModelConnectionRequired" }, { "$ref": "#/components/schemas/ModelConnectionStatus" }, { "$ref": "#/components/schemas/ModelConnectionUpsert" }, { "$ref": "#/components/schemas/ModelDependenciesFilter" }, { "$ref": "#/components/schemas/ModelObject" }, { "$ref": "#/components/schemas/ModelObjectDependenciesExport" }, { "$ref": "#/components/schemas/ModelObjectDiagram" }, { "$ref": "#/components/schemas/ModelObjectExpandKey" }, { "$ref": "#/components/schemas/ModelObjectExpanded" }, { "$ref": "#/components/schemas/ModelObjectExport" }, { "$ref": "#/components/schemas/ModelObjectFilter" }, { "$ref": "#/components/schemas/ModelObjectFlow" }, { "$ref": "#/components/schemas/ModelObjectIcon" }, { "$ref": "#/components/schemas/ModelObjectIconNullable" }, { "$ref": "#/components/schemas/ModelObjectImport" }, { "$ref": "#/components/schemas/ModelObjectPartial" }, { "$ref": "#/components/schemas/ModelObjectRequired" }, { "$ref": "#/components/schemas/ModelObjectStatus" }, { "$ref": "#/components/schemas/ModelObjectType" }, { "$ref": "#/components/schemas/ModelObjectUpsert" }, { "$ref": "#/components/schemas/ModelStatus" }, { "$ref": "#/components/schemas/ModelStatusType" }, { "$ref": "#/components/schemas/OAuthScope" }, { "$ref": "#/components/schemas/Organization" }, { "$ref": "#/components/schemas/OrganizationAIFeatures" }, { "$ref": "#/components/schemas/OrganizationAction" }, { "$ref": "#/components/schemas/OrganizationActionType" }, { "$ref": "#/components/schemas/OrganizationAiModel" }, { "$ref": "#/components/schemas/OrganizationBillingCurrency" }, { "$ref": "#/components/schemas/OrganizationBillingCycle" }, { "$ref": "#/components/schemas/OrganizationBillingLinks" }, { "$ref": "#/components/schemas/OrganizationBillingSubscriptionCreate" }, { "$ref": "#/components/schemas/OrganizationBillingSubscriptionUpdate" }, { "$ref": "#/components/schemas/OrganizationBrand" }, { "$ref": "#/components/schemas/OrganizationCollectionMethod" }, { "$ref": "#/components/schemas/OrganizationLanguage" }, { "$ref": "#/components/schemas/OrganizationLog" }, { "$ref": "#/components/schemas/OrganizationLogFilter" }, { "$ref": "#/components/schemas/OrganizationLogFilterActionType" }, { "$ref": "#/components/schemas/OrganizationLogStatsDateByType" }, { "$ref": "#/components/schemas/OrganizationLogStatsFilter" }, { "$ref": "#/components/schemas/OrganizationLogStatsItemByType" }, { "$ref": "#/components/schemas/OrganizationLogStatsListByType" }, { "$ref": "#/components/schemas/OrganizationPartial" }, { "$ref": "#/components/schemas/OrganizationPlan" }, { "$ref": "#/components/schemas/OrganizationRequired" }, { "$ref": "#/components/schemas/OrganizationStatus" }, { "$ref": "#/components/schemas/OrganizationUser" }, { "$ref": "#/components/schemas/OrganizationUserInfo" }, { "$ref": "#/components/schemas/OrganizationUserInvite" }, { "$ref": "#/components/schemas/OrganizationUserInvitePartial" }, { "$ref": "#/components/schemas/OrganizationUserInviteRequired" }, { "$ref": "#/components/schemas/Partial" }, { "$ref": "#/components/schemas/PermissionType" }, { "$ref": "#/components/schemas/PubSubEditorLocation" }, { "$ref": "#/components/schemas/PubSubEditorTyping" }, { "$ref": "#/components/schemas/QueryBroadcastType" }, { "$ref": "#/components/schemas/RealityConnector" }, { "$ref": "#/components/schemas/RealityConnectorAzureDevopsBranch" }, { "$ref": "#/components/schemas/RealityConnectorAzureDevopsFile" }, { "$ref": "#/components/schemas/RealityConnectorAzureDevopsFolder" }, { "$ref": "#/components/schemas/RealityConnectorAzureDevopsRepo" }, { "$ref": "#/components/schemas/RealityConnectorBitbucketBranch" }, { "$ref": "#/components/schemas/RealityConnectorBitbucketFile" }, { "$ref": "#/components/schemas/RealityConnectorBitbucketFolder" }, { "$ref": "#/components/schemas/RealityConnectorBitbucketRepo" }, { "$ref": "#/components/schemas/RealityConnectorBitbucketServerBranch" }, { "$ref": "#/components/schemas/RealityConnectorBitbucketServerFile" }, { "$ref": "#/components/schemas/RealityConnectorBitbucketServerFolder" }, { "$ref": "#/components/schemas/RealityConnectorBitbucketServerRepo" }, { "$ref": "#/components/schemas/RealityConnectorGithubBranch" }, { "$ref": "#/components/schemas/RealityConnectorGithubFile" }, { "$ref": "#/components/schemas/RealityConnectorGithubFolder" }, { "$ref": "#/components/schemas/RealityConnectorGithubRepo" }, { "$ref": "#/components/schemas/RealityConnectorGitlabBranch" }, { "$ref": "#/components/schemas/RealityConnectorGitlabFile" }, { "$ref": "#/components/schemas/RealityConnectorGitlabFolder" }, { "$ref": "#/components/schemas/RealityConnectorGitlabRepo" }, { "$ref": "#/components/schemas/RealityConnectorType" }, { "$ref": "#/components/schemas/RealityConnectorUrl" }, { "$ref": "#/components/schemas/RealityLink" }, { "$ref": "#/components/schemas/RealityLinkPartial" }, { "$ref": "#/components/schemas/RealityLinkRequired" }, { "$ref": "#/components/schemas/RealityLinkStatus" }, { "$ref": "#/components/schemas/Required" }, { "$ref": "#/components/schemas/SAMLProvider" }, { "$ref": "#/components/schemas/SAMLProviderPartial" }, { "$ref": "#/components/schemas/SAMLProviderRequired" }, { "$ref": "#/components/schemas/SAMLRequest" }, { "$ref": "#/components/schemas/SearchFilter" }, { "$ref": "#/components/schemas/SearchIndexItem" }, { "$ref": "#/components/schemas/SearchIndexType" }, { "$ref": "#/components/schemas/SearchResult" }, { "$ref": "#/components/schemas/SearchResultData" }, { "$ref": "#/components/schemas/SendEbookRequired" }, { "$ref": "#/components/schemas/ShareLink" }, { "$ref": "#/components/schemas/ShareLinkFrameLocation" }, { "$ref": "#/components/schemas/ShareLinkOptions" }, { "$ref": "#/components/schemas/ShareLinkOptionsDrawer" }, { "$ref": "#/components/schemas/ShareLinkOptionsDrawerObject" }, { "$ref": "#/components/schemas/ShareLinkOptionsMode" }, { "$ref": "#/components/schemas/ShareLinkOptionsObjectTab" }, { "$ref": "#/components/schemas/ShareLinkOptionsOverlayTab" }, { "$ref": "#/components/schemas/ShareLinkOptionsRequired" }, { "$ref": "#/components/schemas/ShareLinkPartial" }, { "$ref": "#/components/schemas/ShareLinkRequired" }, { "$ref": "#/components/schemas/ShareLinkStats" }, { "$ref": "#/components/schemas/SocketClientAdrsEvents" }, { "$ref": "#/components/schemas/SocketClientAdrsListBody" }, { "$ref": "#/components/schemas/SocketClientAdrsListReply" }, { "$ref": "#/components/schemas/SocketClientAdrsSubscribeBody" }, { "$ref": "#/components/schemas/SocketClientAdrsSubscribeReply" }, { "$ref": "#/components/schemas/SocketClientAdrsUnsubscribeBody" }, { "$ref": "#/components/schemas/SocketClientCommentEvents" }, { "$ref": "#/components/schemas/SocketClientCommentsListBody" }, { "$ref": "#/components/schemas/SocketClientCommentsListReply" }, { "$ref": "#/components/schemas/SocketClientCommentsReplyListBody" }, { "$ref": "#/components/schemas/SocketClientCommentsReplyListReply" }, { "$ref": "#/components/schemas/SocketClientCommentsReplySubscribeBody" }, { "$ref": "#/components/schemas/SocketClientCommentsReplySubscribeReply" }, { "$ref": "#/components/schemas/SocketClientCommentsReplyUnsubscribeBody" }, { "$ref": "#/components/schemas/SocketClientCommentsSubscribeBody" }, { "$ref": "#/components/schemas/SocketClientCommentsSubscribeReply" }, { "$ref": "#/components/schemas/SocketClientCommentsUnsubscribeBody" }, { "$ref": "#/components/schemas/SocketClientDiagramContentsListBody" }, { "$ref": "#/components/schemas/SocketClientDiagramContentsListReply" }, { "$ref": "#/components/schemas/SocketClientDiagramContentsSubscribeBody" }, { "$ref": "#/components/schemas/SocketClientDiagramContentsSubscribeReply" }, { "$ref": "#/components/schemas/SocketClientDiagramContentsUnsubscribeBody" }, { "$ref": "#/components/schemas/SocketClientDiagramEvents" }, { "$ref": "#/components/schemas/SocketClientDiagramGroupsListBody" }, { "$ref": "#/components/schemas/SocketClientDiagramGroupsListReply" }, { "$ref": "#/components/schemas/SocketClientDiagramGroupsSubscribeBody" }, { "$ref": "#/components/schemas/SocketClientDiagramGroupsSubscribeReply" }, { "$ref": "#/components/schemas/SocketClientDiagramGroupsUnsubscribeBody" }, { "$ref": "#/components/schemas/SocketClientDiagramsListBody" }, { "$ref": "#/components/schemas/SocketClientDiagramsListReply" }, { "$ref": "#/components/schemas/SocketClientDiagramsSubscribeBody" }, { "$ref": "#/components/schemas/SocketClientDiagramsSubscribeReply" }, { "$ref": "#/components/schemas/SocketClientDiagramsUnsubscribeBody" }, { "$ref": "#/components/schemas/SocketClientDomainEvents" }, { "$ref": "#/components/schemas/SocketClientDomainsListBody" }, { "$ref": "#/components/schemas/SocketClientDomainsListReply" }, { "$ref": "#/components/schemas/SocketClientDomainsSubscribeBody" }, { "$ref": "#/components/schemas/SocketClientDomainsSubscribeReply" }, { "$ref": "#/components/schemas/SocketClientDomainsUnsubscribeBody" }, { "$ref": "#/components/schemas/SocketClientDraftEvents" }, { "$ref": "#/components/schemas/SocketClientDraftsListBody" }, { "$ref": "#/components/schemas/SocketClientDraftsListReply" }, { "$ref": "#/components/schemas/SocketClientDraftsSubscribeBody" }, { "$ref": "#/components/schemas/SocketClientDraftsSubscribeReply" }, { "$ref": "#/components/schemas/SocketClientDraftsUnsubscribeBody" }, { "$ref": "#/components/schemas/SocketClientEditorEvents" }, { "$ref": "#/components/schemas/SocketClientEditorLocationUpdateBody" }, { "$ref": "#/components/schemas/SocketClientEditorSubscribeBody" }, { "$ref": "#/components/schemas/SocketClientEditorSubscribeReply" }, { "$ref": "#/components/schemas/SocketClientEditorTypingUpdateBody" }, { "$ref": "#/components/schemas/SocketClientEditorUnsubscribeBody" }, { "$ref": "#/components/schemas/SocketClientEvents" }, { "$ref": "#/components/schemas/SocketClientFlowEvents" }, { "$ref": "#/components/schemas/SocketClientFlowsListBody" }, { "$ref": "#/components/schemas/SocketClientFlowsListReply" }, { "$ref": "#/components/schemas/SocketClientFlowsSubscribeBody" }, { "$ref": "#/components/schemas/SocketClientFlowsSubscribeReply" }, { "$ref": "#/components/schemas/SocketClientFlowsUnsubscribeBody" }, { "$ref": "#/components/schemas/SocketClientLandscapeEvents" }, { "$ref": "#/components/schemas/SocketClientLandscapeSubscribeBody" }, { "$ref": "#/components/schemas/SocketClientLandscapeSubscribeReply" }, { "$ref": "#/components/schemas/SocketClientLandscapeUnsubscribeBody" }, { "$ref": "#/components/schemas/SocketClientModelConnectionsListBody" }, { "$ref": "#/components/schemas/SocketClientModelConnectionsListReply" }, { "$ref": "#/components/schemas/SocketClientModelConnectionsSubscribeBody" }, { "$ref": "#/components/schemas/SocketClientModelConnectionsSubscribeReply" }, { "$ref": "#/components/schemas/SocketClientModelConnectionsUnsubscribeBody" }, { "$ref": "#/components/schemas/SocketClientModelEvents" }, { "$ref": "#/components/schemas/SocketClientModelObjectsListBody" }, { "$ref": "#/components/schemas/SocketClientModelObjectsListReply" }, { "$ref": "#/components/schemas/SocketClientModelObjectsSubscribeBody" }, { "$ref": "#/components/schemas/SocketClientModelObjectsSubscribeReply" }, { "$ref": "#/components/schemas/SocketClientModelObjectsUnsubscribeBody" }, { "$ref": "#/components/schemas/SocketClientTagEvents" }, { "$ref": "#/components/schemas/SocketClientTagGroupsListBody" }, { "$ref": "#/components/schemas/SocketClientTagGroupsListReply" }, { "$ref": "#/components/schemas/SocketClientTagGroupsSubscribeBody" }, { "$ref": "#/components/schemas/SocketClientTagGroupsSubscribeReply" }, { "$ref": "#/components/schemas/SocketClientTagGroupsUnsubscribeBody" }, { "$ref": "#/components/schemas/SocketClientTagsListBody" }, { "$ref": "#/components/schemas/SocketClientTagsListReply" }, { "$ref": "#/components/schemas/SocketClientTagsSubscribeBody" }, { "$ref": "#/components/schemas/SocketClientTagsSubscribeReply" }, { "$ref": "#/components/schemas/SocketClientTagsUnsubscribeBody" }, { "$ref": "#/components/schemas/SocketClientVersionEvents" }, { "$ref": "#/components/schemas/SocketClientVersionsListBody" }, { "$ref": "#/components/schemas/SocketClientVersionsListReply" }, { "$ref": "#/components/schemas/SocketClientVersionsSubscribeBody" }, { "$ref": "#/components/schemas/SocketClientVersionsSubscribeReply" }, { "$ref": "#/components/schemas/SocketClientVersionsUnsubscribeBody" }, { "$ref": "#/components/schemas/SocketDiagramContentClientEventName" }, { "$ref": "#/components/schemas/SocketDiagramContentClientEvents" }, { "$ref": "#/components/schemas/SocketDiagramContentClientSubscription" }, { "$ref": "#/components/schemas/SocketDiagramContentServerEventName" }, { "$ref": "#/components/schemas/SocketDiagramContentServerEvents" }, { "$ref": "#/components/schemas/SocketMessageDiagramContentBroadcast" }, { "$ref": "#/components/schemas/SocketMessageDiagramContentClientSubscribe" }, { "$ref": "#/components/schemas/SocketMessageDiagramContentClientUnsubscribe" }, { "$ref": "#/components/schemas/SocketMessageType" }, { "$ref": "#/components/schemas/SocketMessages" }, { "$ref": "#/components/schemas/SocketServerAdrAddedBody" }, { "$ref": "#/components/schemas/SocketServerAdrInitialValueBody" }, { "$ref": "#/components/schemas/SocketServerAdrModifiedBody" }, { "$ref": "#/components/schemas/SocketServerAdrRemovedBody" }, { "$ref": "#/components/schemas/SocketServerAdrsEvents" }, { "$ref": "#/components/schemas/SocketServerAdrsListStreamBody" }, { "$ref": "#/components/schemas/SocketServerCommentAddedBody" }, { "$ref": "#/components/schemas/SocketServerCommentEvents" }, { "$ref": "#/components/schemas/SocketServerCommentInitialValueBody" }, { "$ref": "#/components/schemas/SocketServerCommentModifiedBody" }, { "$ref": "#/components/schemas/SocketServerCommentRemovedBody" }, { "$ref": "#/components/schemas/SocketServerCommentReplyAddedBody" }, { "$ref": "#/components/schemas/SocketServerCommentReplyInitialValueBody" }, { "$ref": "#/components/schemas/SocketServerCommentReplyModifiedBody" }, { "$ref": "#/components/schemas/SocketServerCommentReplyRemovedBody" }, { "$ref": "#/components/schemas/SocketServerCommentsListStreamBody" }, { "$ref": "#/components/schemas/SocketServerCommentsReplyListStreamBody" }, { "$ref": "#/components/schemas/SocketServerDiagramAddedBody" }, { "$ref": "#/components/schemas/SocketServerDiagramContentAddedBody" }, { "$ref": "#/components/schemas/SocketServerDiagramContentInitialValueBody" }, { "$ref": "#/components/schemas/SocketServerDiagramContentModifiedBody" }, { "$ref": "#/components/schemas/SocketServerDiagramContentRemovedBody" }, { "$ref": "#/components/schemas/SocketServerDiagramContentsListStreamBody" }, { "$ref": "#/components/schemas/SocketServerDiagramEvents" }, { "$ref": "#/components/schemas/SocketServerDiagramGroupAddedBody" }, { "$ref": "#/components/schemas/SocketServerDiagramGroupInitialValueBody" }, { "$ref": "#/components/schemas/SocketServerDiagramGroupModifiedBody" }, { "$ref": "#/components/schemas/SocketServerDiagramGroupRemovedBody" }, { "$ref": "#/components/schemas/SocketServerDiagramGroupsListStreamBody" }, { "$ref": "#/components/schemas/SocketServerDiagramInitialValueBody" }, { "$ref": "#/components/schemas/SocketServerDiagramModifiedBody" }, { "$ref": "#/components/schemas/SocketServerDiagramRemovedBody" }, { "$ref": "#/components/schemas/SocketServerDiagramsListStreamBody" }, { "$ref": "#/components/schemas/SocketServerDomainAddedBody" }, { "$ref": "#/components/schemas/SocketServerDomainEvents" }, { "$ref": "#/components/schemas/SocketServerDomainInitialValueBody" }, { "$ref": "#/components/schemas/SocketServerDomainModifiedBody" }, { "$ref": "#/components/schemas/SocketServerDomainRemovedBody" }, { "$ref": "#/components/schemas/SocketServerDomainsListStreamBody" }, { "$ref": "#/components/schemas/SocketServerDraftAddedBody" }, { "$ref": "#/components/schemas/SocketServerDraftEvents" }, { "$ref": "#/components/schemas/SocketServerDraftInitialValueBody" }, { "$ref": "#/components/schemas/SocketServerDraftModifiedBody" }, { "$ref": "#/components/schemas/SocketServerDraftRemovedBody" }, { "$ref": "#/components/schemas/SocketServerDraftTaskAddedBody" }, { "$ref": "#/components/schemas/SocketServerDraftsListStreamBody" }, { "$ref": "#/components/schemas/SocketServerEditorEvents" }, { "$ref": "#/components/schemas/SocketServerEditorLocationAddedBody" }, { "$ref": "#/components/schemas/SocketServerEditorLocationModifiedBody" }, { "$ref": "#/components/schemas/SocketServerEditorLocationsBody" }, { "$ref": "#/components/schemas/SocketServerEditorTypingAddedBody" }, { "$ref": "#/components/schemas/SocketServerEditorTypingBody" }, { "$ref": "#/components/schemas/SocketServerEditorTypingModifiedBody" }, { "$ref": "#/components/schemas/SocketServerEvents" }, { "$ref": "#/components/schemas/SocketServerFlowAddedBody" }, { "$ref": "#/components/schemas/SocketServerFlowEvents" }, { "$ref": "#/components/schemas/SocketServerFlowInitialValueBody" }, { "$ref": "#/components/schemas/SocketServerFlowModifiedBody" }, { "$ref": "#/components/schemas/SocketServerFlowRemovedBody" }, { "$ref": "#/components/schemas/SocketServerFlowsListStreamBody" }, { "$ref": "#/components/schemas/SocketServerLandscapeBody" }, { "$ref": "#/components/schemas/SocketServerLandscapeEvents" }, { "$ref": "#/components/schemas/SocketServerModelConnectionAddedBody" }, { "$ref": "#/components/schemas/SocketServerModelConnectionInitialValueBody" }, { "$ref": "#/components/schemas/SocketServerModelConnectionModifiedBody" }, { "$ref": "#/components/schemas/SocketServerModelConnectionRemovedBody" }, { "$ref": "#/components/schemas/SocketServerModelConnectionsListStreamBody" }, { "$ref": "#/components/schemas/SocketServerModelEvents" }, { "$ref": "#/components/schemas/SocketServerModelObjectAddedBody" }, { "$ref": "#/components/schemas/SocketServerModelObjectInitialValueBody" }, { "$ref": "#/components/schemas/SocketServerModelObjectModifiedBody" }, { "$ref": "#/components/schemas/SocketServerModelObjectRemovedBody" }, { "$ref": "#/components/schemas/SocketServerModelObjectsListStreamBody" }, { "$ref": "#/components/schemas/SocketServerTagAddedBody" }, { "$ref": "#/components/schemas/SocketServerTagEvents" }, { "$ref": "#/components/schemas/SocketServerTagGroupAddedBody" }, { "$ref": "#/components/schemas/SocketServerTagGroupInitialValueBody" }, { "$ref": "#/components/schemas/SocketServerTagGroupModifiedBody" }, { "$ref": "#/components/schemas/SocketServerTagGroupRemovedBody" }, { "$ref": "#/components/schemas/SocketServerTagGroupsListStreamBody" }, { "$ref": "#/components/schemas/SocketServerTagInitialValueBody" }, { "$ref": "#/components/schemas/SocketServerTagModifiedBody" }, { "$ref": "#/components/schemas/SocketServerTagRemovedBody" }, { "$ref": "#/components/schemas/SocketServerTagsListStreamBody" }, { "$ref": "#/components/schemas/SocketServerVersionAddedBody" }, { "$ref": "#/components/schemas/SocketServerVersionEvents" }, { "$ref": "#/components/schemas/SocketServerVersionInitialValueBody" }, { "$ref": "#/components/schemas/SocketServerVersionModifiedBody" }, { "$ref": "#/components/schemas/SocketServerVersionRemovedBody" }, { "$ref": "#/components/schemas/SortDirection" }, { "$ref": "#/components/schemas/SupportMessage" }, { "$ref": "#/components/schemas/SupportMessageAttachment" }, { "$ref": "#/components/schemas/SupportMessageBody" }, { "$ref": "#/components/schemas/SupportMessageBodyBug" }, { "$ref": "#/components/schemas/SupportMessageBodyGeneral" }, { "$ref": "#/components/schemas/SupportMessageBodyPartnerships" }, { "$ref": "#/components/schemas/SupportMessageBodySSOSamlRegistration" }, { "$ref": "#/components/schemas/SupportMessageBodySales" }, { "$ref": "#/components/schemas/SupportMessageBodySupport" }, { "$ref": "#/components/schemas/SupportMessageRequired" }, { "$ref": "#/components/schemas/SupportMessageType" }, { "$ref": "#/components/schemas/Tag" }, { "$ref": "#/components/schemas/TagColor" }, { "$ref": "#/components/schemas/TagExport" }, { "$ref": "#/components/schemas/TagFilter" }, { "$ref": "#/components/schemas/TagGroup" }, { "$ref": "#/components/schemas/TagGroupExport" }, { "$ref": "#/components/schemas/TagGroupFilter" }, { "$ref": "#/components/schemas/TagGroupIcon" }, { "$ref": "#/components/schemas/TagGroupImport" }, { "$ref": "#/components/schemas/TagGroupPartial" }, { "$ref": "#/components/schemas/TagGroupRequired" }, { "$ref": "#/components/schemas/TagGroupUpsert" }, { "$ref": "#/components/schemas/TagImport" }, { "$ref": "#/components/schemas/TagPartial" }, { "$ref": "#/components/schemas/TagRequired" }, { "$ref": "#/components/schemas/TagUpsert" }, { "$ref": "#/components/schemas/Task" }, { "$ref": "#/components/schemas/TaskAdrCreate" }, { "$ref": "#/components/schemas/TaskAdrDelete" }, { "$ref": "#/components/schemas/TaskAdrUpdate" }, { "$ref": "#/components/schemas/TaskBatch" }, { "$ref": "#/components/schemas/TaskCommentCreate" }, { "$ref": "#/components/schemas/TaskCommentDelete" }, { "$ref": "#/components/schemas/TaskCommentReplyCreate" }, { "$ref": "#/components/schemas/TaskCommentReplyDelete" }, { "$ref": "#/components/schemas/TaskCommentReplyUpdate" }, { "$ref": "#/components/schemas/TaskCommentUpdate" }, { "$ref": "#/components/schemas/TaskConcurrency" }, { "$ref": "#/components/schemas/TaskDiagramContentUpdate" }, { "$ref": "#/components/schemas/TaskDiagramCreate" }, { "$ref": "#/components/schemas/TaskDiagramDelete" }, { "$ref": "#/components/schemas/TaskDiagramGroupCreate" }, { "$ref": "#/components/schemas/TaskDiagramGroupDelete" }, { "$ref": "#/components/schemas/TaskDiagramGroupUpdate" }, { "$ref": "#/components/schemas/TaskDiagramUpdate" }, { "$ref": "#/components/schemas/TaskDomainCreate" }, { "$ref": "#/components/schemas/TaskDomainDelete" }, { "$ref": "#/components/schemas/TaskDomainUpdate" }, { "$ref": "#/components/schemas/TaskDraftCreate" }, { "$ref": "#/components/schemas/TaskDraftDelete" }, { "$ref": "#/components/schemas/TaskDraftTaskCreate" }, { "$ref": "#/components/schemas/TaskDraftUpdate" }, { "$ref": "#/components/schemas/TaskFlowCreate" }, { "$ref": "#/components/schemas/TaskFlowDelete" }, { "$ref": "#/components/schemas/TaskFlowUpdate" }, { "$ref": "#/components/schemas/TaskList" }, { "$ref": "#/components/schemas/TaskListRevertable" }, { "$ref": "#/components/schemas/TaskModelConnectionCreate" }, { "$ref": "#/components/schemas/TaskModelConnectionDelete" }, { "$ref": "#/components/schemas/TaskModelConnectionUpdate" }, { "$ref": "#/components/schemas/TaskModelObjectCreate" }, { "$ref": "#/components/schemas/TaskModelObjectDelete" }, { "$ref": "#/components/schemas/TaskModelObjectUpdate" }, { "$ref": "#/components/schemas/TaskNavigation" }, { "$ref": "#/components/schemas/TaskNavigationRoute" }, { "$ref": "#/components/schemas/TaskTagCreate" }, { "$ref": "#/components/schemas/TaskTagDelete" }, { "$ref": "#/components/schemas/TaskTagGroupCreate" }, { "$ref": "#/components/schemas/TaskTagGroupDelete" }, { "$ref": "#/components/schemas/TaskTagGroupUpdate" }, { "$ref": "#/components/schemas/TaskTagUpdate" }, { "$ref": "#/components/schemas/TaskTeamUpdate" }, { "$ref": "#/components/schemas/TaskType" }, { "$ref": "#/components/schemas/Team" }, { "$ref": "#/components/schemas/TeamExport" }, { "$ref": "#/components/schemas/TeamPartial" }, { "$ref": "#/components/schemas/TeamRequired" }, { "$ref": "#/components/schemas/TechnologyExport" }, { "$ref": "#/components/schemas/Theme" }, { "$ref": "#/components/schemas/User" }, { "$ref": "#/components/schemas/UserGoal" }, { "$ref": "#/components/schemas/UserGoalName" }, { "$ref": "#/components/schemas/UserGoalStatus" }, { "$ref": "#/components/schemas/UserNotifications" }, { "$ref": "#/components/schemas/UserNotificationsPartial" }, { "$ref": "#/components/schemas/UserPartial" }, { "$ref": "#/components/schemas/UserRequired" }, { "$ref": "#/components/schemas/UserSession" }, { "$ref": "#/components/schemas/UserTheme" }, { "$ref": "#/components/schemas/Version" }, { "$ref": "#/components/schemas/VersionExport" }, { "$ref": "#/components/schemas/VersionExportV2" }, { "$ref": "#/components/schemas/VersionField" }, { "$ref": "#/components/schemas/VersionFilter" }, { "$ref": "#/components/schemas/VersionIdPathParam" }, { "$ref": "#/components/schemas/VersionOptional" }, { "$ref": "#/components/schemas/VersionRequired" }, { "$ref": "#/components/schemas/VersionRevert" }, { "$ref": "#/components/schemas/VersionRevertPartial" }, { "$ref": "#/components/schemas/VersionRevertRequired" }, { "$ref": "#/components/schemas/VersionUpdate" }, { "$ref": "#/components/schemas/WebhookEvent" }, { "$ref": "#/components/schemas/WebhookEventCollection" }, { "$ref": "#/components/schemas/WebhookEventOperation" }, { "$ref": "#/components/schemas/WebhookEventType" }, { "$ref": "#/components/schemas/WebhookSubscription" }, { "$ref": "#/components/schemas/WebhookSubscriptionPartial" }, { "$ref": "#/components/schemas/WebhookSubscriptionRequired" } ] }, "SortDirection": { "enum": [ "asc", "desc" ], "type": "string" }, "VersionIdPathParam": { "oneOf": [ { "format": "id", "type": "string" }, { "enum": [ "latest" ], "type": "string" } ] }, "ImportModelObjectType": { "enum": [ "domain", "actor", "app", "component", "group", "store", "system" ], "type": "string" }, "ImportEntityType": { "enum": [ "model-object", "model-connection", "tag", "tag-group" ], "type": "string" }, "ImportLink": { "additionalProperties": false, "properties": { "customName": { "description": "Friendly name for the link set by the user", "type": "string" }, "id": { "description": "Random 20 character identifier", "type": "string" }, "url": { "description": "Accessible link URL when not using a connector", "format": "uri", "type": "string" } }, "required": [ "url" ], "type": "object" }, "ImportIcon": { "additionalProperties": false, "properties": { "technologyId": { "type": "string" } }, "required": [ "technologyId" ], "type": "object" }, "ImportIconNullable": { "oneOf": [ { "$ref": "#/components/schemas/ImportIcon" }, { "type": "null" } ] }, "ModelConnectionImport": { "additionalProperties": false, "properties": { "description": { "description": "Detailed description", "type": "string" }, "direction": { "$ref": "#/components/schemas/ModelConnectionDirection" }, "id": { "type": "string" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "links": { "items": { "$ref": "#/components/schemas/ImportLink" }, "type": "array" }, "name": { "type": "string" }, "originId": { "description": "Model object that initiates the connection", "type": "string" }, "status": { "$ref": "#/components/schemas/ModelConnectionStatus" }, "tagIds": { "description": "Tag IDs assigned to this model", "items": { "type": "string" }, "type": "array" }, "targetId": { "description": "Model object that receives the message", "type": "string" }, "technologyIds": { "description": "Technology IDs assigned to this model", "items": { "type": "string" }, "type": "array" }, "viaId": { "description": "Model object that facilitates the connection, such as a Kafka topic, or RabbitMQ queue", "type": "string" } }, "required": [ "direction", "id", "name", "originId", "targetId" ], "type": "object" }, "ModelObjectImport": { "additionalProperties": false, "properties": { "caption": { "description": "Display description", "type": "string" }, "description": { "description": "Detailed description", "type": "string" }, "external": { "description": "Whether the model object is an external service", "type": "boolean" }, "groupIds": { "items": { "type": "string" }, "type": "array" }, "icon": { "$ref": "#/components/schemas/ImportIconNullable" }, "id": { "type": "string" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "links": { "items": { "$ref": "#/components/schemas/ImportLink" }, "type": "array" }, "name": { "type": "string" }, "parentId": { "description": "Parent model object ID, must follow the IcePanel hierarchy.\n\nDomain: parent must be missing/null\n\nActor/System: parent must be a domain\n\nGroup: parent must be a domain or another group\n\nApp/Store: parent must be a system\n\nComponent: parent must be an app or store", "nullable": true, "type": "string" }, "status": { "$ref": "#/components/schemas/ModelObjectStatus" }, "tagIds": { "items": { "type": "string" }, "type": "array" }, "teamIds": { "items": { "type": "string" }, "type": "array" }, "technologyIds": { "items": { "type": "string" }, "type": "array" }, "type": { "$ref": "#/components/schemas/ImportModelObjectType" } }, "required": [ "id", "name", "type" ], "type": "object" }, "TagImport": { "additionalProperties": false, "properties": { "color": { "$ref": "#/components/schemas/TagColor" }, "groupId": { "description": "Parent tag group ID", "type": "string" }, "id": { "type": "string" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "name": { "type": "string" } }, "required": [ "color", "groupId", "id", "name" ], "type": "object" }, "TagGroupImport": { "additionalProperties": false, "properties": { "icon": { "$ref": "#/components/schemas/TagGroupIcon" }, "id": { "type": "string" }, "labels": { "additionalProperties": { "maxLength": 5000, "type": "string" }, "maxProperties": 50, "type": "object" }, "name": { "type": "string" } }, "required": [ "icon", "id", "name" ], "type": "object" }, "LandscapeImportData": { "additionalProperties": true, "example": { "modelConnections": [ { "direction": "outgoing", "id": "connection-1", "name": "Connection", "originId": "object-2", "targetId": "object-3" } ], "modelObjects": [ { "id": "object-1", "name": "Domain", "type": "domain" }, { "groupIds": [ "object-3" ], "id": "object-2", "name": "System", "parentId": "object-1", "type": "system" }, { "id": "object-3", "name": "Group", "parentId": "object-1", "tagIds": [ "tag-1" ], "type": "group" } ], "tagGroups": [ { "icon": "bug", "id": "tag-group-1", "name": "Tag Group" } ], "tags": [ { "color": "beaver", "groupId": "tag-group-1", "id": "tag-1", "name": "Tag" } ] }, "properties": { "modelConnections": { "items": { "$ref": "#/components/schemas/ModelConnectionImport" }, "type": "array" }, "modelObjects": { "items": { "$ref": "#/components/schemas/ModelObjectImport" }, "type": "array" }, "namespace": { "description": "The namespace of the import, used for seperate operations when using multiple import sources", "type": "string" }, "tagGroups": { "items": { "$ref": "#/components/schemas/TagGroupImport" }, "type": "array" }, "tags": { "items": { "$ref": "#/components/schemas/TagImport" }, "type": "array" } }, "type": "object" }, "RealityConnectorType": { "enum": [ "azure-devops-branch", "azure-devops-file", "azure-devops-folder", "azure-devops-repo", "bitbucket-branch", "bitbucket-file", "bitbucket-folder", "bitbucket-repo", "bitbucket-server-branch", "bitbucket-server-file", "bitbucket-server-folder", "bitbucket-server-repo", "github-branch", "github-file", "github-folder", "github-repo", "gitlab-branch", "gitlab-file", "gitlab-folder", "gitlab-repo", "url" ], "type": "string" }, "RealityConnectorUrl": { "properties": { "type": { "enum": [ "url" ], "type": "string" }, "url": { "type": "string" } }, "required": [ "type", "url" ], "type": "object" }, "RealityConnectorAzureDevopsRepo": { "properties": { "accountName": { "type": "string" }, "projectId": { "type": "string" }, "repositoryId": { "type": "string" }, "type": { "enum": [ "azure-devops-repo" ], "type": "string" } }, "required": [ "accountName", "projectId", "repositoryId", "type" ], "type": "object" }, "RealityConnectorAzureDevopsBranch": { "properties": { "accountName": { "type": "string" }, "branchName": { "type": "string" }, "projectId": { "type": "string" }, "repositoryId": { "type": "string" }, "type": { "enum": [ "azure-devops-branch" ], "type": "string" } }, "required": [ "accountName", "branchName", "projectId", "repositoryId", "type" ], "type": "object" }, "RealityConnectorAzureDevopsFolder": { "properties": { "accountName": { "type": "string" }, "branchName": { "type": "string" }, "path": { "type": "string" }, "projectId": { "type": "string" }, "repositoryId": { "type": "string" }, "type": { "enum": [ "azure-devops-folder" ], "type": "string" } }, "required": [ "accountName", "branchName", "path", "projectId", "repositoryId", "type" ], "type": "object" }, "RealityConnectorAzureDevopsFile": { "properties": { "accountName": { "type": "string" }, "branchName": { "type": "string" }, "path": { "type": "string" }, "projectId": { "type": "string" }, "repositoryId": { "type": "string" }, "type": { "enum": [ "azure-devops-file" ], "type": "string" } }, "required": [ "accountName", "branchName", "path", "projectId", "repositoryId", "type" ], "type": "object" }, "RealityConnectorBitbucketRepo": { "properties": { "projectId": { "type": "string" }, "repositoryId": { "type": "string" }, "type": { "enum": [ "bitbucket-repo" ], "type": "string" }, "workspaceId": { "type": "string" } }, "required": [ "projectId", "repositoryId", "type", "workspaceId" ], "type": "object" }, "RealityConnectorBitbucketBranch": { "properties": { "branchName": { "type": "string" }, "projectId": { "type": "string" }, "repositoryId": { "type": "string" }, "type": { "enum": [ "bitbucket-branch" ], "type": "string" }, "workspaceId": { "type": "string" } }, "required": [ "branchName", "projectId", "repositoryId", "type", "workspaceId" ], "type": "object" }, "RealityConnectorBitbucketFolder": { "properties": { "branchName": { "type": "string" }, "path": { "type": "string" }, "projectId": { "type": "string" }, "repositoryId": { "type": "string" }, "type": { "enum": [ "bitbucket-folder" ], "type": "string" }, "workspaceId": { "type": "string" } }, "required": [ "branchName", "path", "projectId", "repositoryId", "type", "workspaceId" ], "type": "object" }, "RealityConnectorBitbucketFile": { "properties": { "branchName": { "type": "string" }, "path": { "type": "string" }, "projectId": { "type": "string" }, "repositoryId": { "type": "string" }, "type": { "enum": [ "bitbucket-file" ], "type": "string" }, "workspaceId": { "type": "string" } }, "required": [ "branchName", "path", "projectId", "repositoryId", "type", "workspaceId" ], "type": "object" }, "RealityConnectorBitbucketServerRepo": { "properties": { "projectId": { "type": "number" }, "repositoryId": { "type": "number" }, "serverUrl": { "type": "string" }, "type": { "enum": [ "bitbucket-server-repo" ], "type": "string" } }, "required": [ "projectId", "repositoryId", "serverUrl", "type" ], "type": "object" }, "RealityConnectorBitbucketServerBranch": { "properties": { "branchName": { "type": "string" }, "projectId": { "type": "number" }, "repositoryId": { "type": "number" }, "serverUrl": { "type": "string" }, "type": { "enum": [ "bitbucket-server-branch" ], "type": "string" } }, "required": [ "branchName", "projectId", "repositoryId", "serverUrl", "type" ], "type": "object" }, "RealityConnectorBitbucketServerFolder": { "properties": { "branchName": { "type": "string" }, "path": { "type": "string" }, "projectId": { "type": "number" }, "repositoryId": { "type": "number" }, "serverUrl": { "type": "string" }, "type": { "enum": [ "bitbucket-server-folder" ], "type": "string" } }, "required": [ "branchName", "path", "projectId", "repositoryId", "serverUrl", "type" ], "type": "object" }, "RealityConnectorBitbucketServerFile": { "properties": { "branchName": { "type": "string" }, "path": { "type": "string" }, "projectId": { "type": "number" }, "repositoryId": { "type": "number" }, "serverUrl": { "type": "string" }, "type": { "enum": [ "bitbucket-server-file" ], "type": "string" } }, "required": [ "branchName", "path", "projectId", "repositoryId", "serverUrl", "type" ], "type": "object" }, "RealityConnectorGithubRepo": { "properties": { "ownerId": { "type": "number" }, "repositoryId": { "type": "number" }, "type": { "enum": [ "github-repo" ], "type": "string" } }, "required": [ "ownerId", "repositoryId", "type" ], "type": "object" }, "RealityConnectorGithubBranch": { "properties": { "branchName": { "type": "string" }, "ownerId": { "type": "number" }, "repositoryId": { "type": "number" }, "type": { "enum": [ "github-branch" ], "type": "string" } }, "required": [ "branchName", "ownerId", "repositoryId", "type" ], "type": "object" }, "RealityConnectorGithubFolder": { "properties": { "branchName": { "type": "string" }, "ownerId": { "type": "number" }, "path": { "type": "string" }, "repositoryId": { "type": "number" }, "type": { "enum": [ "github-folder" ], "type": "string" } }, "required": [ "branchName", "ownerId", "path", "repositoryId", "type" ], "type": "object" }, "RealityConnectorGithubFile": { "properties": { "branchName": { "type": "string" }, "ownerId": { "type": "number" }, "path": { "type": "string" }, "repositoryId": { "type": "number" }, "type": { "enum": [ "github-file" ], "type": "string" } }, "required": [ "branchName", "ownerId", "path", "repositoryId", "type" ], "type": "object" }, "RealityConnectorGitlabRepo": { "properties": { "projectId": { "type": "number" }, "type": { "enum": [ "gitlab-repo" ], "type": "string" } }, "required": [ "projectId", "type" ], "type": "object" }, "RealityConnectorGitlabBranch": { "properties": { "branchName": { "type": "string" }, "projectId": { "type": "number" }, "type": { "enum": [ "gitlab-branch" ], "type": "string" } }, "required": [ "branchName", "projectId", "type" ], "type": "object" }, "RealityConnectorGitlabFolder": { "properties": { "branchName": { "type": "string" }, "path": { "type": "string" }, "projectId": { "type": "number" }, "type": { "enum": [ "gitlab-folder" ], "type": "string" } }, "required": [ "branchName", "path", "projectId", "type" ], "type": "object" }, "RealityConnectorGitlabFile": { "properties": { "branchName": { "type": "string" }, "path": { "type": "string" }, "projectId": { "type": "number" }, "type": { "enum": [ "gitlab-file" ], "type": "string" } }, "required": [ "branchName", "path", "projectId", "type" ], "type": "object" }, "RealityConnector": { "oneOf": [ { "$ref": "#/components/schemas/RealityConnectorUrl" }, { "$ref": "#/components/schemas/RealityConnectorAzureDevopsRepo" }, { "$ref": "#/components/schemas/RealityConnectorAzureDevopsBranch" }, { "$ref": "#/components/schemas/RealityConnectorAzureDevopsFolder" }, { "$ref": "#/components/schemas/RealityConnectorAzureDevopsFile" }, { "$ref": "#/components/schemas/RealityConnectorBitbucketRepo" }, { "$ref": "#/components/schemas/RealityConnectorBitbucketBranch" }, { "$ref": "#/components/schemas/RealityConnectorBitbucketFolder" }, { "$ref": "#/components/schemas/RealityConnectorBitbucketFile" }, { "$ref": "#/components/schemas/RealityConnectorBitbucketServerRepo" }, { "$ref": "#/components/schemas/RealityConnectorBitbucketServerBranch" }, { "$ref": "#/components/schemas/RealityConnectorBitbucketServerFolder" }, { "$ref": "#/components/schemas/RealityConnectorBitbucketServerFile" }, { "$ref": "#/components/schemas/RealityConnectorGithubRepo" }, { "$ref": "#/components/schemas/RealityConnectorGithubBranch" }, { "$ref": "#/components/schemas/RealityConnectorGithubFolder" }, { "$ref": "#/components/schemas/RealityConnectorGithubFile" }, { "$ref": "#/components/schemas/RealityConnectorGitlabRepo" }, { "$ref": "#/components/schemas/RealityConnectorGitlabBranch" }, { "$ref": "#/components/schemas/RealityConnectorGitlabFolder" }, { "$ref": "#/components/schemas/RealityConnectorGitlabFile" } ] }, "RealityLinkStatus": { "enum": [ "valid", "invalid" ], "type": "string" }, "RealityLinkPartial": { "properties": { "connectionResolveUrl": { "description": "Resolve the connector from a publicly accessible URL", "type": "string" }, "connector": { "$ref": "#/components/schemas/RealityConnector", "description": "Links this to a resource in reality, if set periodic checks are performed and the status is updated" }, "customName": { "description": "Friendly name for the link set by the user", "nullable": true, "type": "string" }, "index": { "type": "number" }, "url": { "description": "Accessible link URL when not using a connector", "type": "string" } }, "type": "object" }, "RealityLinkRequired": { "properties": { "connectionResolveUrl": { "description": "Resolve the connector from a publicly accessible URL", "type": "string" }, "connector": { "$ref": "#/components/schemas/RealityConnector", "description": "Links this to a resource in reality, if set periodic checks are performed and the status is updated" }, "customName": { "description": "Friendly name for the link set by the user", "nullable": true, "type": "string" }, "index": { "type": "number" }, "url": { "description": "Accessible link URL when not using a connector", "type": "string" } }, "type": "object" }, "RealityLink": { "properties": { "connectionResolveUrl": { "description": "Resolve the connector from a publicly accessible URL", "type": "string" }, "connector": { "$ref": "#/components/schemas/RealityConnector", "description": "Links this to a resource in reality, if set periodic checks are performed and the status is updated" }, "customName": { "description": "Friendly name for the link set by the user", "nullable": true, "type": "string" }, "index": { "type": "number" }, "url": { "description": "URL pointing to the resource in reality, resolved from the last sync", "type": "string" }, "errorMessage": { "description": "Error message that was received during the last sync", "type": "string" }, "id": { "description": "Random 20 character identifier", "type": "string" }, "name": { "description": "Friendly name describing the resource in reality, resolved from the last sync", "type": "string" }, "status": { "$ref": "#/components/schemas/RealityLinkStatus", "description": "Response that was received from the last sync with reality" } }, "required": [ "id", "index" ], "type": "object" }, "SearchIndexType": { "enum": [ "actor", "app", "component", "group", "root", "store", "system", "app-diagram", "component-diagram", "context-diagram", "connection", "flow" ], "type": "string" }, "SearchIndexItem": { "properties": { "description": { "type": "string" }, "handleId": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "nameFts": { "type": "string" }, "nameFuzzy": { "type": "string" }, "relations": { "items": { "type": "string" }, "type": "array" }, "relationsFts": { "items": { "type": "string" }, "type": "array" }, "relationsFuzzy": { "items": { "type": "string" }, "type": "array" }, "summary": { "type": "string" }, "type": { "$ref": "#/components/schemas/SearchIndexType" } }, "required": [ "id", "handleId", "name", "nameFts", "nameFuzzy", "type" ], "type": "object" }, "SearchFilter": { "properties": { "type": { "oneOf": [ { "$ref": "#/components/schemas/SearchIndexType" }, { "items": { "$ref": "#/components/schemas/SearchIndexType" }, "maxItems": 50, "type": "array" } ] } }, "type": "object" }, "SearchResultData": { "oneOf": [ { "$ref": "#/components/schemas/ModelObject" }, { "$ref": "#/components/schemas/ModelConnection" }, { "$ref": "#/components/schemas/Diagram" }, { "$ref": "#/components/schemas/Flow" } ] }, "SearchResult": { "properties": { "data": { "$ref": "#/components/schemas/SearchResultData" }, "id": { "type": "string" }, "name": { "type": "string" }, "score": { "type": "number" }, "type": { "$ref": "#/components/schemas/SearchIndexType" } }, "required": [ "id", "name", "score", "type" ], "type": "object" }, "DocumentBroadcastType": { "enum": [ "added", "initial", "modified", "removed" ], "type": "string" }, "QueryBroadcastType": { "enum": [ "added", "initial", "modified", "removed" ], "type": "string" }, "Theme": { "enum": [ "light", "dark" ], "type": "string" } }, "securitySchemes": { "ApiKeyAuth": { "description": "API key authentication", "in": "header", "name": "X-API-Key", "type": "apiKey" }, "BearerAuth": { "description": "Bearer token authentication", "scheme": "bearer", "type": "http" } } }, "info": { "description": "IcePanel API", "summary": "IcePanel API documentation", "title": "IcePanel API", "version": "1.0.0" }, "openapi": "3.1.0", "paths": { "/landscapes/{landscapeId}/action-logs": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Action Logs" ], "x-eov-operation-handler": "actionLogs", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "landscapes", "logs" ], "description": "List action logs", "operationId": "actionLogsList", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/ActionLogFilter" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 1000, "maximum": 10000, "minimum": 1, "type": "number" } }, { "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/SortDirection" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "actionLogs": { "items": { "$ref": "#/components/schemas/ActionLog" }, "type": "array" }, "nextCursor": { "type": "string" } }, "required": [ "actionLogs" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "List", "x-fern-pagination": { "cursor": "$request.cursor", "next_cursor": "$response.nextCursor", "results": "$response.actionLogs" }, "x-fern-request-name": "ActionLogsListRequest", "x-fern-sdk-method-name": "list", "x-ice-panel-operation-subject": "action-log", "x-ice-panel-operation-type": "read" } }, "/landscapes/{landscapeId}/action-logs/{actionLogId}": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Action Logs" ], "x-eov-operation-handler": "actionLogs", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "landscapes", "logs" ], "deprecated": true, "description": "Find an action log", "operationId": "actionLogFind", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "actionLogId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "actionLog": { "$ref": "#/components/schemas/ActionLog" } }, "required": [ "actionLog" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Get", "x-fern-availability": "deprecated", "x-fern-request-name": "ActionLogFindRequest", "x-fern-sdk-method-name": "get", "x-ice-panel-operation-subject": "action-log", "x-ice-panel-operation-type": "read" } }, "/landscapes/{landscapeId}/action-logs/{actionLogId}/children": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Action Logs" ], "x-eov-operation-handler": "actionLogs", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "landscapes", "logs" ], "description": "List actions that happened as a result of a different action", "operationId": "actionLogChildrenList", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "actionLogId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/ActionLogFilter" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 1000, "maximum": 10000, "minimum": 1, "type": "number" } }, { "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/SortDirection" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "actionLogs": { "items": { "$ref": "#/components/schemas/ActionLog" }, "type": "array" }, "nextCursor": { "type": "string" } }, "required": [ "actionLogs" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "List Children", "x-fern-pagination": { "cursor": "$request.cursor", "next_cursor": "$response.nextCursor", "results": "$response.actionLogs" }, "x-fern-request-name": "ActionLogChildrenListRequest", "x-fern-sdk-method-name": "listChildren", "x-ice-panel-operation-subject": "action-log", "x-ice-panel-operation-type": "read" } }, "/landscapes/{landscapeId}/action-logs/stats/by-type": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Action Log Stats" ], "x-eov-operation-handler": "actionLogStats", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "landscapes", "logs", "stats" ], "description": "List total counts of actions for each action type (e.g. diagram-content-update, model-object-create)", "operationId": "actionLogStatsByType", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/ActionLogStatsFilter" } }, { "in": "query", "name": "period", "required": false, "schema": { "$ref": "#/components/schemas/ActionLogStatsPeriod" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionLogStatsListByType" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "By Type", "x-fern-request-name": "ActionLogStatsByTypeRequest", "x-fern-sdk-method-name": "byType", "x-ice-panel-operation-subject": "action-log-stat", "x-ice-panel-operation-type": "read" } }, "/landscapes/{landscapeId}/action-logs/stats/by-entity": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Action Log Stats" ], "x-eov-operation-handler": "actionLogStats", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "landscapes", "logs", "stats" ], "description": "List total counts of actions for each entity identifier", "operationId": "actionLogStatsByEntity", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/ActionLogStatsFilter" } }, { "in": "query", "name": "period", "required": false, "schema": { "$ref": "#/components/schemas/ActionLogStatsPeriod" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionLogStatsListByEntity" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "By Entity", "x-fern-request-name": "ActionLogStatsByEntityRequest", "x-fern-sdk-method-name": "byEntity", "x-ice-panel-operation-subject": "action-log-stat", "x-ice-panel-operation-type": "read" } }, "/landscapes/{landscapeId}/versions/{versionId}/adrs": { "post": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "ADRs" ], "x-eov-operation-handler": "adrs", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "adrs", "operationId": "adrCreate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "$ref": "#/components/schemas/VersionIdPathParam" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ADRRequired" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "adr": { "$ref": "#/components/schemas/ADR" } }, "required": [ "adr" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Create", "x-fern-request-name": "AdrCreateRequest", "x-fern-sdk-method-name": "create", "x-ice-panel-operation-subject": "decision-record", "x-ice-panel-operation-type": "write" }, "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "ADRs" ], "x-eov-operation-handler": "adrs", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "adrs", "operationId": "adrsList", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "$ref": "#/components/schemas/VersionIdPathParam" } }, { "in": "query", "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/ADRFilter" }, "style": "deepObject" }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 1000, "maximum": 10000, "minimum": 1, "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "adrs": { "items": { "$ref": "#/components/schemas/ADR" }, "type": "array" }, "nextCursor": { "type": "string" } }, "required": [ "adrs" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "List", "x-fern-pagination": { "cursor": "$request.cursor", "next_cursor": "$response.nextCursor", "results": "$response.adrs" }, "x-fern-request-name": "AdrsListRequest", "x-fern-sdk-method-name": "list", "x-ice-panel-operation-subject": "decision-record", "x-ice-panel-operation-type": "read" } }, "/landscapes/{landscapeId}/versions/{versionId}/adrs/{adrId}": { "delete": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "ADRs" ], "x-eov-operation-handler": "adrs", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "adrs", "operationId": "adrDelete", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "$ref": "#/components/schemas/VersionIdPathParam" } }, { "in": "path", "name": "adrId", "required": true, "schema": { "format": "id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Delete", "x-fern-request-name": "AdrDeleteRequest", "x-fern-sdk-method-name": "delete", "x-ice-panel-operation-subject": "decision-record", "x-ice-panel-operation-type": "write" }, "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "ADRs" ], "x-eov-operation-handler": "adrs", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "adrs", "operationId": "adrFind", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "$ref": "#/components/schemas/VersionIdPathParam" } }, { "in": "path", "name": "adrId", "required": true, "schema": { "format": "id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "adr": { "$ref": "#/components/schemas/ADR" } }, "required": [ "adr" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Get", "x-fern-request-name": "AdrFindRequest", "x-fern-sdk-method-name": "get", "x-ice-panel-operation-subject": "decision-record", "x-ice-panel-operation-type": "read" }, "patch": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "ADRs" ], "x-eov-operation-handler": "adrs", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "adrs", "operationId": "adrUpdate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "format": "id", "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "$ref": "#/components/schemas/VersionIdPathParam" } }, { "in": "path", "name": "adrId", "required": true, "schema": { "format": "id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ADRPartial" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "adr": { "$ref": "#/components/schemas/ADR" } }, "required": [ "adr" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Update", "x-fern-request-name": "AdrUpdateRequest", "x-fern-sdk-method-name": "update", "x-ice-panel-operation-subject": "decision-record", "x-ice-panel-operation-type": "write" } }, "/catalog/icons/signed-url": { "post": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Catalog Technologies" ], "x-eov-operation-handler": "catalogTechnologies", "x-fern-sdk-group-name": [ "catalog", "technologies" ], "description": "Create a signed URL prefix with access to all catalog icons", "operationId": "catalogIconsSignedUrlCreate", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "signedUrl": { "description": "Signed URL prefix for all catalog icons, you must append the exact icons path, extension supports .svg/.png/.webp/.jpeg, supports size/rounded as query strings, expires in 12 hours", "example": "https://api.icepanel.io/icons/?URLPrefix=aHR0cHM6Ly9tZWRpYS5leGFtcGxlLmNvbS92aWRlb3Mv&Expires=1566268009&KeyName=Key&Signature=8NBSdQGzvDftrOIa3WHpp646Iis=", "type": "string" } }, "required": [ "signedUrl" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Create Signed Icon URL", "x-fern-audiences": [ "public" ], "x-fern-request-name": "CatalogIconsSignedUrlCreateRequest", "x-fern-sdk-method-name": "createSignedIconUrl", "x-ice-panel-operation-subject": "catalog", "x-ice-panel-operation-type": "read", "x-readonly-override": true } }, "/catalog/technologies/{catalogTechnologyId}": { "get": { "security": [], "tags": [ "Catalog Technologies" ], "x-eov-operation-handler": "catalogTechnologies", "x-fern-sdk-group-name": [ "catalog", "technologies" ], "description": "Find a technology", "operationId": "catalogTechnologyFind", "parameters": [ { "in": "path", "name": "catalogTechnologyId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "catalogTechnology": { "$ref": "#/components/schemas/CatalogTechnology" } }, "required": [ "catalogTechnology" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Get", "x-fern-audiences": [ "public" ], "x-fern-request-name": "CatalogTechnologyFindRequest", "x-fern-sdk-method-name": "get", "x-ice-panel-operation-subject": "catalog", "x-ice-panel-operation-type": "read" } }, "/landscapes/{landscapeId}/versions/{versionId}/comments/{commentId}/replies": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Comment Replies" ], "x-eov-operation-handler": "commentReplies", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "comments", "replies" ], "description": "List comment replies", "operationId": "commentRepliesList", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "commentId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "commentReplies": { "items": { "$ref": "#/components/schemas/CommentReply" }, "type": "array" } }, "required": [ "commentReplies" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "List", "x-fern-request-name": "CommentRepliesListRequest", "x-fern-sdk-method-name": "list", "x-ice-panel-operation-subject": "comment", "x-ice-panel-operation-type": "read" }, "post": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Comment Replies" ], "x-eov-operation-handler": "commentReplies", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "comments", "replies" ], "description": "Create a comment reply", "operationId": "commentReplyCreate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "commentId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentReplyRequired" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "commentReply": { "$ref": "#/components/schemas/CommentReply" } }, "required": [ "commentReply" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Create", "x-fern-request-name": "CommentReplyCreateRequest", "x-fern-sdk-method-name": "create", "x-ice-panel-operation-subject": "comment", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/versions/{versionId}/comments/{commentId}/replies/{commentReplyId}": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Comment Replies" ], "x-eov-operation-handler": "commentReplies", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "comments", "replies" ], "description": "Find a comment reply", "operationId": "commentReplyFind", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "commentId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "commentReplyId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "commentReply": { "$ref": "#/components/schemas/CommentReply" } }, "required": [ "commentReply" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Get", "x-fern-request-name": "CommentReplyFindRequest", "x-fern-sdk-method-name": "get", "x-ice-panel-operation-subject": "comment", "x-ice-panel-operation-type": "read" }, "put": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Comment Replies" ], "x-eov-operation-handler": "commentReplies", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "comments", "replies" ], "operationId": "commentReplyUpsert", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "commentId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "commentReplyId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentReplyUpsert" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "commentReply": { "$ref": "#/components/schemas/CommentReply" } }, "required": [ "commentReply" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Upsert", "x-fern-request-name": "CommentReplyUpsertRequest", "x-fern-sdk-method-name": "upsert", "x-ice-panel-operation-subject": "comment", "x-ice-panel-operation-type": "write" }, "patch": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Comment Replies" ], "x-eov-operation-handler": "commentReplies", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "comments", "replies" ], "description": "Update a comment reply", "operationId": "commentReplyUpdate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "commentId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "commentReplyId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentReplyPartial" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "commentReply": { "$ref": "#/components/schemas/CommentReply" } }, "required": [ "commentReply" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Update", "x-fern-request-name": "CommentReplyUpdateRequest", "x-fern-sdk-method-name": "update", "x-ice-panel-operation-subject": "comment", "x-ice-panel-operation-type": "write" }, "delete": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Comment Replies" ], "x-eov-operation-handler": "commentReplies", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "comments", "replies" ], "description": "Delete a comment reply", "operationId": "commentReplyDelete", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "commentId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "commentReplyId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Delete", "x-fern-request-name": "CommentReplyDeleteRequest", "x-fern-sdk-method-name": "delete", "x-ice-panel-operation-subject": "comment", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/versions/{versionId}/comments": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Comments" ], "x-eov-operation-handler": "comments", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "comments", "operationId": "commentsList", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "comments": { "items": { "$ref": "#/components/schemas/Comment" }, "type": "array" } }, "required": [ "comments" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "List", "x-fern-request-name": "CommentsListRequest", "x-fern-sdk-method-name": "list", "x-ice-panel-operation-subject": "comment", "x-ice-panel-operation-type": "read" }, "post": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Comments" ], "x-eov-operation-handler": "comments", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "comments", "operationId": "commentCreate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentRequired" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "comment": { "$ref": "#/components/schemas/Comment" } }, "required": [ "comment" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Create", "x-fern-request-name": "CommentCreateRequest", "x-fern-sdk-method-name": "create", "x-ice-panel-operation-subject": "comment", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/versions/{versionId}/comments/{commentId}": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Comments" ], "x-eov-operation-handler": "comments", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "comments", "operationId": "commentFind", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "commentId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "comment": { "$ref": "#/components/schemas/Comment" } }, "required": [ "comment" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Get", "x-fern-request-name": "CommentFindRequest", "x-fern-sdk-method-name": "get", "x-ice-panel-operation-subject": "comment", "x-ice-panel-operation-type": "read" }, "put": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Comments" ], "x-eov-operation-handler": "comments", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "comments", "operationId": "commentUpsert", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "commentId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentUpsert" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "comment": { "$ref": "#/components/schemas/Comment" } }, "required": [ "comment" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Upsert", "x-fern-request-name": "CommentUpsertRequest", "x-fern-sdk-method-name": "upsert", "x-ice-panel-operation-subject": "comment", "x-ice-panel-operation-type": "write" }, "patch": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Comments" ], "x-eov-operation-handler": "comments", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "comments", "operationId": "commentUpdate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "commentId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentPartial" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "comment": { "$ref": "#/components/schemas/Comment" } }, "required": [ "comment" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Update", "x-fern-request-name": "CommentUpdateRequest", "x-fern-sdk-method-name": "update", "x-ice-panel-operation-subject": "comment", "x-ice-panel-operation-type": "write" }, "delete": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Comments" ], "x-eov-operation-handler": "comments", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "comments", "operationId": "commentDelete", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "commentId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "commit": { "type": "number" } }, "required": [ "commit" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Delete", "x-fern-request-name": "CommentDeleteRequest", "x-fern-sdk-method-name": "delete", "x-ice-panel-operation-subject": "comment", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/versions/{versionId}/diagrams/{diagramId}/content": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Diagram Content" ], "x-eov-operation-handler": "diagramContents", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "diagrams", "content" ], "operationId": "diagramContentFind", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "diagramId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "updateViewedAt", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "diagramContent": { "$ref": "#/components/schemas/DiagramContent" } }, "required": [ "diagramContent" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Get", "x-fern-request-name": "DiagramContentFindRequest", "x-fern-sdk-method-name": "get", "x-ice-panel-operation-subject": "diagram", "x-ice-panel-operation-type": "read" }, "put": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Diagram Content" ], "x-eov-operation-handler": "diagramContents", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "diagrams", "content" ], "operationId": "diagramContentReplace", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "diagramId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "updateViewedAt", "required": false, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagramContentRequired" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "diagramContent": { "$ref": "#/components/schemas/DiagramContent" } }, "required": [ "diagramContent" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Replace", "x-fern-request-name": "DiagramContentReplaceRequest", "x-fern-sdk-method-name": "replace", "x-ice-panel-operation-subject": "diagram", "x-ice-panel-operation-type": "write" }, "patch": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Diagram Content" ], "x-eov-operation-handler": "diagramContents", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "diagrams", "content" ], "operationId": "diagramContentUpdate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "diagramId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "updateViewedAt", "required": false, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagramContentPartial" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "diagramContent": { "$ref": "#/components/schemas/DiagramContent" } }, "required": [ "diagramContent" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Update", "x-fern-request-name": "DiagramContentUpdateRequest", "x-fern-sdk-method-name": "update", "x-ice-panel-operation-subject": "diagram", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/versions/{versionId}/diagram-groups": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Diagram Groups" ], "x-eov-operation-handler": "diagramGroups", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "diagrams", "groups" ], "operationId": "diagramGroupsList", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/DiagramGroupFilter" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "diagramGroups": { "items": { "$ref": "#/components/schemas/DiagramGroup" }, "type": "array" } }, "required": [ "diagramGroups" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "List", "x-fern-request-name": "DiagramGroupsListRequest", "x-fern-sdk-method-name": "list", "x-ice-panel-operation-subject": "diagram", "x-ice-panel-operation-type": "read" }, "post": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Diagram Groups" ], "x-eov-operation-handler": "diagramGroups", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "diagrams", "groups" ], "operationId": "diagramGroupCreate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagramGroupRequired" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "diagramGroup": { "$ref": "#/components/schemas/DiagramGroup" } }, "required": [ "diagramGroup" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Create", "x-fern-request-name": "DiagramGroupCreateRequest", "x-fern-sdk-method-name": "create", "x-ice-panel-operation-subject": "diagram", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/versions/{versionId}/diagram-groups/{diagramGroupId}": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Diagram Groups" ], "x-eov-operation-handler": "diagramGroups", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "diagrams", "groups" ], "operationId": "diagramGroupFind", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "diagramGroupId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "diagramGroup": { "$ref": "#/components/schemas/DiagramGroup" } }, "required": [ "diagramGroup" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Get", "x-fern-request-name": "DiagramGroupFindRequest", "x-fern-sdk-method-name": "get", "x-ice-panel-operation-subject": "diagram", "x-ice-panel-operation-type": "read" }, "head": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Diagram Groups" ], "x-eov-operation-handler": "diagramGroups", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "diagrams", "groups" ], "operationId": "diagramGroupExists", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "diagramGroupId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server" } }, "summary": "Exists", "x-fern-request-name": "DiagramGroupExistsRequest", "x-fern-sdk-method-name": "exists", "x-ice-panel-operation-subject": "diagram", "x-ice-panel-operation-type": "read" }, "put": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Diagram Groups" ], "x-eov-operation-handler": "diagramGroups", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "diagrams", "groups" ], "operationId": "diagramGroupUpsert", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "diagramGroupId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagramGroupUpsert" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "diagramGroup": { "$ref": "#/components/schemas/DiagramGroup" } }, "required": [ "diagramGroup" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Upsert", "x-fern-request-name": "DiagramGroupUpsertRequest", "x-fern-sdk-method-name": "upsert", "x-ice-panel-operation-subject": "diagram", "x-ice-panel-operation-type": "write" }, "patch": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Diagram Groups" ], "x-eov-operation-handler": "diagramGroups", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "diagrams", "groups" ], "operationId": "diagramGroupUpdate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "diagramGroupId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagramGroupPartial" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "diagramGroup": { "$ref": "#/components/schemas/DiagramGroup" } }, "required": [ "diagramGroup" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Update", "x-fern-request-name": "DiagramGroupUpdateRequest", "x-fern-sdk-method-name": "update", "x-ice-panel-operation-subject": "diagram", "x-ice-panel-operation-type": "write" }, "delete": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Diagram Groups" ], "x-eov-operation-handler": "diagramGroups", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "diagrams", "groups" ], "operationId": "diagramGroupDelete", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "diagramGroupId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "commit": { "type": "number" } }, "required": [ "commit" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Delete", "x-fern-request-name": "DiagramGroupDeleteRequest", "x-fern-sdk-method-name": "delete", "x-ice-panel-operation-subject": "diagram", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/versions/{versionId}/diagrams": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Diagrams" ], "x-eov-operation-handler": "diagrams", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "diagrams", "operationId": "diagramsList", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/DiagramFilter" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "diagrams": { "items": { "$ref": "#/components/schemas/Diagram" }, "type": "array" } }, "required": [ "diagrams" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "List", "x-fern-request-name": "DiagramsListRequest", "x-fern-sdk-method-name": "list", "x-ice-panel-operation-subject": "diagram", "x-ice-panel-operation-type": "read" }, "post": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Diagrams" ], "x-eov-operation-handler": "diagrams", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "diagrams", "operationId": "diagramCreate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "updateViewedAt", "required": false, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagramCreate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "diagram": { "$ref": "#/components/schemas/Diagram" }, "diagramContent": { "$ref": "#/components/schemas/DiagramContent" } }, "required": [ "diagram", "diagramContent" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Create", "x-fern-request-name": "DiagramCreateRequest", "x-fern-sdk-method-name": "create", "x-ice-panel-operation-subject": "diagram", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/versions/{versionId}/diagrams/{diagramId}": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Diagrams" ], "x-eov-operation-handler": "diagrams", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "diagrams", "operationId": "diagramFind", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "diagramId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "updateViewedAt", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "diagram": { "$ref": "#/components/schemas/Diagram" } }, "required": [ "diagram" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Get", "x-fern-request-name": "DiagramFindRequest", "x-fern-sdk-method-name": "get", "x-ice-panel-operation-subject": "diagram", "x-ice-panel-operation-type": "read" }, "head": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Diagrams" ], "x-eov-operation-handler": "diagrams", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "diagrams", "operationId": "diagramExists", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "diagramId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "updateViewedAt", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server" } }, "summary": "Exists", "x-fern-request-name": "DiagramExistsRequest", "x-fern-sdk-method-name": "exists", "x-ice-panel-operation-subject": "diagram", "x-ice-panel-operation-type": "read" }, "put": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Diagrams" ], "x-eov-operation-handler": "diagrams", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "diagrams", "operationId": "diagramUpsert", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "diagramId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "updateViewedAt", "required": false, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagramCreate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "diagram": { "$ref": "#/components/schemas/Diagram" }, "diagramContent": { "$ref": "#/components/schemas/DiagramContent" } }, "required": [ "diagram" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Upsert", "x-fern-request-name": "DiagramUpsertRequest", "x-fern-sdk-method-name": "upsert", "x-ice-panel-operation-subject": "diagram", "x-ice-panel-operation-type": "write" }, "patch": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Diagrams" ], "x-eov-operation-handler": "diagrams", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "diagrams", "operationId": "diagramUpdate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "diagramId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "updateViewedAt", "required": false, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagramUpsert" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "diagram": { "$ref": "#/components/schemas/Diagram" }, "diagramContent": { "$ref": "#/components/schemas/DiagramContent" } }, "required": [ "diagram" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Update", "x-fern-request-name": "DiagramUpdateRequest", "x-fern-sdk-method-name": "update", "x-ice-panel-operation-subject": "diagram", "x-ice-panel-operation-type": "write" }, "delete": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Diagrams" ], "x-eov-operation-handler": "diagrams", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "diagrams", "operationId": "diagramDelete", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "diagramId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "updateViewedAt", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "commit": { "type": "number" } }, "required": [ "commit" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Delete", "x-fern-request-name": "DiagramDeleteRequest", "x-fern-sdk-method-name": "delete", "x-ice-panel-operation-subject": "diagram", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/versions/{versionId}/diagrams/{diagramId}/export/image/{diagramExportImageId}": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Diagrams" ], "x-eov-operation-handler": "diagrams", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "diagrams", "export" ], "operationId": "diagramExportImageFind", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "diagramId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "diagramExportImageId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "diagramExportImage": { "$ref": "#/components/schemas/DiagramExportImage" } }, "required": [ "diagramExportImage" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Get", "x-fern-request-name": "DiagramExportImageFindRequest", "x-fern-sdk-method-name": "get", "x-ice-panel-operation-subject": "diagram", "x-ice-panel-operation-type": "read" } }, "/landscapes/{landscapeId}/versions/{versionId}/diagrams/{diagramId}/export/image": { "post": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Diagrams" ], "x-eov-operation-handler": "diagrams", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "diagrams", "export" ], "operationId": "diagramExportImageCreate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "diagramId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagramExportImageOptions" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "diagramExportImage": { "$ref": "#/components/schemas/DiagramExportImage" } }, "required": [ "diagramExportImage" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Create", "x-fern-request-name": "DiagramExportImageCreateRequest", "x-fern-sdk-method-name": "create", "x-ice-panel-operation-subject": "diagram", "x-ice-panel-operation-type": "export", "x-readonly-override": true } }, "/landscapes/{landscapeId}/versions/{versionId}/diagrams/thumbnails": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Diagrams" ], "x-eov-operation-handler": "diagrams", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "diagrams", "operationId": "diagramThumbnailsList", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/DiagramFilter" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "thumbnails": { "additionalProperties": { "$ref": "#/components/schemas/DiagramThumbnail" }, "type": "object" } }, "required": [ "thumbnails" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "List Thumbnails", "x-fern-request-name": "DiagramThumbnailsListRequest", "x-fern-sdk-method-name": "listThumbnails", "x-ice-panel-operation-subject": "diagram", "x-ice-panel-operation-type": "read" } }, "/landscapes/{landscapeId}/versions/{versionId}/diagrams/{diagramId}/thumbnail": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Diagrams" ], "x-eov-operation-handler": "diagrams", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "diagrams", "operationId": "diagramThumbnailGet", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "diagramId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "thumbnail": { "$ref": "#/components/schemas/DiagramThumbnail" } }, "required": [ "thumbnail" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Get Thumbnail", "x-fern-request-name": "DiagramThumbnailGetRequest", "x-fern-sdk-method-name": "getThumbnail", "x-ice-panel-operation-subject": "diagram", "x-ice-panel-operation-type": "read" } }, "/landscapes/{landscapeId}/versions/{versionId}/domains": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Domains" ], "x-eov-operation-handler": "domains", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "domains", "operationId": "domainsList", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/DomainFilter" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "domains": { "items": { "$ref": "#/components/schemas/Domain" }, "type": "array" } }, "required": [ "domains" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "List", "x-fern-request-name": "DomainsListRequest", "x-fern-sdk-method-name": "list", "x-ice-panel-operation-subject": "domain", "x-ice-panel-operation-type": "read" }, "post": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Domains" ], "x-eov-operation-handler": "domains", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "domains", "operationId": "domainCreate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainRequired" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "domain": { "$ref": "#/components/schemas/Domain" } }, "required": [ "domain" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Create", "x-fern-request-name": "DomainCreateRequest", "x-fern-sdk-method-name": "create", "x-ice-panel-operation-subject": "domain", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/versions/{versionId}/domains/{domainId}": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Domains" ], "x-eov-operation-handler": "domains", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "domains", "operationId": "domainFind", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "domainId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "domain": { "$ref": "#/components/schemas/Domain" } }, "required": [ "domain" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Get", "x-fern-request-name": "DomainFindRequest", "x-fern-sdk-method-name": "get", "x-ice-panel-operation-subject": "domain", "x-ice-panel-operation-type": "read" }, "head": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Domains" ], "x-eov-operation-handler": "domains", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "domains", "operationId": "domainExists", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "domainId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server" } }, "summary": "Exists", "x-fern-request-name": "DomainExistsRequest", "x-fern-sdk-method-name": "exists", "x-ice-panel-operation-subject": "domain", "x-ice-panel-operation-type": "read" }, "put": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Domains" ], "x-eov-operation-handler": "domains", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "domains", "operationId": "domainUpsert", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "domainId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainUpsert" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "domain": { "$ref": "#/components/schemas/Domain" } }, "required": [ "domain" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Upsert", "x-fern-request-name": "DomainUpsertRequest", "x-fern-sdk-method-name": "upsert", "x-ice-panel-operation-subject": "domain", "x-ice-panel-operation-type": "write" }, "patch": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Domains" ], "x-eov-operation-handler": "domains", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "domains", "operationId": "domainUpdate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "domainId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainPartial" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "domain": { "$ref": "#/components/schemas/Domain" } }, "required": [ "domain" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Update", "x-fern-request-name": "DomainUpdateRequest", "x-fern-sdk-method-name": "update", "x-ice-panel-operation-subject": "domain", "x-ice-panel-operation-type": "write" }, "delete": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Domains" ], "x-eov-operation-handler": "domains", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "domains", "operationId": "domainDelete", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "domainId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "commit": { "type": "number" } }, "required": [ "commit" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Delete", "x-fern-request-name": "DomainDeleteRequest", "x-fern-sdk-method-name": "delete", "x-ice-panel-operation-subject": "domain", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/versions/{versionId}/drafts": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Drafts" ], "x-eov-operation-handler": "drafts", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "drafts", "operationId": "draftsList", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/DraftFilter" }, "style": "deepObject" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "drafts": { "items": { "$ref": "#/components/schemas/Draft" }, "type": "array" } }, "required": [ "drafts" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "List", "x-fern-request-name": "DraftsListRequest", "x-fern-sdk-method-name": "list", "x-ice-panel-operation-subject": "draft", "x-ice-panel-operation-type": "read" }, "post": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Drafts" ], "x-eov-operation-handler": "drafts", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "drafts", "operationId": "draftCreate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftRequired" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "draft": { "$ref": "#/components/schemas/Draft" } }, "required": [ "draft" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Create", "x-fern-request-name": "DraftCreateRequest", "x-fern-sdk-method-name": "create", "x-ice-panel-operation-subject": "draft", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/versions/{versionId}/drafts/{draftId}": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Drafts" ], "x-eov-operation-handler": "drafts", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "drafts", "operationId": "draftFind", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "draftId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "draft": { "$ref": "#/components/schemas/Draft" } }, "required": [ "draft" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Get", "x-fern-request-name": "DraftFindRequest", "x-fern-sdk-method-name": "get", "x-ice-panel-operation-subject": "draft", "x-ice-panel-operation-type": "read" }, "patch": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Drafts" ], "x-eov-operation-handler": "drafts", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "drafts", "operationId": "draftUpdate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "draftId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftPartial" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "draft": { "$ref": "#/components/schemas/Draft" } }, "required": [ "draft" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Update", "x-fern-request-name": "DraftUpdateRequest", "x-fern-sdk-method-name": "update", "x-ice-panel-operation-subject": "draft", "x-ice-panel-operation-type": "write" }, "put": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Drafts" ], "x-eov-operation-handler": "drafts", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "drafts", "operationId": "draftUpsert", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "draftId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DraftRequired" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "draft": { "$ref": "#/components/schemas/Draft" } }, "required": [ "draft" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Upsert", "x-fern-request-name": "DraftUpsertRequest", "x-fern-sdk-method-name": "upsert", "x-ice-panel-operation-subject": "draft", "x-ice-panel-operation-type": "write" }, "delete": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Drafts" ], "x-eov-operation-handler": "drafts", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "drafts", "operationId": "draftDelete", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "draftId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Delete", "x-fern-request-name": "DraftDeleteRequest", "x-fern-sdk-method-name": "delete", "x-ice-panel-operation-subject": "draft", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/versions/{versionId}/drafts/{draftId}/merge": { "post": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Drafts" ], "x-eov-operation-handler": "drafts", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "drafts", "operationId": "draftMerge", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "draftId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "draft": { "$ref": "#/components/schemas/Draft" } }, "required": [ "draft" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Merge", "x-fern-request-name": "DraftMergeRequest", "x-fern-sdk-method-name": "merge", "x-ice-panel-operation-subject": "draft", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/versions/{versionId}/flows": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Flows" ], "x-eov-operation-handler": "flows", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "flows", "operationId": "flowsList", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/FlowFilter" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "flows": { "items": { "$ref": "#/components/schemas/Flow" }, "type": "array" } }, "required": [ "flows" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "List", "x-fern-request-name": "FlowsListRequest", "x-fern-sdk-method-name": "list", "x-ice-panel-operation-subject": "flow", "x-ice-panel-operation-type": "read" }, "post": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Flows" ], "x-eov-operation-handler": "flows", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "flows", "operationId": "flowCreate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowRequired" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "flow": { "$ref": "#/components/schemas/Flow" } }, "required": [ "flow" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Create", "x-fern-request-name": "FlowCreateRequest", "x-fern-sdk-method-name": "create", "x-ice-panel-operation-subject": "flow", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/versions/{versionId}/flows/{flowId}": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Flows" ], "x-eov-operation-handler": "flows", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "flows", "operationId": "flowFind", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "flowId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "flow": { "$ref": "#/components/schemas/Flow" } }, "required": [ "flow" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Get", "x-fern-request-name": "FlowFindRequest", "x-fern-sdk-method-name": "get", "x-ice-panel-operation-subject": "flow", "x-ice-panel-operation-type": "read" }, "head": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Flows" ], "x-eov-operation-handler": "flows", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "flows", "operationId": "flowExists", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "flowId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "404": { "description": "Not Found" }, "422": { "description": "Unprocessable Entity" }, "429": { "description": "Too Many Requests" }, "500": { "description": "Internal Server" } }, "summary": "Exists", "x-fern-request-name": "FlowExistsRequest", "x-fern-sdk-method-name": "exists", "x-ice-panel-operation-subject": "flow", "x-ice-panel-operation-type": "read" }, "put": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Flows" ], "x-eov-operation-handler": "flows", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "flows", "operationId": "flowUpsert", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "flowId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowRequired" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "flow": { "$ref": "#/components/schemas/Flow" } }, "required": [ "flow" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Upsert", "x-fern-request-name": "FlowUpsertRequest", "x-fern-sdk-method-name": "upsert", "x-ice-panel-operation-subject": "flow", "x-ice-panel-operation-type": "write" }, "patch": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Flows" ], "x-eov-operation-handler": "flows", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "flows", "operationId": "flowUpdate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "flowId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlowPartial" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "flow": { "$ref": "#/components/schemas/Flow" } }, "required": [ "flow" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Update", "x-fern-request-name": "FlowUpdateRequest", "x-fern-sdk-method-name": "update", "x-ice-panel-operation-subject": "flow", "x-ice-panel-operation-type": "write" }, "delete": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Flows" ], "x-eov-operation-handler": "flows", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "flows", "operationId": "flowDelete", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "flowId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "commit": { "type": "number" } }, "required": [ "commit" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Delete", "x-fern-request-name": "FlowDeleteRequest", "x-fern-sdk-method-name": "delete", "x-ice-panel-operation-subject": "flow", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/versions/{versionId}/flows/thumbnails": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Flows" ], "x-eov-operation-handler": "flows", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "flows", "operationId": "flowThumbnailsList", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/DiagramFilter" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "thumbnails": { "additionalProperties": { "$ref": "#/components/schemas/FlowThumbnail" }, "type": "object" } }, "required": [ "thumbnails" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "List Thumbnails", "x-fern-request-name": "FlowThumbnailsListRequest", "x-fern-sdk-method-name": "listThumbnails", "x-ice-panel-operation-subject": "flow", "x-ice-panel-operation-type": "read" } }, "/landscapes/{landscapeId}/versions/{versionId}/flows/{flowId}/thumbnail": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Flows" ], "x-eov-operation-handler": "flows", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "flows", "operationId": "flowThumbnailGet", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "flowId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "thumbnail": { "$ref": "#/components/schemas/FlowThumbnail" } }, "required": [ "thumbnail" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Get Thumbnail", "x-fern-request-name": "FlowThumbnailGetRequest", "x-fern-sdk-method-name": "getThumbnail", "x-ice-panel-operation-subject": "flow", "x-ice-panel-operation-type": "read" } }, "/landscapes/{landscapeId}/versions/{versionId}/flows/{flowId}/export/text": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Flows" ], "x-eov-operation-handler": "flows", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "flows", "export" ], "operationId": "flowExportText", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "flowId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "text/plain": {} }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Text", "x-fern-request-name": "FlowExportTextRequest", "x-fern-sdk-method-name": "text", "x-ice-panel-operation-subject": "flow", "x-ice-panel-operation-type": "export" } }, "/landscapes/{landscapeId}/versions/{versionId}/flows/{flowId}/export/code": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Flows" ], "x-eov-operation-handler": "flows", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "flows", "export" ], "operationId": "flowExportCode", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "flowId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "text/plain": {} }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Code", "x-fern-request-name": "FlowExportCodeRequest", "x-fern-sdk-method-name": "code", "x-ice-panel-operation-subject": "flow", "x-ice-panel-operation-type": "export" } }, "/landscapes/{landscapeId}/versions/{versionId}/flows/{flowId}/export/mermaid": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Flows" ], "x-eov-operation-handler": "flows", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "flows", "export" ], "operationId": "flowExportMermaid", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "flowId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "text/plain": {} }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Mermaid", "x-fern-request-name": "FlowExportMermaidRequest", "x-fern-sdk-method-name": "mermaid", "x-ice-panel-operation-subject": "flow", "x-ice-panel-operation-type": "export" } }, "/landscapes/{landscapeId}": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Landscape" ], "x-eov-operation-handler": "landscapes", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "landscapes", "operationId": "landscapeFind", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "landscape": { "$ref": "#/components/schemas/Landscape" } }, "required": [ "landscape" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Get", "x-fern-request-name": "LandscapeFindRequest", "x-fern-sdk-method-name": "get", "x-ice-panel-operation-subject": "landscape", "x-ice-panel-operation-type": "read" }, "patch": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Landscape" ], "x-eov-operation-handler": "landscapes", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "landscapes", "operationId": "landscapeUpdate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LandscapePartial" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "landscape": { "$ref": "#/components/schemas/Landscape" } }, "required": [ "landscape" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Update", "x-fern-request-name": "LandscapeUpdateRequest", "x-fern-sdk-method-name": "update", "x-ice-panel-operation-subject": "landscape", "x-ice-panel-operation-type": "write" }, "delete": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Landscape" ], "x-eov-operation-handler": "landscapes", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "landscapes", "operationId": "landscapeDelete", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Delete", "x-fern-request-name": "LandscapeDeleteRequest", "x-fern-sdk-method-name": "delete", "x-ice-panel-operation-subject": "landscape", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/duplicate": { "post": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Landscape" ], "x-eov-operation-handler": "landscapes", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "landscapes", "operationId": "landscapeDuplicate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "targetOrganizationId", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LandscapeRequired" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "landscape": { "$ref": "#/components/schemas/Landscape" } }, "required": [ "landscape" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Duplicate", "x-fern-request-name": "LandscapeDuplicateRequest", "x-fern-sdk-method-name": "duplicate", "x-ice-panel-operation-subject": "landscape", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/copy": { "post": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Landscape" ], "x-eov-operation-handler": "landscapes", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "landscapes", "operationId": "landscapeCopy", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "targetLandscapeId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Copy", "x-fern-request-name": "LandscapeCopyRequest", "x-fern-sdk-method-name": "copy", "x-ice-panel-operation-subject": "landscape", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/versions/{versionId}/search": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Landscape" ], "x-eov-operation-handler": "landscapes", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "landscapes", "description": "Search the entire landscape", "operationId": "landscapeSearch", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "allowReserved": true, "in": "query", "name": "search", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/SearchFilter" } }, { "in": "query", "name": "includeData", "required": false, "schema": { "type": "boolean" } }, { "in": "query", "name": "maxResults", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "results": { "items": { "$ref": "#/components/schemas/SearchResult" }, "type": "array" } }, "required": [ "results" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Search", "x-fern-request-name": "LandscapeSearchRequest", "x-fern-sdk-method-name": "search", "x-ice-panel-operation-subject": "landscape", "x-ice-panel-operation-type": "read" } }, "/landscapes/{landscapeId}/versions/{versionId}/export": { "post": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Landscape" ], "x-eov-operation-handler": "landscapes", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "landscapes", "export" ], "x-readonly-override": true, "description": "Create a background job that exports a landscape in the specified format.", "operationId": "landscapeExport", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "type", "required": true, "schema": { "$ref": "#/components/schemas/LandscapeExportType" } }, { "in": "query", "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/LandscapeExportFilter" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LandscapeExportOptions" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "landscapeExport": { "$ref": "#/components/schemas/LandscapeExport" } }, "required": [ "landscapeExport" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Export", "x-fern-request-name": "LandscapeExportRequest", "x-fern-sdk-method-name": "create", "x-ice-panel-operation-subject": "landscape", "x-ice-panel-operation-type": "export" } }, "/landscapes/{landscapeId}/versions/{versionId}/export/{landscapeExportId}": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Landscape" ], "x-eov-operation-handler": "landscapes", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "landscapes", "export" ], "x-readonly-override": true, "description": "Get the status of a landscape export job.", "operationId": "landscapeExportFind", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "landscapeExportId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "landscapeExport": { "$ref": "#/components/schemas/LandscapeExport" } }, "required": [ "landscapeExport" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Status", "x-fern-request-name": "LandscapeExportFindRequest", "x-fern-sdk-method-name": "get", "x-ice-panel-operation-subject": "landscape", "x-ice-panel-operation-type": "read" } }, "/landscapes/{landscapeId}/versions/{versionId}/import": { "post": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Landscape" ], "x-eov-operation-handler": "landscapes", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "landscapes", "import" ], "description": "Create a background job that imports a landscape from JSON format.\n\nThe `JSONSchema` can be accessed at `api.icepanel.io/v1/schemas/LandscapeImportData` for automations or using LLMs for generation.", "operationId": "landscapeImport", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "description": "When enabled, entities that are missing from the import will be deleted.", "in": "query", "name": "prune", "required": false, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LandscapeImportData" } }, "application/yaml": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "landscapeImport": { "$ref": "#/components/schemas/LandscapeImport" } }, "required": [ "landscapeImport" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Import", "x-fern-request-name": "LandscapeImportRequest", "x-fern-sdk-method-name": "create", "x-ice-panel-operation-subject": "landscape", "x-ice-panel-operation-type": "import" } }, "/landscapes/{landscapeId}/versions/{versionId}/import/{landscapeImportId}": { "get": { "description": "Get the status of a landscape import job.", "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Landscape" ], "x-eov-operation-handler": "landscapes", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "landscapes", "import" ], "operationId": "landscapeImportFind", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "landscapeImportId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "landscapeImport": { "$ref": "#/components/schemas/LandscapeImport" } }, "required": [ "landscapeImport" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Status", "x-fern-request-name": "LandscapeImportGetRequest", "x-fern-sdk-method-name": "get", "x-ice-panel-operation-subject": "landscape", "x-ice-panel-operation-type": "read" } }, "/landscapes/{landscapeId}/versions/{versionId}/model/connections": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Model Connections" ], "x-eov-operation-handler": "modelConnections", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "model", "connections" ], "operationId": "modelConnectionsList", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/ModelConnectionFilter" } }, { "in": "query", "name": "expand", "required": false, "schema": { "items": { "$ref": "#/components/schemas/ModelConnectionExpandKey" }, "type": "array" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "modelConnections": { "items": { "$ref": "#/components/schemas/ModelConnectionExpanded" }, "type": "array" }, "nextCursor": { "type": "string" } }, "required": [ "modelConnections" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "List", "x-fern-pagination": { "cursor": "$request.cursor", "next_cursor": "$response.nextCursor", "results": "$response.modelConnections" }, "x-fern-request-name": "ModelConnectionsListRequest", "x-fern-sdk-method-name": "list", "x-ice-panel-operation-subject": "model-connection", "x-ice-panel-operation-type": "read" }, "post": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Model Connections" ], "x-eov-operation-handler": "modelConnections", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "model", "connections" ], "operationId": "modelConnectionCreate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelConnectionRequired" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "modelConnection": { "$ref": "#/components/schemas/ModelConnection" } }, "required": [ "modelConnection" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Create", "x-fern-request-name": "ModelConnectionCreateRequest", "x-fern-sdk-method-name": "create", "x-ice-panel-operation-subject": "model-connection", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/versions/{versionId}/model/connections/{modelConnectionId}": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Model Connections" ], "x-eov-operation-handler": "modelConnections", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "model", "connections" ], "operationId": "modelConnectionFind", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "modelConnectionId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "items": { "$ref": "#/components/schemas/ModelConnectionExpandKey" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "modelConnection": { "$ref": "#/components/schemas/ModelConnectionExpanded" } }, "required": [ "modelConnection" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Get", "x-fern-request-name": "ModelConnectionFindRequest", "x-fern-sdk-method-name": "get", "x-ice-panel-operation-subject": "model-connection", "x-ice-panel-operation-type": "read" }, "put": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Model Connections" ], "x-eov-operation-handler": "modelConnections", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "model", "connections" ], "operationId": "modelConnectionUpsert", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "modelConnectionId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "originConnector", "required": false, "schema": { "enum": [ "top-left", "top-center", "top-right", "right-top", "right-middle", "right-bottom", "bottom-right", "bottom-center", "bottom-left", "left-bottom", "left-middle", "left-top" ], "type": "string" } }, { "in": "query", "name": "targetConnector", "required": false, "schema": { "enum": [ "top-left", "top-center", "top-right", "right-top", "right-middle", "right-bottom", "bottom-right", "bottom-center", "bottom-left", "left-bottom", "left-middle", "left-top" ], "type": "string" } }, { "in": "query", "name": "updateDiagrams", "required": false, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelConnectionUpsert" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "modelConnection": { "$ref": "#/components/schemas/ModelConnection" } }, "required": [ "modelConnection" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Upsert", "x-fern-request-name": "ModelConnectionUpsertRequest", "x-fern-sdk-method-name": "upsert", "x-ice-panel-operation-subject": "model-connection", "x-ice-panel-operation-type": "write" }, "patch": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Model Connections" ], "x-eov-operation-handler": "modelConnections", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "model", "connections" ], "operationId": "modelConnectionUpdate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "modelConnectionId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "updateDiagrams", "required": false, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelConnectionPartial" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "modelConnection": { "$ref": "#/components/schemas/ModelConnection" } }, "required": [ "modelConnection" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Update", "x-fern-request-name": "ModelConnectionUpdateRequest", "x-fern-sdk-method-name": "update", "x-ice-panel-operation-subject": "model-connection", "x-ice-panel-operation-type": "write" }, "delete": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Model Connections" ], "x-eov-operation-handler": "modelConnections", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "model", "connections" ], "operationId": "modelConnectionDelete", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "modelConnectionId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "commit": { "type": "number" } }, "required": [ "commit" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Delete", "x-fern-request-name": "ModelConnectionDeleteRequest", "x-fern-sdk-method-name": "delete", "x-ice-panel-operation-subject": "model-connection", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/versions/{versionId}/model/connections/export/csv": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Model Connections" ], "x-eov-operation-handler": "modelConnections", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "model", "connections", "export" ], "deprecated": true, "description": "Use the /landscapes/{landscapeId}/versions/{versionId}/export endpoint with type=connection-csv instead", "operationId": "modelConnectionsExportCsv", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "CSV", "x-fern-availability": "deprecated", "x-fern-request-name": "ModelConnectionsExportCsvRequest", "x-fern-sdk-method-name": "csv", "x-ice-panel-operation-subject": "model-connection", "x-ice-panel-operation-type": "export" } }, "/landscapes/{landscapeId}/versions/{versionId}/model/connections/{modelConnectionId}/generate-description": { "post": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Model Connections" ], "x-eov-operation-handler": "modelConnections", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "model", "connections" ], "description": "Generate a description for a model connection", "operationId": "modelConnectionGenerateDescription", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "modelConnectionId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "type": { "$ref": "#/components/schemas/AIDescriptionType", "description": "Type of description to generate: \"caption\" for a short caption(50-70 characters), or \"detailed\" for a detailed description (max 2000 characters)" } }, "required": [ "type" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "description": { "description": "AI-generated description of the model connection", "type": "string" } }, "required": [ "description" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Generate Description", "x-fern-request-name": "ModelConnectionGenerateDescriptionRequest", "x-fern-sdk-method-name": "generateDescription", "x-ice-panel-operation-subject": "model-connection", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/versions/{versionId}/model/dependencies": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Model Objects" ], "x-eov-operation-handler": "modelDependencies", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "model", "objects" ], "description": "Returns the incoming and outgoing dependencies for each requested object. Objects can be specified by ID or by label key-value pairs (or both): label pairs use OR semantics so an object matching any pair is included. Results are filtered by tags and/or technologies when provided: within each filter array the semantics are OR (any match passes), and between the two filter dimensions the semantics are AND (an object must satisfy both when both are specified).", "operationId": "modelObjectDependenciesList", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "description": "Object selection and dependency filters.", "in": "query", "name": "filter", "required": true, "schema": { "$ref": "#/components/schemas/ModelDependenciesFilter" }, "style": "deepObject" } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "properties": { "incoming": { "additionalProperties": { "$ref": "#/components/schemas/ModelObject" }, "description": "Objects that depend on this object (have a connection pointing to it).", "type": "object" }, "outgoing": { "additionalProperties": { "$ref": "#/components/schemas/ModelObject" }, "description": "Objects that this object depends on (has a connection pointing to them).", "type": "object" } }, "required": [ "incoming", "outgoing" ], "type": "object" }, "description": "Map of object ID to its resolved incoming and outgoing dependencies.", "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "List Dependencies", "x-fern-request-name": "ModelObjectDependenciesListRequest", "x-fern-sdk-method-name": "dependenciesList", "x-ice-panel-operation-subject": "model-object", "x-ice-panel-operation-type": "read" } }, "/landscapes/{landscapeId}/versions/{versionId}/model/objects": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Model Objects" ], "x-eov-operation-handler": "modelObjects", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "model", "objects" ], "operationId": "modelObjectsList", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/ModelObjectFilter" } }, { "in": "query", "name": "expand", "required": false, "schema": { "items": { "$ref": "#/components/schemas/ModelObjectExpandKey" }, "type": "array" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "format": "id", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "modelObjects": { "items": { "$ref": "#/components/schemas/ModelObjectExpanded" }, "type": "array" }, "nextCursor": { "type": "string" } }, "required": [ "modelObjects" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "List", "x-fern-pagination": { "cursor": "$request.cursor", "next_cursor": "$response.nextCursor", "results": "$response.modelObjects" }, "x-fern-request-name": "ModelObjectsListRequest", "x-fern-sdk-method-name": "list", "x-ice-panel-operation-subject": "model-object", "x-ice-panel-operation-type": "read" }, "post": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Model Objects" ], "x-eov-operation-handler": "modelObjects", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "model", "objects" ], "operationId": "modelObjectCreate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelObjectRequired" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "modelObject": { "$ref": "#/components/schemas/ModelObject" } }, "required": [ "modelObject" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Create", "x-fern-request-name": "ModelObjectCreateRequest", "x-fern-sdk-method-name": "create", "x-ice-panel-operation-subject": "model-object", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/versions/{versionId}/model/objects/{modelObjectId}": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Model Objects" ], "x-eov-operation-handler": "modelObjects", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "model", "objects" ], "operationId": "modelObjectFind", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "modelObjectId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "expand", "required": false, "schema": { "items": { "$ref": "#/components/schemas/ModelObjectExpandKey" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "modelObject": { "$ref": "#/components/schemas/ModelObjectExpanded" } }, "required": [ "modelObject" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Get", "x-fern-request-name": "ModelObjectFindRequest", "x-fern-sdk-method-name": "get", "x-ice-panel-operation-subject": "model-object", "x-ice-panel-operation-type": "read" }, "put": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Model Objects" ], "x-eov-operation-handler": "modelObjects", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "model", "objects" ], "operationId": "modelObjectUpsert", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "modelObjectId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelObjectUpsert" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "modelObject": { "$ref": "#/components/schemas/ModelObject" } }, "required": [ "modelObject" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Upsert", "x-fern-request-name": "ModelObjectUpsertRequest", "x-fern-sdk-method-name": "upsert", "x-ice-panel-operation-subject": "model-object", "x-ice-panel-operation-type": "write" }, "patch": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Model Objects" ], "x-eov-operation-handler": "modelObjects", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "model", "objects" ], "operationId": "modelObjectUpdate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "modelObjectId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelObjectPartial" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "modelObject": { "$ref": "#/components/schemas/ModelObject" } }, "required": [ "modelObject" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Update", "x-fern-request-name": "ModelObjectUpdateRequest", "x-fern-sdk-method-name": "update", "x-ice-panel-operation-subject": "model-object", "x-ice-panel-operation-type": "write" }, "delete": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Model Objects" ], "x-eov-operation-handler": "modelObjects", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "model", "objects" ], "operationId": "modelObjectDelete", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "modelObjectId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "commit": { "type": "number" }, "deletedModelConnectionIds": { "items": { "type": "string" }, "type": "array" }, "deletedModelObjectIds": { "items": { "type": "string" }, "type": "array" } }, "required": [ "commit", "deletedModelConnectionIds", "deletedModelObjectIds" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Delete", "x-fern-request-name": "ModelObjectDeleteRequest", "x-fern-sdk-method-name": "delete", "x-ice-panel-operation-subject": "model-object", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/versions/{versionId}/model/objects/{modelObjectId}/dependencies/export/json": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Model Objects" ], "x-eov-operation-handler": "modelObjects", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "model", "objects", "export" ], "description": "Export object dependencies as JSON", "operationId": "modelObjectDependenciesExportJson", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "modelObjectId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelObjectDependenciesExport" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Dependencies JSON", "x-fern-request-name": "ModelObjectDependenciesExportJsonRequest", "x-fern-sdk-method-name": "dependenciesJson", "x-ice-panel-operation-subject": "model-object", "x-ice-panel-operation-type": "export" } }, "/landscapes/{landscapeId}/versions/{versionId}/model/objects/export/csv": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Model Objects" ], "x-eov-operation-handler": "modelObjects", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "model", "objects", "export" ], "deprecated": true, "description": "Use the /landscapes/{landscapeId}/versions/{versionId}/export endpoint with type=object-csv instead", "operationId": "modelObjectsExportCsv", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "text/plain": { "schema": { "type": "string" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "CSV", "x-fern-availability": "deprecated", "x-fern-request-name": "ModelObjectsExportCsvRequest", "x-fern-sdk-method-name": "csv", "x-ice-panel-operation-subject": "model-object", "x-ice-panel-operation-type": "export" } }, "/organizations/{organizationId}/landscapes": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Organization Landscapes" ], "x-eov-operation-handler": "organizationLandscapes", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "organizations", "landscapes" ], "operationId": "organizationLandscapesList", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "landscapes": { "items": { "$ref": "#/components/schemas/Landscape" }, "type": "array" } }, "required": [ "landscapes" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "List", "x-fern-request-name": "OrganizationLandscapesListRequest", "x-fern-sdk-method-name": "list", "x-ice-panel-operation-subject": "landscape", "x-ice-panel-operation-type": "read" }, "post": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Organization Landscapes" ], "x-eov-operation-handler": "organizationLandscapes", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "organizations", "landscapes" ], "operationId": "organizationLandscapeCreate", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/LandscapeRequired" }, { "properties": { "templateId": { "type": "string" } }, "type": "object" } ] } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "landscape": { "$ref": "#/components/schemas/Landscape" }, "version": { "$ref": "#/components/schemas/Version" } }, "required": [ "landscape", "version" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Create", "x-fern-request-name": "OrganizationLandscapeCreateRequest", "x-fern-sdk-method-name": "create", "x-ice-panel-operation-subject": "landscape", "x-ice-panel-operation-type": "write" } }, "/organizations/{organizationId}/logs": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Organization Logs" ], "x-eov-operation-handler": "organizationLogs", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "organizations", "logs" ], "description": "List organization logs (only available on the scale plan and above)", "operationId": "organizationLogsList", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/OrganizationLogFilter" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 1000, "maximum": 10000, "minimum": 1, "type": "number" } }, { "in": "query", "name": "order", "required": false, "schema": { "$ref": "#/components/schemas/SortDirection" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "nextCursor": { "type": "string" }, "organizationLogs": { "items": { "$ref": "#/components/schemas/OrganizationLog" }, "type": "array" } }, "required": [ "organizationLogs" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "List", "x-fern-pagination": { "cursor": "$request.cursor", "next_cursor": "$response.nextCursor", "results": "$response.organizationLogs" }, "x-fern-request-name": "OrganizationLogsListRequest", "x-fern-sdk-method-name": "list", "x-ice-panel-operation-subject": "action-log", "x-ice-panel-operation-type": "read" } }, "/organizations/{organizationId}/logs/{organizationLogId}": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Organization Logs" ], "x-eov-operation-handler": "organizationLogs", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "organizations", "logs" ], "deprecated": true, "description": "Find an organization log (only available on the scale plan and above)", "operationId": "organizationLogFind", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "organizationLogId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "organizationLog": { "$ref": "#/components/schemas/OrganizationLog" } }, "required": [ "organizationLog" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Get", "x-fern-availability": "deprecated", "x-fern-request-name": "OrganizationLogFindRequest", "x-fern-sdk-method-name": "get", "x-ice-panel-operation-subject": "action-log", "x-ice-panel-operation-type": "read" } }, "/organizations/{organizationId}/logs/stats/by-type": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Organization Log Stats" ], "x-eov-operation-handler": "organizationLogStats", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "organizations", "logs", "stats" ], "description": "List total counts of actions for each action type (e.g. diagram-content-update, model-object-create)", "operationId": "organizationLogStatsByType", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/OrganizationLogStatsFilter" } }, { "in": "query", "name": "period", "required": false, "schema": { "$ref": "#/components/schemas/ActionLogStatsPeriod" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationLogStatsListByType" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "By Type", "x-fern-request-name": "OrganizationLogStatsByTypeRequest", "x-fern-sdk-method-name": "byType", "x-ice-panel-operation-subject": "action-log", "x-ice-panel-operation-type": "read" } }, "/organizations/{organizationId}/logs/stats/by-entity": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Organization Log Stats" ], "x-eov-operation-handler": "organizationLogStats", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "organizations", "logs", "stats" ], "description": "List total counts of organizations for each entity identifier", "operationId": "organizationLogStatsByEntity", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/OrganizationLogStatsFilter" } }, { "in": "query", "name": "period", "required": false, "schema": { "$ref": "#/components/schemas/ActionLogStatsPeriod" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActionLogStatsListByEntity" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "By Entity", "x-fern-request-name": "OrganizationLogStatsByEntityRequest", "x-fern-sdk-method-name": "byEntity", "x-ice-panel-operation-subject": "action-log", "x-ice-panel-operation-type": "read" } }, "/organizations": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Organizations" ], "x-eov-operation-handler": "organizations", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "organizations", "operationId": "organizationsList", "parameters": [ { "description": "list all organizations on the platform", "in": "query", "name": "admin", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "organizations": { "items": { "$ref": "#/components/schemas/Organization" }, "type": "array" } }, "required": [ "organizations" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "List", "x-fern-request-name": "OrganizationsListRequest", "x-fern-sdk-method-name": "list", "x-ice-panel-operation-subject": "organization", "x-ice-panel-operation-type": "read" }, "post": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Organizations" ], "x-eov-operation-handler": "organizations", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "organizations", "operationId": "organizationCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationRequired" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "organization": { "$ref": "#/components/schemas/Organization" } }, "required": [ "organization" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Create", "x-fern-request-name": "OrganizationCreateRequest", "x-fern-sdk-method-name": "create", "x-ice-panel-operation-subject": "organization", "x-ice-panel-operation-type": "write" } }, "/organizations/{organizationId}": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Organizations" ], "x-eov-operation-handler": "organizations", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "organizations", "operationId": "organizationFind", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "organization": { "$ref": "#/components/schemas/Organization" } }, "required": [ "organization" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Get", "x-fern-request-name": "OrganizationFindRequest", "x-fern-sdk-method-name": "get", "x-ice-panel-operation-subject": "organization", "x-ice-panel-operation-type": "read" }, "patch": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Organizations" ], "x-eov-operation-handler": "organizations", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "organizations", "operationId": "organizationUpdate", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationPartial" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "organization": { "$ref": "#/components/schemas/Organization" } }, "required": [ "organization" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Update", "x-fern-request-name": "OrganizationUpdateRequest", "x-fern-sdk-method-name": "update", "x-ice-panel-operation-subject": "organization", "x-ice-panel-operation-type": "write" }, "delete": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Organizations" ], "x-eov-operation-handler": "organizations", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "organizations", "operationId": "organizationDelete", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Delete", "x-fern-request-name": "OrganizationDeleteRequest", "x-fern-sdk-method-name": "delete", "x-ice-panel-operation-subject": "organization", "x-ice-panel-operation-type": "write" } }, "/organizations/{organizationId}/technologies": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Organization Technologies" ], "x-eov-operation-handler": "organizationTechnologies", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "organizations", "technologies" ], "operationId": "organizationTechnologiesList", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/CatalogTechnologyFilter" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "catalogTechnologies": { "items": { "$ref": "#/components/schemas/CatalogTechnology" }, "type": "array" } }, "required": [ "catalogTechnologies" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "List", "x-fern-request-name": "OrganizationTechnologiesListRequest", "x-fern-sdk-method-name": "list", "x-ice-panel-operation-subject": "technologies", "x-ice-panel-operation-type": "read" }, "post": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Organization Technologies" ], "x-eov-operation-handler": "organizationTechnologies", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "organizations", "technologies" ], "operationId": "organizationTechnologyCreate", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogTechnologyRequired" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "catalogTechnology": { "$ref": "#/components/schemas/CatalogTechnology" } }, "required": [ "catalogTechnology" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Create", "x-fern-request-name": "OrganizationTechnologyCreateRequest", "x-fern-sdk-method-name": "create", "x-ice-panel-operation-subject": "technologies", "x-ice-panel-operation-type": "write" } }, "/organizations/{organizationId}/technologies/{catalogTechnologyId}": { "delete": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Organization Technologies" ], "x-eov-operation-handler": "organizationTechnologies", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "organizations", "technologies" ], "operationId": "organizationTechnologyDelete", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "catalogTechnologyId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Delete", "x-fern-request-name": "OrganizationTechnologyDeleteRequest", "x-fern-sdk-method-name": "delete", "x-ice-panel-operation-subject": "technologies", "x-ice-panel-operation-type": "write" }, "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Organization Technologies" ], "x-eov-operation-handler": "organizationTechnologies", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "organizations", "technologies" ], "operationId": "organizationTechnologyFind", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "catalogTechnologyId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "catalogTechnology": { "$ref": "#/components/schemas/CatalogTechnology" } }, "required": [ "catalogTechnology" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Get", "x-fern-request-name": "OrganizationTechnologyFindRequest", "x-fern-sdk-method-name": "get", "x-ice-panel-operation-subject": "technologies", "x-ice-panel-operation-type": "read" }, "patch": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Organization Technologies" ], "x-eov-operation-handler": "organizationTechnologies", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "organizations", "technologies" ], "operationId": "organizationTechnologyUpdate", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "catalogTechnologyId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogTechnologyPartial" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "catalogTechnology": { "$ref": "#/components/schemas/CatalogTechnology" } }, "required": [ "catalogTechnology" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Update", "x-fern-request-name": "OrganizationTechnologyUpdateRequest", "x-fern-sdk-method-name": "update", "x-ice-panel-operation-subject": "technologies", "x-ice-panel-operation-type": "write" } }, "/organizations/{organizationId}/users/invites": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Organization User Invites" ], "x-eov-operation-handler": "organizationUserInvites", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "organizations", "users", "invites" ], "operationId": "organizationUserInvitesList", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "organizationUserInvites": { "items": { "$ref": "#/components/schemas/OrganizationUserInvite" }, "type": "array" } }, "required": [ "organizationUserInvites" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "List", "x-fern-request-name": "OrganizationUserInvitesListRequest", "x-fern-sdk-method-name": "list", "x-ice-panel-operation-subject": "invites", "x-ice-panel-operation-type": "read" }, "post": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Organization User Invites" ], "x-eov-operation-handler": "organizationUserInvites", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "organizations", "users", "invites" ], "operationId": "organizationUserInviteCreate", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationUserInviteRequired" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "organizationUserInvite": { "$ref": "#/components/schemas/OrganizationUserInvite" } }, "required": [ "organizationUserInvite" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Create", "x-fern-request-name": "OrganizationUserInviteCreateRequest", "x-fern-sdk-method-name": "create", "x-ice-panel-operation-subject": "invites", "x-ice-panel-operation-type": "write" } }, "/organizations/{organizationId}/users/invites/{organizationUserInviteId}": { "post": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Organization User Invites" ], "x-eov-operation-handler": "organizationUserInvites", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "organizations", "users", "invites" ], "operationId": "organizationUserInviteRevoke", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "organizationUserInviteId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "organizationUserInvite": { "$ref": "#/components/schemas/OrganizationUserInvite" } }, "required": [ "organizationUserInvite" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Revoke", "x-fern-request-name": "OrganizationUserInviteRevokeRequest", "x-fern-sdk-method-name": "revoke", "x-ice-panel-operation-subject": "invites", "x-ice-panel-operation-type": "write" } }, "/organizations/{organizationId}/users": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Organization Users" ], "x-eov-operation-handler": "organizationUsers", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "organizations", "users" ], "operationId": "organizationUsersList", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "organizationUsers": { "additionalProperties": { "allOf": [ { "$ref": "#/components/schemas/OrganizationUser" }, { "$ref": "#/components/schemas/OrganizationUserInfo" } ] }, "type": "object" } }, "required": [ "organizationUsers" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "List", "x-fern-request-name": "OrganizationUsersListRequest", "x-fern-sdk-method-name": "list", "x-ice-panel-operation-subject": "user", "x-ice-panel-operation-type": "read" } }, "/organizations/{organizationId}/users/{userId}": { "patch": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Organization Users" ], "x-eov-operation-handler": "organizationUsers", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "organizations", "users" ], "operationId": "organizationUserUpdate", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationUser" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "organizationUser": { "$ref": "#/components/schemas/OrganizationUser" } }, "required": [ "organizationUser" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Update", "x-fern-request-name": "OrganizationUserUpdateRequest", "x-fern-sdk-method-name": "update", "x-ice-panel-operation-subject": "user", "x-ice-panel-operation-type": "write" }, "delete": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Organization Users" ], "x-eov-operation-handler": "organizationUsers", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "organizations", "users" ], "operationId": "organizationUserDelete", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Delete", "x-fern-request-name": "OrganizationUserDeleteRequest", "x-fern-sdk-method-name": "delete", "x-ice-panel-operation-subject": "user", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/versions/{versionId}/share-link": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Share Link" ], "x-eov-operation-handler": "shareLink", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "shareLink", "operationId": "shareLinkFind", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "defaultUrl": { "description": "Share link url with default options encoded in the path", "format": "uri", "type": "string" }, "shareLink": { "$ref": "#/components/schemas/ShareLink" }, "stats": { "$ref": "#/components/schemas/ShareLinkStats" }, "url": { "description": "Share link url prefix, you need to append the options short id onto a trailing path segment", "format": "uri", "type": "string" } }, "required": [ "defaultUrl", "shareLink", "stats", "url" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Get", "x-fern-request-name": "ShareLinkFindRequest", "x-fern-sdk-method-name": "get", "x-ice-panel-operation-subject": "share-link", "x-ice-panel-operation-type": "read" }, "post": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Share Link" ], "x-eov-operation-handler": "shareLink", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "shareLink", "operationId": "shareLinkCreate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareLinkRequired" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "defaultUrl": { "description": "Share link url with default options encoded in the path", "format": "uri", "type": "string" }, "shareLink": { "$ref": "#/components/schemas/ShareLink" }, "url": { "description": "Share link url prefix, you need to append the options short id onto a trailing path segment", "format": "uri", "type": "string" } }, "required": [ "defaultUrl", "shareLink", "url" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Create", "x-fern-request-name": "ShareLinkCreateRequest", "x-fern-sdk-method-name": "create", "x-ice-panel-operation-subject": "share-link", "x-ice-panel-operation-type": "write" }, "patch": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Share Link" ], "x-eov-operation-handler": "shareLink", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "shareLink", "operationId": "shareLinkUpdate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "resetShortId", "required": false, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShareLinkPartial" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "shareLink": { "$ref": "#/components/schemas/ShareLink" } }, "required": [ "shareLink" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Update", "x-fern-request-name": "ShareLinkUpdateRequest", "x-fern-sdk-method-name": "update", "x-ice-panel-operation-subject": "share-link", "x-ice-panel-operation-type": "write" }, "delete": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Share Link" ], "x-eov-operation-handler": "shareLink", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "shareLink", "operationId": "shareLinkDelete", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Delete", "x-fern-request-name": "ShareLinkDeleteRequest", "x-fern-sdk-method-name": "delete", "x-ice-panel-operation-subject": "share-link", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/versions/{versionId}/tag-groups": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Tag Groups" ], "x-eov-operation-handler": "tagGroups", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "tags", "groups" ], "operationId": "tagGroupsList", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/TagGroupFilter" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "tagGroups": { "items": { "$ref": "#/components/schemas/TagGroup" }, "type": "array" } }, "required": [ "tagGroups" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "List", "x-fern-request-name": "TagGroupsListRequest", "x-fern-sdk-method-name": "list", "x-ice-panel-operation-subject": "tag-group", "x-ice-panel-operation-type": "read" }, "post": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Tag Groups" ], "x-eov-operation-handler": "tagGroups", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "tags", "groups" ], "operationId": "tagGroupCreate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagGroupRequired" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "tagGroup": { "$ref": "#/components/schemas/TagGroup" } }, "required": [ "tagGroup" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Create", "x-fern-request-name": "TagGroupCreateRequest", "x-fern-sdk-method-name": "create", "x-ice-panel-operation-subject": "tag-group", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/versions/{versionId}/tag-groups/{tagGroupId}": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Tag Groups" ], "x-eov-operation-handler": "tagGroups", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "tags", "groups" ], "operationId": "tagGroupFind", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "tagGroupId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "tagGroup": { "$ref": "#/components/schemas/TagGroup" } }, "required": [ "tagGroup" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Get", "x-fern-request-name": "TagGroupFindRequest", "x-fern-sdk-method-name": "get", "x-ice-panel-operation-subject": "tag-group", "x-ice-panel-operation-type": "read" }, "put": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Tag Groups" ], "x-eov-operation-handler": "tagGroups", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "tags", "groups" ], "operationId": "tagGroupUpsert", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "tagGroupId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagGroupUpsert" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "tagGroup": { "$ref": "#/components/schemas/TagGroup" } }, "required": [ "tagGroup" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Upsert", "x-fern-request-name": "TagGroupUpsertRequest", "x-fern-sdk-method-name": "upsert", "x-ice-panel-operation-subject": "tag-group", "x-ice-panel-operation-type": "write" }, "patch": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Tag Groups" ], "x-eov-operation-handler": "tagGroups", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "tags", "groups" ], "operationId": "tagGroupUpdate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "tagGroupId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagGroupPartial" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "tagGroup": { "$ref": "#/components/schemas/TagGroup" } }, "required": [ "tagGroup" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Update", "x-fern-request-name": "TagGroupUpdateRequest", "x-fern-sdk-method-name": "update", "x-ice-panel-operation-subject": "tag-group", "x-ice-panel-operation-type": "write" }, "delete": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Tag Groups" ], "x-eov-operation-handler": "tagGroups", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "tags", "groups" ], "operationId": "tagGroupDelete", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "tagGroupId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "commit": { "type": "number" } }, "required": [ "commit" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Delete", "x-fern-request-name": "TagGroupDeleteRequest", "x-fern-sdk-method-name": "delete", "x-ice-panel-operation-subject": "tag-group", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/versions/{versionId}/tags": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Tags" ], "x-eov-operation-handler": "tags", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "tags", "operationId": "tagsList", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/TagFilter" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "tags": { "items": { "$ref": "#/components/schemas/Tag" }, "type": "array" } }, "required": [ "tags" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "List", "x-fern-request-name": "TagsListRequest", "x-fern-sdk-method-name": "list", "x-ice-panel-operation-subject": "tag", "x-ice-panel-operation-type": "read" }, "post": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Tags" ], "x-eov-operation-handler": "tags", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "tags", "operationId": "tagCreate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagRequired" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "tag": { "$ref": "#/components/schemas/Tag" } }, "required": [ "tag" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Create", "x-fern-request-name": "TagCreateRequest", "x-fern-sdk-method-name": "create", "x-ice-panel-operation-subject": "tag", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/versions/{versionId}/tags/{tagId}": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Tags" ], "x-eov-operation-handler": "tags", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "tags", "operationId": "tagFind", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "tagId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "tag": { "$ref": "#/components/schemas/Tag" } }, "required": [ "tag" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Get", "x-fern-request-name": "TagFindRequest", "x-fern-sdk-method-name": "get", "x-ice-panel-operation-subject": "tag", "x-ice-panel-operation-type": "read" }, "put": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Tags" ], "x-eov-operation-handler": "tags", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "tags", "operationId": "tagUpsert", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "tagId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagUpsert" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "tag": { "$ref": "#/components/schemas/Tag" } }, "required": [ "tag" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Upsert", "x-fern-request-name": "TagUpsertRequest", "x-fern-sdk-method-name": "upsert", "x-ice-panel-operation-subject": "tag", "x-ice-panel-operation-type": "write" }, "patch": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Tags" ], "x-eov-operation-handler": "tags", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "tags", "operationId": "tagUpdate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "tagId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagPartial" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "tag": { "$ref": "#/components/schemas/Tag" } }, "required": [ "tag" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Update", "x-fern-request-name": "TagUpdateRequest", "x-fern-sdk-method-name": "update", "x-ice-panel-operation-subject": "tag", "x-ice-panel-operation-type": "write" }, "delete": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Tags" ], "x-eov-operation-handler": "tags", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "tags", "operationId": "tagDelete", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "tagId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "commit": { "type": "number" } }, "required": [ "commit" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Delete", "x-fern-request-name": "TagDeleteRequest", "x-fern-sdk-method-name": "delete", "x-ice-panel-operation-subject": "tag", "x-ice-panel-operation-type": "write" } }, "/organizations/{organizationId}/teams": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Teams" ], "x-eov-operation-handler": "teams", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "teams", "operationId": "teamsList", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "teams": { "items": { "$ref": "#/components/schemas/Team" }, "type": "array" } }, "required": [ "teams" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "List", "x-fern-request-name": "TeamsListRequest", "x-fern-sdk-method-name": "list", "x-ice-panel-operation-subject": "team", "x-ice-panel-operation-type": "read" }, "post": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Teams" ], "x-eov-operation-handler": "teams", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "teams", "operationId": "teamCreate", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamRequired" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "team": { "$ref": "#/components/schemas/Team" } }, "required": [ "team" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Create", "x-fern-request-name": "TeamCreateRequest", "x-fern-sdk-method-name": "create", "x-ice-panel-operation-subject": "team", "x-ice-panel-operation-type": "write" } }, "/organizations/{organizationId}/teams/{teamId}": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Teams" ], "x-eov-operation-handler": "teams", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "teams", "operationId": "teamFind", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "teamId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "team": { "$ref": "#/components/schemas/Team" } }, "required": [ "team" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Get", "x-fern-request-name": "TeamFindRequest", "x-fern-sdk-method-name": "get", "x-ice-panel-operation-subject": "team", "x-ice-panel-operation-type": "read" }, "patch": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Teams" ], "x-eov-operation-handler": "teams", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "teams", "operationId": "teamUpdate", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "teamId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamPartial" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "team": { "$ref": "#/components/schemas/Team" } }, "required": [ "team" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Update", "x-fern-request-name": "TeamUpdateRequest", "x-fern-sdk-method-name": "update", "x-ice-panel-operation-subject": "team", "x-ice-panel-operation-type": "write" }, "delete": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Teams" ], "x-eov-operation-handler": "teams", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "teams", "operationId": "teamDelete", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "teamId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Delete", "x-fern-request-name": "TeamDeleteRequest", "x-fern-sdk-method-name": "delete", "x-ice-panel-operation-subject": "team", "x-ice-panel-operation-type": "write" } }, "/organizations/{organizationId}/teams/{teamId}/landscapes": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Teams" ], "x-eov-operation-handler": "teams", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "teams", "operationId": "teamLandscapesList", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "teamId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "landscapes": { "items": { "$ref": "#/components/schemas/Landscape" }, "type": "array" } }, "required": [ "landscapes" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "List Landscapes", "x-fern-request-name": "TeamLandscapesListRequest", "x-fern-sdk-method-name": "listLandscapes", "x-ice-panel-operation-subject": "team", "x-ice-panel-operation-type": "read" } }, "/organizations/{organizationId}/teams/{teamId}/model/objects": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Teams" ], "x-eov-operation-handler": "teams", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "teams", "operationId": "teamModelObjectsList", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "teamId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "landscapeModelObjects": { "additionalProperties": { "items": { "$ref": "#/components/schemas/ModelObject" }, "type": "array" }, "type": "object" } }, "required": [ "landscapeModelObjects" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "List Model Objects", "x-fern-request-name": "TeamModelObjectsListRequest", "x-fern-sdk-method-name": "listModelObjects", "x-ice-panel-operation-subject": "team", "x-ice-panel-operation-type": "read" } }, "/landscapes/{landscapeId}/version/reverts": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Version Reverts" ], "x-eov-operation-handler": "versionReverts", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "versions", "reverts" ], "operationId": "versionRevertsList", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "versionReverts": { "items": { "$ref": "#/components/schemas/VersionRevert" }, "type": "array" } }, "required": [ "versionReverts" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "List", "x-fern-request-name": "VersionRevertsListRequest", "x-fern-sdk-method-name": "list", "x-ice-panel-operation-subject": "version", "x-ice-panel-operation-type": "read" }, "post": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Version Reverts" ], "x-eov-operation-handler": "versionReverts", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "versions", "reverts" ], "operationId": "versionRevertCreate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionRevertRequired" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "versionRevert": { "$ref": "#/components/schemas/VersionRevert" } }, "required": [ "versionRevert" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Create", "x-fern-request-name": "VersionRevertCreateRequest", "x-fern-sdk-method-name": "create", "x-ice-panel-operation-subject": "version", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/version/reverts/{versionRevertId}": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Version Reverts" ], "x-eov-operation-handler": "versionReverts", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "versions", "reverts" ], "operationId": "versionRevertFind", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionRevertId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "versionRevert": { "$ref": "#/components/schemas/VersionRevert" } }, "required": [ "versionRevert" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Get", "x-fern-request-name": "VersionRevertFindRequest", "x-fern-sdk-method-name": "get", "x-ice-panel-operation-subject": "version", "x-ice-panel-operation-type": "read" }, "patch": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Version Reverts" ], "x-eov-operation-handler": "versionReverts", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": [ "versions", "reverts" ], "operationId": "versionRevertUpdate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionRevertId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionRevertPartial" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "versionRevert": { "$ref": "#/components/schemas/VersionRevert" } }, "required": [ "versionRevert" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Update", "x-fern-request-name": "VersionRevertUpdateRequest", "x-fern-sdk-method-name": "update", "x-ice-panel-operation-subject": "version", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/versions": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Versions" ], "x-eov-operation-handler": "versions", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "versions", "operationId": "versionsList", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "$ref": "#/components/schemas/VersionFilter" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "maximum": 1000, "minimum": 1, "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "nextCursor": { "type": "string" }, "versions": { "items": { "$ref": "#/components/schemas/Version" }, "type": "array" } }, "required": [ "versions" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "List", "x-fern-pagination": { "cursor": "$request.cursor", "next_cursor": "$response.nextCursor", "results": "$response.versions" }, "x-fern-request-name": "VersionsListRequest", "x-fern-sdk-method-name": "list", "x-ice-panel-operation-subject": "version", "x-ice-panel-operation-type": "read" }, "post": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Versions" ], "x-eov-operation-handler": "versions", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "versions", "operationId": "versionCreate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionRequired" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "version": { "$ref": "#/components/schemas/Version" } }, "required": [ "version" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Conflict" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Create", "x-fern-request-name": "VersionCreateRequest", "x-fern-sdk-method-name": "create", "x-ice-panel-operation-subject": "version", "x-ice-panel-operation-type": "write" } }, "/landscapes/{landscapeId}/versions/{versionId}": { "get": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Versions" ], "x-eov-operation-handler": "versions", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "versions", "operationId": "versionFind", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "version": { "$ref": "#/components/schemas/Version" } }, "required": [ "version" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" } }, "summary": "Get", "x-fern-request-name": "VersionFindRequest", "x-fern-sdk-method-name": "get", "x-ice-panel-operation-subject": "version", "x-ice-panel-operation-type": "read" }, "patch": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Versions" ], "x-eov-operation-handler": "versions", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "versions", "operationId": "versionUpdate", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "version": { "$ref": "#/components/schemas/Version" } }, "required": [ "version" ], "type": "object" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Update", "x-fern-request-name": "VersionUpdateRequest", "x-fern-sdk-method-name": "update", "x-ice-panel-operation-subject": "version", "x-ice-panel-operation-type": "write" }, "delete": { "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "tags": [ "Versions" ], "x-eov-operation-handler": "versions", "x-fern-audiences": [ "public" ], "x-fern-sdk-group-name": "versions", "operationId": "versionDelete", "parameters": [ { "in": "path", "name": "landscapeId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not Found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Unprocessable Entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Resource Exhausted" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Internal Server" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Service Unavailable" } }, "summary": "Delete", "x-fern-request-name": "VersionDeleteRequest", "x-fern-sdk-method-name": "delete", "x-ice-panel-operation-subject": "version", "x-ice-panel-operation-type": "write" } } }, "servers": [ { "url": "https://api.icepanel.io/v1", "x-fern-server-name": "API V1" } ], "webhooks": { "model-connection": { "post": { "description": "Webhook event triggered when a model connection was modified", "operationId": "onModelConnection", "requestBody": { "content": { "application/json": { "schema": { "example": { "after": { "id": "ktLn0NRHkzKp2GTPzXl5", "landscapeId": "kClOhzcBdYPX1tx4sYzC", "versionId": "O1XSZ7r7xWMXfhd7FHAV" }, "before": { "id": "ktLn0NRHkzKp2GTPzXl5", "landscapeId": "kClOhzcBdYPX1tx4sYzC", "versionId": "O1XSZ7r7xWMXfhd7FHAV" }, "collection": "model-connection", "operation": "created", "organizationId": "ZGDaIrw2DrVnYnxMDES3", "resourceId": "ktLn0NRHkzKp2GTPzXl5", "subscriptionId": "cK0eZN6MLSw8XDg7uPnY" }, "properties": { "after": { "properties": { "id": { "format": "id", "type": "string" }, "landscapeId": { "format": "id", "type": "string" }, "versionId": { "format": "id", "type": "string" } }, "required": [ "id" ], "type": "object" }, "before": { "properties": { "id": { "format": "id", "type": "string" }, "landscapeId": { "format": "id", "type": "string" }, "versionId": { "format": "id", "type": "string" } }, "required": [ "id" ], "type": "object" }, "collection": { "enum": [ "model-connection" ], "type": "string" }, "operation": { "enum": [ "created", "updated", "deleted" ], "type": "string" }, "organizationId": { "format": "id", "type": "string" }, "resourceId": { "format": "id", "type": "string" }, "subscriptionId": { "format": "id", "type": "string" } }, "required": [ "collection", "operation", "organizationId", "resourceId", "subscriptionId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "summary": "Model Connection", "tags": [ "Webhook Events" ], "x-fern-audiences": [ "public" ] } }, "model-object": { "post": { "description": "Webhook event triggered when a model object was modified", "operationId": "onModelObject", "requestBody": { "content": { "application/json": { "schema": { "example": { "after": { "id": "ktLn0NRHkzKp2GTPzXl5", "landscapeId": "kClOhzcBdYPX1tx4sYzC", "versionId": "O1XSZ7r7xWMXfhd7FHAV" }, "before": { "id": "ktLn0NRHkzKp2GTPzXl5", "landscapeId": "kClOhzcBdYPX1tx4sYzC", "versionId": "O1XSZ7r7xWMXfhd7FHAV" }, "collection": "model-connection", "operation": "created", "organizationId": "ZGDaIrw2DrVnYnxMDES3", "resourceId": "ktLn0NRHkzKp2GTPzXl5", "subscriptionId": "cK0eZN6MLSw8XDg7uPnY" }, "properties": { "after": { "properties": { "id": { "format": "id", "type": "string" }, "landscapeId": { "format": "id", "type": "string" }, "versionId": { "format": "id", "type": "string" } }, "required": [ "id" ], "type": "object" }, "before": { "properties": { "id": { "format": "id", "type": "string" }, "landscapeId": { "format": "id", "type": "string" }, "versionId": { "format": "id", "type": "string" } }, "required": [ "id" ], "type": "object" }, "collection": { "enum": [ "model-object" ], "type": "string" }, "operation": { "enum": [ "created", "updated", "deleted" ], "type": "string" }, "organizationId": { "format": "id", "type": "string" }, "resourceId": { "format": "id", "type": "string" }, "subscriptionId": { "format": "id", "type": "string" } }, "required": [ "collection", "operation", "organizationId", "resourceId", "subscriptionId" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "summary": "Model Object", "tags": [ "Webhook Events" ], "x-fern-audiences": [ "public" ] } } }, "x-fern-webhook-signature": { "algorithm": "sha256", "encoding": "hex", "header": "X-IcePanel-Signature", "payload-format": { "components": [ "timestamp", "body" ], "delimiter": "." }, "timestamp": { "format": "unix-seconds", "header": "X-IcePanel-Timestamp", "tolerance": 300 }, "type": "hmac" } }