@meshery/schemas 1.3.19 → 1.3.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cloudApi.d.mts +440 -19
- package/dist/cloudApi.d.ts +440 -19
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta1/model/Model.d.ts +6 -4
- package/dist/constructs/v1beta1/model/ModelSchema.js +2 -2
- package/dist/constructs/v1beta1/model/ModelSchema.mjs +2 -2
- package/dist/constructs/v1beta1/user/User.d.ts +450 -14
- package/dist/constructs/v1beta1/user/UserSchema.js +1 -1
- package/dist/constructs/v1beta1/user/UserSchema.mjs +1 -1
- package/dist/constructs/v1beta2/core/Core.d.ts +2 -0
- package/dist/constructs/v1beta2/core/CoreSchema.js +1 -1
- package/dist/constructs/v1beta2/core/CoreSchema.mjs +1 -1
- package/dist/constructs/v1beta2/key/Key.d.ts +18 -3
- package/dist/constructs/v1beta2/key/KeySchema.js +1 -1
- package/dist/constructs/v1beta2/key/KeySchema.mjs +1 -1
- package/dist/constructs/v1beta2/keychain/Keychain.d.ts +18 -3
- package/dist/constructs/v1beta2/keychain/KeychainSchema.js +1 -1
- package/dist/constructs/v1beta2/keychain/KeychainSchema.mjs +1 -1
- package/dist/constructs/v1beta2/model/Model.d.ts +7 -5
- package/dist/constructs/v1beta2/model/ModelSchema.js +2 -2
- package/dist/constructs/v1beta2/model/ModelSchema.mjs +2 -2
- package/dist/constructs/v1beta2/team/Team.d.ts +18 -0
- package/dist/constructs/v1beta2/team/TeamSchema.js +1 -1
- package/dist/constructs/v1beta2/team/TeamSchema.mjs +1 -1
- package/dist/constructs/v1beta2/view/View.d.ts +12 -2
- package/dist/constructs/v1beta2/view/ViewSchema.js +2 -2
- package/dist/constructs/v1beta2/view/ViewSchema.mjs +2 -2
- package/dist/constructs/v1beta3/academy/Academy.d.ts +10 -0
- package/dist/constructs/v1beta3/academy/AcademySchema.js +1 -1
- package/dist/constructs/v1beta3/academy/AcademySchema.mjs +1 -1
- package/dist/constructs/v1beta3/connection/Connection.d.ts +793 -11
- package/dist/constructs/v1beta3/connection/ConnectionSchema.js +1 -1
- package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +1 -1
- package/dist/constructs/v1beta3/environment/Environment.d.ts +18 -3
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.js +1 -1
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.mjs +1 -1
- package/dist/constructs/v1beta3/event/Event.d.ts +19 -2
- package/dist/constructs/v1beta3/event/EventSchema.js +1 -1
- package/dist/constructs/v1beta3/event/EventSchema.mjs +1 -1
- package/dist/constructs/v1beta3/token/Token.d.ts +12 -2
- package/dist/constructs/v1beta3/token/TokenSchema.js +1 -1
- package/dist/constructs/v1beta3/token/TokenSchema.mjs +1 -1
- package/dist/constructs/v1beta3/workspace/Workspace.d.ts +36 -6
- package/dist/constructs/v1beta3/workspace/WorkspaceSchema.js +2 -2
- package/dist/constructs/v1beta3/workspace/WorkspaceSchema.mjs +2 -2
- package/dist/index.d.mts +229 -8
- package/dist/index.d.ts +229 -8
- package/dist/index.js +2 -2
- package/dist/index.mjs +2 -2
- package/dist/mesheryApi.d.mts +412 -10
- package/dist/mesheryApi.d.ts +412 -10
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/package.json +1 -1
package/dist/mesheryApi.d.mts
CHANGED
|
@@ -2018,7 +2018,9 @@ type GetUserKeysApiArg = {
|
|
|
2018
2018
|
orgId: string;
|
|
2019
2019
|
/** Get responses by page */
|
|
2020
2020
|
page?: string;
|
|
2021
|
-
/**
|
|
2021
|
+
/** Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
|
|
2022
|
+
pageSize?: number;
|
|
2023
|
+
/** Get responses by pagesize. Deprecated alias of pageSize. */
|
|
2022
2024
|
pagesize?: string;
|
|
2023
2025
|
};
|
|
2024
2026
|
type RegisterMeshmodelsApiResponse = {
|
|
@@ -2920,6 +2922,12 @@ type CreateTeamApiArg = {
|
|
|
2920
2922
|
name: string;
|
|
2921
2923
|
/** A detailed description of the team's purpose and responsibilities. */
|
|
2922
2924
|
description?: string;
|
|
2925
|
+
/** Whether to notify team members when the team is created or updated. */
|
|
2926
|
+
notifyTeamUpdate?: boolean;
|
|
2927
|
+
/** Additional client-supplied metadata for the team. */
|
|
2928
|
+
metadata?: {
|
|
2929
|
+
[key: string]: any;
|
|
2930
|
+
};
|
|
2923
2931
|
};
|
|
2924
2932
|
};
|
|
2925
2933
|
type GetTeamUsersApiResponse = {
|
|
@@ -5068,7 +5076,197 @@ type ListConnectionDefinitionsApiArg = {
|
|
|
5068
5076
|
};
|
|
5069
5077
|
type RegisterConnectionDefinitionApiResponse = any;
|
|
5070
5078
|
type RegisterConnectionDefinitionApiArg = {
|
|
5071
|
-
body:
|
|
5079
|
+
body: {
|
|
5080
|
+
/** Existing connection definition ID for updates; omit on create. */
|
|
5081
|
+
id?: string;
|
|
5082
|
+
/** Specifies the version of the schema the definition conforms to. */
|
|
5083
|
+
schemaVersion?: string;
|
|
5084
|
+
/** Connection definition name */
|
|
5085
|
+
name: string;
|
|
5086
|
+
/** Human-readable description of the connection definition and its purpose. */
|
|
5087
|
+
description?: string;
|
|
5088
|
+
/** URL of the remote resource connections of this kind point to. */
|
|
5089
|
+
url?: string;
|
|
5090
|
+
/** Connection kind (e.g., kubernetes, prometheus, grafana) */
|
|
5091
|
+
kind: string;
|
|
5092
|
+
/** Connection type (platform, telemetry, collaboration) */
|
|
5093
|
+
type: string;
|
|
5094
|
+
/** Connection sub-type (cloud, identity, metrics, chat, git, orchestration) */
|
|
5095
|
+
subType: string;
|
|
5096
|
+
/** Connection Status Value */
|
|
5097
|
+
status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
|
|
5098
|
+
/** Reference to the registered model that owns this connection definition. */
|
|
5099
|
+
modelReference?: {
|
|
5100
|
+
/** A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. */
|
|
5101
|
+
id: string;
|
|
5102
|
+
/** The unique name for the model within the scope of a registrant. */
|
|
5103
|
+
name: string;
|
|
5104
|
+
/** Version of the model definition. */
|
|
5105
|
+
version: string;
|
|
5106
|
+
/** Human-readable name for the model. */
|
|
5107
|
+
displayName: string;
|
|
5108
|
+
/** Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
|
|
5109
|
+
model: {
|
|
5110
|
+
/** Version of the model as defined by the registrant. */
|
|
5111
|
+
version: string;
|
|
5112
|
+
};
|
|
5113
|
+
registrant: {
|
|
5114
|
+
/** Kind of the registrant. */
|
|
5115
|
+
kind: string;
|
|
5116
|
+
};
|
|
5117
|
+
};
|
|
5118
|
+
/** Kind-specific connection metadata */
|
|
5119
|
+
metadata?: object;
|
|
5120
|
+
/** Schema for the credential associated with connections of this kind. */
|
|
5121
|
+
credentialSchema?: object;
|
|
5122
|
+
/** Schema for connections of this kind. */
|
|
5123
|
+
connectionSchema?: object;
|
|
5124
|
+
/** Visualization styles for the connection, including svgColor and svgWhite used for UI representation. */
|
|
5125
|
+
styles?: {
|
|
5126
|
+
/** Primary color of the component used for UI representation. */
|
|
5127
|
+
primaryColor: string;
|
|
5128
|
+
/** Secondary color of the entity used for UI representation. */
|
|
5129
|
+
secondaryColor?: string;
|
|
5130
|
+
/** White SVG of the entity used for UI representation on dark background. */
|
|
5131
|
+
svgWhite: string;
|
|
5132
|
+
/** Colored SVG of the entity used for UI representation on light background. */
|
|
5133
|
+
svgColor: string;
|
|
5134
|
+
/** Complete SVG of the entity used for UI representation, often inclusive of background. */
|
|
5135
|
+
svgComplete: string;
|
|
5136
|
+
/** The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
5137
|
+
color?: string;
|
|
5138
|
+
/** The opacity of the label text, including its outline. */
|
|
5139
|
+
textOpacity?: number;
|
|
5140
|
+
/** A comma-separated list of font names to use on the label text. */
|
|
5141
|
+
fontFamily?: string;
|
|
5142
|
+
/** The size of the label text. */
|
|
5143
|
+
fontSize?: string;
|
|
5144
|
+
/** A CSS font style to be applied to the label text. */
|
|
5145
|
+
fontStyle?: string;
|
|
5146
|
+
/** A CSS font weight to be applied to the label text. */
|
|
5147
|
+
fontWeight?: string;
|
|
5148
|
+
/** A transformation to apply to the label text */
|
|
5149
|
+
textTransform?: "none" | "uppercase" | "lowercase";
|
|
5150
|
+
/** The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children. */
|
|
5151
|
+
opacity?: number;
|
|
5152
|
+
/** An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index. */
|
|
5153
|
+
zIndex?: number;
|
|
5154
|
+
/** The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
|
|
5155
|
+
label?: string;
|
|
5156
|
+
/** The animation to apply to the element. example ripple,bounce,etc */
|
|
5157
|
+
animation?: object;
|
|
5158
|
+
[key: string]: any;
|
|
5159
|
+
} & {
|
|
5160
|
+
/** The shape of the node's body. Note that each shape fits within the specified width and height, and so you may have to adjust width and height if you desire an equilateral shape (i.e. width !== height for several equilateral shapes) */
|
|
5161
|
+
shape: "ellipse" | "triangle" | "round-triangle" | "rectangle" | "round-rectangle" | "bottom-round-rectangle" | "cut-rectangle" | "barrel" | "rhomboid" | "diamond" | "round-diamond" | "pentagon" | "round-pentagon" | "hexagon" | "round-hexagon" | "concave-hexagon" | "heptagon" | "round-heptagon" | "octagon" | "round-octagon" | "star" | "tag" | "round-tag" | "vee" | "polygon";
|
|
5162
|
+
/** The position of the node. If the position is set, the node is drawn at that position in the given dimensions. If the position is not set, the node is drawn at a random position. */
|
|
5163
|
+
position?: {
|
|
5164
|
+
/** The x-coordinate of the node. */
|
|
5165
|
+
x: number;
|
|
5166
|
+
/** The y-coordinate of the node. */
|
|
5167
|
+
y: number;
|
|
5168
|
+
};
|
|
5169
|
+
/** The text to display for an element's body. Can give a path, e.g. data(id) will label with the elements id */
|
|
5170
|
+
bodyText?: string;
|
|
5171
|
+
/** How to wrap the text in the node. Can be 'none', 'wrap', or 'ellipsis'. */
|
|
5172
|
+
bodyTextWrap?: "none" | "wrap" | "ellipsis";
|
|
5173
|
+
/** The maximum width for wrapping text in the node. */
|
|
5174
|
+
bodyTextMaxWidth?: string;
|
|
5175
|
+
/** The opacity of the node's body text, including its outline. */
|
|
5176
|
+
bodyTextOpacity?: number;
|
|
5177
|
+
/** The colour of the node's body text background. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
5178
|
+
bodyTextBackgroundColor?: string;
|
|
5179
|
+
/** The size of the node's body text. */
|
|
5180
|
+
bodyTextFontSize?: number;
|
|
5181
|
+
/** The colour of the node's body text. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
5182
|
+
bodyTextColor?: string;
|
|
5183
|
+
/** A CSS font weight to be applied to the node's body text. */
|
|
5184
|
+
bodyTextFontWeight?: string;
|
|
5185
|
+
/** A CSS horizontal alignment to be applied to the node's body text. */
|
|
5186
|
+
bodyTextHorizontalAlign?: string;
|
|
5187
|
+
/** A CSS text decoration to be applied to the node's body text. */
|
|
5188
|
+
bodyTextDecoration?: string;
|
|
5189
|
+
/** A CSS vertical alignment to be applied to the node's body text. */
|
|
5190
|
+
bodyTextVerticalAlign?: string;
|
|
5191
|
+
/** The width of the node's body or the width of an edge's line. */
|
|
5192
|
+
width?: number;
|
|
5193
|
+
/** The height of the node's body */
|
|
5194
|
+
height?: number;
|
|
5195
|
+
/** The URL that points to the image to show in the node. */
|
|
5196
|
+
backgroundImage?: string;
|
|
5197
|
+
/** The colour of the node's body. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
5198
|
+
backgroundColor?: string;
|
|
5199
|
+
/** Blackens the node's body for values from 0 to 1; whitens the node's body for values from 0 to -1. */
|
|
5200
|
+
backgroundBlacken?: number;
|
|
5201
|
+
/** The opacity level of the node's background colour */
|
|
5202
|
+
backgroundOpacity?: number;
|
|
5203
|
+
/** The x position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
|
|
5204
|
+
backgroundPositionX?: string;
|
|
5205
|
+
/** The y position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
|
|
5206
|
+
backgroundPositionY?: string;
|
|
5207
|
+
/** The x offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
|
|
5208
|
+
backgroundOffsetX?: string;
|
|
5209
|
+
/** The y offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
|
|
5210
|
+
backgroundOffsetY?: string;
|
|
5211
|
+
/** How the background image is fit to the node. Can be 'none', 'contain', or 'cover'. */
|
|
5212
|
+
backgroundFit?: "none" | "contain" | "cover";
|
|
5213
|
+
/** How the background image is clipped to the node. Can be 'none', 'node', or 'node-border'. */
|
|
5214
|
+
backgroundClip?: "none" | "node" | "node-border";
|
|
5215
|
+
/** How the background image's width is determined. Can be 'none', 'inner', or 'outer'. */
|
|
5216
|
+
backgroundWidthRelativeTo?: "none" | "inner" | "outer";
|
|
5217
|
+
/** How the background image's height is determined. Can be 'none', 'inner', or 'outer'. */
|
|
5218
|
+
backgroundHeightRelativeTo?: "none" | "inner" | "outer";
|
|
5219
|
+
/** The size of the node's border. */
|
|
5220
|
+
borderWidth?: number;
|
|
5221
|
+
/** The style of the node's border */
|
|
5222
|
+
borderStyle?: "solid" | "dotted" | "dashed" | "double";
|
|
5223
|
+
/** The colour of the node's border. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
5224
|
+
borderColor?: string;
|
|
5225
|
+
/** The opacity of the node's border */
|
|
5226
|
+
borderOpacity?: number;
|
|
5227
|
+
/** The amount of padding around all sides of the node. */
|
|
5228
|
+
padding?: number;
|
|
5229
|
+
/** The horizontal alignment of a node's label */
|
|
5230
|
+
textHalign?: "left" | "center" | "right";
|
|
5231
|
+
/** The vertical alignment of a node's label */
|
|
5232
|
+
textValign?: "top" | "center" | "bottom";
|
|
5233
|
+
/** Whether to use the ghost effect, a semitransparent duplicate of the element drawn at an offset. */
|
|
5234
|
+
ghost?: "yes" | "no";
|
|
5235
|
+
/** The colour of the indicator shown when the background is grabbed by the user. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
5236
|
+
activeBgColor?: string;
|
|
5237
|
+
/** The opacity of the active background indicator. Selector needs to be *core*. */
|
|
5238
|
+
activeBgOpacity?: string;
|
|
5239
|
+
/** The opacity of the active background indicator. Selector needs to be *core*. */
|
|
5240
|
+
activeBgSize?: string;
|
|
5241
|
+
/** The background colour of the selection box used for drag selection. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
5242
|
+
selectionBoxColor?: string;
|
|
5243
|
+
/** The size of the border on the selection box. Selector needs to be *core* */
|
|
5244
|
+
selectionBoxBorderWidth?: number;
|
|
5245
|
+
/** The opacity of the selection box. Selector needs to be *core* */
|
|
5246
|
+
selectionBoxOpacity?: number;
|
|
5247
|
+
/** The colour of the area outside the viewport texture when initOptions.textureOnViewport === true. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
5248
|
+
outsideTextureBgColor?: string;
|
|
5249
|
+
/** The opacity of the area outside the viewport texture. Selector needs to be *core* */
|
|
5250
|
+
outsideTextureBgOpacity?: number;
|
|
5251
|
+
/** An array (or a space-separated string) of numbers ranging on [-1, 1], representing alternating x and y values (i.e. x1 y1 x2 y2, x3 y3 ...). This represents the points in the polygon for the node's shape. The bounding box of the node is given by (-1, -1), (1, -1), (1, 1), (-1, 1). The node's position is the origin (0, 0 ) */
|
|
5252
|
+
shapePolygonPoints?: string;
|
|
5253
|
+
/** The colour of the background of the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
5254
|
+
menuBackgroundColor?: string;
|
|
5255
|
+
/** The opacity of the background of the component menu. */
|
|
5256
|
+
menuBackgroundOpacity?: number;
|
|
5257
|
+
/** The colour of the text or icons in the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
5258
|
+
menuForgroundColor?: string;
|
|
5259
|
+
};
|
|
5260
|
+
/** Map describing the connection state machine. Each key is a current connection status and its value is the list of states the connection may transition to from that status. */
|
|
5261
|
+
transitionMap?: {
|
|
5262
|
+
[key: string]: {
|
|
5263
|
+
/** Connection Status Value */
|
|
5264
|
+
nextState: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
|
|
5265
|
+
/** Human-readable explanation of when or why this transition occurs. */
|
|
5266
|
+
description?: string;
|
|
5267
|
+
}[];
|
|
5268
|
+
};
|
|
5269
|
+
};
|
|
5072
5270
|
};
|
|
5073
5271
|
type GetConnectionDefinitionApiResponse = any;
|
|
5074
5272
|
type GetConnectionDefinitionApiArg = {
|
|
@@ -5079,7 +5277,197 @@ type UpdateConnectionDefinitionApiResponse = any;
|
|
|
5079
5277
|
type UpdateConnectionDefinitionApiArg = {
|
|
5080
5278
|
/** Connection definition ID */
|
|
5081
5279
|
connectionDefinitionId: string;
|
|
5082
|
-
body:
|
|
5280
|
+
body: {
|
|
5281
|
+
/** Existing connection definition ID for updates; omit on create. */
|
|
5282
|
+
id?: string;
|
|
5283
|
+
/** Specifies the version of the schema the definition conforms to. */
|
|
5284
|
+
schemaVersion?: string;
|
|
5285
|
+
/** Connection definition name */
|
|
5286
|
+
name: string;
|
|
5287
|
+
/** Human-readable description of the connection definition and its purpose. */
|
|
5288
|
+
description?: string;
|
|
5289
|
+
/** URL of the remote resource connections of this kind point to. */
|
|
5290
|
+
url?: string;
|
|
5291
|
+
/** Connection kind (e.g., kubernetes, prometheus, grafana) */
|
|
5292
|
+
kind: string;
|
|
5293
|
+
/** Connection type (platform, telemetry, collaboration) */
|
|
5294
|
+
type: string;
|
|
5295
|
+
/** Connection sub-type (cloud, identity, metrics, chat, git, orchestration) */
|
|
5296
|
+
subType: string;
|
|
5297
|
+
/** Connection Status Value */
|
|
5298
|
+
status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
|
|
5299
|
+
/** Reference to the registered model that owns this connection definition. */
|
|
5300
|
+
modelReference?: {
|
|
5301
|
+
/** A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. */
|
|
5302
|
+
id: string;
|
|
5303
|
+
/** The unique name for the model within the scope of a registrant. */
|
|
5304
|
+
name: string;
|
|
5305
|
+
/** Version of the model definition. */
|
|
5306
|
+
version: string;
|
|
5307
|
+
/** Human-readable name for the model. */
|
|
5308
|
+
displayName: string;
|
|
5309
|
+
/** Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
|
|
5310
|
+
model: {
|
|
5311
|
+
/** Version of the model as defined by the registrant. */
|
|
5312
|
+
version: string;
|
|
5313
|
+
};
|
|
5314
|
+
registrant: {
|
|
5315
|
+
/** Kind of the registrant. */
|
|
5316
|
+
kind: string;
|
|
5317
|
+
};
|
|
5318
|
+
};
|
|
5319
|
+
/** Kind-specific connection metadata */
|
|
5320
|
+
metadata?: object;
|
|
5321
|
+
/** Schema for the credential associated with connections of this kind. */
|
|
5322
|
+
credentialSchema?: object;
|
|
5323
|
+
/** Schema for connections of this kind. */
|
|
5324
|
+
connectionSchema?: object;
|
|
5325
|
+
/** Visualization styles for the connection, including svgColor and svgWhite used for UI representation. */
|
|
5326
|
+
styles?: {
|
|
5327
|
+
/** Primary color of the component used for UI representation. */
|
|
5328
|
+
primaryColor: string;
|
|
5329
|
+
/** Secondary color of the entity used for UI representation. */
|
|
5330
|
+
secondaryColor?: string;
|
|
5331
|
+
/** White SVG of the entity used for UI representation on dark background. */
|
|
5332
|
+
svgWhite: string;
|
|
5333
|
+
/** Colored SVG of the entity used for UI representation on light background. */
|
|
5334
|
+
svgColor: string;
|
|
5335
|
+
/** Complete SVG of the entity used for UI representation, often inclusive of background. */
|
|
5336
|
+
svgComplete: string;
|
|
5337
|
+
/** The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
5338
|
+
color?: string;
|
|
5339
|
+
/** The opacity of the label text, including its outline. */
|
|
5340
|
+
textOpacity?: number;
|
|
5341
|
+
/** A comma-separated list of font names to use on the label text. */
|
|
5342
|
+
fontFamily?: string;
|
|
5343
|
+
/** The size of the label text. */
|
|
5344
|
+
fontSize?: string;
|
|
5345
|
+
/** A CSS font style to be applied to the label text. */
|
|
5346
|
+
fontStyle?: string;
|
|
5347
|
+
/** A CSS font weight to be applied to the label text. */
|
|
5348
|
+
fontWeight?: string;
|
|
5349
|
+
/** A transformation to apply to the label text */
|
|
5350
|
+
textTransform?: "none" | "uppercase" | "lowercase";
|
|
5351
|
+
/** The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children. */
|
|
5352
|
+
opacity?: number;
|
|
5353
|
+
/** An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index. */
|
|
5354
|
+
zIndex?: number;
|
|
5355
|
+
/** The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
|
|
5356
|
+
label?: string;
|
|
5357
|
+
/** The animation to apply to the element. example ripple,bounce,etc */
|
|
5358
|
+
animation?: object;
|
|
5359
|
+
[key: string]: any;
|
|
5360
|
+
} & {
|
|
5361
|
+
/** The shape of the node's body. Note that each shape fits within the specified width and height, and so you may have to adjust width and height if you desire an equilateral shape (i.e. width !== height for several equilateral shapes) */
|
|
5362
|
+
shape: "ellipse" | "triangle" | "round-triangle" | "rectangle" | "round-rectangle" | "bottom-round-rectangle" | "cut-rectangle" | "barrel" | "rhomboid" | "diamond" | "round-diamond" | "pentagon" | "round-pentagon" | "hexagon" | "round-hexagon" | "concave-hexagon" | "heptagon" | "round-heptagon" | "octagon" | "round-octagon" | "star" | "tag" | "round-tag" | "vee" | "polygon";
|
|
5363
|
+
/** The position of the node. If the position is set, the node is drawn at that position in the given dimensions. If the position is not set, the node is drawn at a random position. */
|
|
5364
|
+
position?: {
|
|
5365
|
+
/** The x-coordinate of the node. */
|
|
5366
|
+
x: number;
|
|
5367
|
+
/** The y-coordinate of the node. */
|
|
5368
|
+
y: number;
|
|
5369
|
+
};
|
|
5370
|
+
/** The text to display for an element's body. Can give a path, e.g. data(id) will label with the elements id */
|
|
5371
|
+
bodyText?: string;
|
|
5372
|
+
/** How to wrap the text in the node. Can be 'none', 'wrap', or 'ellipsis'. */
|
|
5373
|
+
bodyTextWrap?: "none" | "wrap" | "ellipsis";
|
|
5374
|
+
/** The maximum width for wrapping text in the node. */
|
|
5375
|
+
bodyTextMaxWidth?: string;
|
|
5376
|
+
/** The opacity of the node's body text, including its outline. */
|
|
5377
|
+
bodyTextOpacity?: number;
|
|
5378
|
+
/** The colour of the node's body text background. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
5379
|
+
bodyTextBackgroundColor?: string;
|
|
5380
|
+
/** The size of the node's body text. */
|
|
5381
|
+
bodyTextFontSize?: number;
|
|
5382
|
+
/** The colour of the node's body text. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
5383
|
+
bodyTextColor?: string;
|
|
5384
|
+
/** A CSS font weight to be applied to the node's body text. */
|
|
5385
|
+
bodyTextFontWeight?: string;
|
|
5386
|
+
/** A CSS horizontal alignment to be applied to the node's body text. */
|
|
5387
|
+
bodyTextHorizontalAlign?: string;
|
|
5388
|
+
/** A CSS text decoration to be applied to the node's body text. */
|
|
5389
|
+
bodyTextDecoration?: string;
|
|
5390
|
+
/** A CSS vertical alignment to be applied to the node's body text. */
|
|
5391
|
+
bodyTextVerticalAlign?: string;
|
|
5392
|
+
/** The width of the node's body or the width of an edge's line. */
|
|
5393
|
+
width?: number;
|
|
5394
|
+
/** The height of the node's body */
|
|
5395
|
+
height?: number;
|
|
5396
|
+
/** The URL that points to the image to show in the node. */
|
|
5397
|
+
backgroundImage?: string;
|
|
5398
|
+
/** The colour of the node's body. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
5399
|
+
backgroundColor?: string;
|
|
5400
|
+
/** Blackens the node's body for values from 0 to 1; whitens the node's body for values from 0 to -1. */
|
|
5401
|
+
backgroundBlacken?: number;
|
|
5402
|
+
/** The opacity level of the node's background colour */
|
|
5403
|
+
backgroundOpacity?: number;
|
|
5404
|
+
/** The x position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
|
|
5405
|
+
backgroundPositionX?: string;
|
|
5406
|
+
/** The y position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
|
|
5407
|
+
backgroundPositionY?: string;
|
|
5408
|
+
/** The x offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
|
|
5409
|
+
backgroundOffsetX?: string;
|
|
5410
|
+
/** The y offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
|
|
5411
|
+
backgroundOffsetY?: string;
|
|
5412
|
+
/** How the background image is fit to the node. Can be 'none', 'contain', or 'cover'. */
|
|
5413
|
+
backgroundFit?: "none" | "contain" | "cover";
|
|
5414
|
+
/** How the background image is clipped to the node. Can be 'none', 'node', or 'node-border'. */
|
|
5415
|
+
backgroundClip?: "none" | "node" | "node-border";
|
|
5416
|
+
/** How the background image's width is determined. Can be 'none', 'inner', or 'outer'. */
|
|
5417
|
+
backgroundWidthRelativeTo?: "none" | "inner" | "outer";
|
|
5418
|
+
/** How the background image's height is determined. Can be 'none', 'inner', or 'outer'. */
|
|
5419
|
+
backgroundHeightRelativeTo?: "none" | "inner" | "outer";
|
|
5420
|
+
/** The size of the node's border. */
|
|
5421
|
+
borderWidth?: number;
|
|
5422
|
+
/** The style of the node's border */
|
|
5423
|
+
borderStyle?: "solid" | "dotted" | "dashed" | "double";
|
|
5424
|
+
/** The colour of the node's border. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
5425
|
+
borderColor?: string;
|
|
5426
|
+
/** The opacity of the node's border */
|
|
5427
|
+
borderOpacity?: number;
|
|
5428
|
+
/** The amount of padding around all sides of the node. */
|
|
5429
|
+
padding?: number;
|
|
5430
|
+
/** The horizontal alignment of a node's label */
|
|
5431
|
+
textHalign?: "left" | "center" | "right";
|
|
5432
|
+
/** The vertical alignment of a node's label */
|
|
5433
|
+
textValign?: "top" | "center" | "bottom";
|
|
5434
|
+
/** Whether to use the ghost effect, a semitransparent duplicate of the element drawn at an offset. */
|
|
5435
|
+
ghost?: "yes" | "no";
|
|
5436
|
+
/** The colour of the indicator shown when the background is grabbed by the user. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
5437
|
+
activeBgColor?: string;
|
|
5438
|
+
/** The opacity of the active background indicator. Selector needs to be *core*. */
|
|
5439
|
+
activeBgOpacity?: string;
|
|
5440
|
+
/** The opacity of the active background indicator. Selector needs to be *core*. */
|
|
5441
|
+
activeBgSize?: string;
|
|
5442
|
+
/** The background colour of the selection box used for drag selection. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
5443
|
+
selectionBoxColor?: string;
|
|
5444
|
+
/** The size of the border on the selection box. Selector needs to be *core* */
|
|
5445
|
+
selectionBoxBorderWidth?: number;
|
|
5446
|
+
/** The opacity of the selection box. Selector needs to be *core* */
|
|
5447
|
+
selectionBoxOpacity?: number;
|
|
5448
|
+
/** The colour of the area outside the viewport texture when initOptions.textureOnViewport === true. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
5449
|
+
outsideTextureBgColor?: string;
|
|
5450
|
+
/** The opacity of the area outside the viewport texture. Selector needs to be *core* */
|
|
5451
|
+
outsideTextureBgOpacity?: number;
|
|
5452
|
+
/** An array (or a space-separated string) of numbers ranging on [-1, 1], representing alternating x and y values (i.e. x1 y1 x2 y2, x3 y3 ...). This represents the points in the polygon for the node's shape. The bounding box of the node is given by (-1, -1), (1, -1), (1, 1), (-1, 1). The node's position is the origin (0, 0 ) */
|
|
5453
|
+
shapePolygonPoints?: string;
|
|
5454
|
+
/** The colour of the background of the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
5455
|
+
menuBackgroundColor?: string;
|
|
5456
|
+
/** The opacity of the background of the component menu. */
|
|
5457
|
+
menuBackgroundOpacity?: number;
|
|
5458
|
+
/** The colour of the text or icons in the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
5459
|
+
menuForgroundColor?: string;
|
|
5460
|
+
};
|
|
5461
|
+
/** Map describing the connection state machine. Each key is a current connection status and its value is the list of states the connection may transition to from that status. */
|
|
5462
|
+
transitionMap?: {
|
|
5463
|
+
[key: string]: {
|
|
5464
|
+
/** Connection Status Value */
|
|
5465
|
+
nextState: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
|
|
5466
|
+
/** Human-readable explanation of when or why this transition occurs. */
|
|
5467
|
+
description?: string;
|
|
5468
|
+
}[];
|
|
5469
|
+
};
|
|
5470
|
+
};
|
|
5083
5471
|
};
|
|
5084
5472
|
type DeleteConnectionDefinitionApiResponse = unknown;
|
|
5085
5473
|
type DeleteConnectionDefinitionApiArg = {
|
|
@@ -5175,7 +5563,9 @@ type GetEnvironmentsApiArg = {
|
|
|
5175
5563
|
order?: string;
|
|
5176
5564
|
/** Get responses by page */
|
|
5177
5565
|
page?: string;
|
|
5178
|
-
/**
|
|
5566
|
+
/** Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
|
|
5567
|
+
pageSize?: number;
|
|
5568
|
+
/** Get responses by pagesize. Deprecated alias of pageSize. */
|
|
5179
5569
|
pagesize?: string;
|
|
5180
5570
|
/** User's organization ID */
|
|
5181
5571
|
orgId: string;
|
|
@@ -5287,7 +5677,9 @@ type GetEnvironmentConnectionsApiArg = {
|
|
|
5287
5677
|
order?: string;
|
|
5288
5678
|
/** Get responses by page */
|
|
5289
5679
|
page?: string;
|
|
5290
|
-
/**
|
|
5680
|
+
/** Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
|
|
5681
|
+
pageSize?: number;
|
|
5682
|
+
/** Get responses by pagesize. Deprecated alias of pageSize. */
|
|
5291
5683
|
pagesize?: string;
|
|
5292
5684
|
/** JSON-encoded filter string used to scope the connection listing. */
|
|
5293
5685
|
filter?: string;
|
|
@@ -5774,7 +6166,9 @@ type GetWorkspacesApiArg = {
|
|
|
5774
6166
|
order?: string;
|
|
5775
6167
|
/** Get responses by page */
|
|
5776
6168
|
page?: string;
|
|
5777
|
-
/**
|
|
6169
|
+
/** Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
|
|
6170
|
+
pageSize?: number;
|
|
6171
|
+
/** Get responses by pagesize. Deprecated alias of pageSize. */
|
|
5778
6172
|
pagesize?: string;
|
|
5779
6173
|
/** JSON-encoded filter string used for assignment and soft-delete filters. */
|
|
5780
6174
|
filter?: string;
|
|
@@ -5904,7 +6298,9 @@ type GetTeamsOfWorkspaceApiArg = {
|
|
|
5904
6298
|
order?: string;
|
|
5905
6299
|
/** Get responses by page */
|
|
5906
6300
|
page?: string;
|
|
5907
|
-
/**
|
|
6301
|
+
/** Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
|
|
6302
|
+
pageSize?: number;
|
|
6303
|
+
/** Get responses by pagesize. Deprecated alias of pageSize. */
|
|
5908
6304
|
pagesize?: string;
|
|
5909
6305
|
/** JSON-encoded filter string used for assignment and soft-delete filters. */
|
|
5910
6306
|
filter?: string;
|
|
@@ -5984,7 +6380,9 @@ type GetEnvironmentsOfWorkspaceApiArg = {
|
|
|
5984
6380
|
order?: string;
|
|
5985
6381
|
/** Get responses by page */
|
|
5986
6382
|
page?: string;
|
|
5987
|
-
/**
|
|
6383
|
+
/** Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
|
|
6384
|
+
pageSize?: number;
|
|
6385
|
+
/** Get responses by pagesize. Deprecated alias of pageSize. */
|
|
5988
6386
|
pagesize?: string;
|
|
5989
6387
|
/** JSON-encoded filter string used for assignment and soft-delete filters. */
|
|
5990
6388
|
filter?: string;
|
|
@@ -6901,7 +7299,9 @@ type GetDesignsOfWorkspaceApiArg = {
|
|
|
6901
7299
|
order?: string;
|
|
6902
7300
|
/** Get responses by page */
|
|
6903
7301
|
page?: string;
|
|
6904
|
-
/**
|
|
7302
|
+
/** Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
|
|
7303
|
+
pageSize?: number;
|
|
7304
|
+
/** Get responses by pagesize. Deprecated alias of pageSize. */
|
|
6905
7305
|
pagesize?: string;
|
|
6906
7306
|
/** JSON-encoded filter string used for assignment and soft-delete filters. */
|
|
6907
7307
|
filter?: string;
|
|
@@ -6983,7 +7383,9 @@ type GetViewsOfWorkspaceApiArg = {
|
|
|
6983
7383
|
order?: string;
|
|
6984
7384
|
/** Get responses by page */
|
|
6985
7385
|
page?: string;
|
|
6986
|
-
/**
|
|
7386
|
+
/** Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
|
|
7387
|
+
pageSize?: number;
|
|
7388
|
+
/** Get responses by pagesize. Deprecated alias of pageSize. */
|
|
6987
7389
|
pagesize?: string;
|
|
6988
7390
|
/** JSON-encoded filter string used for assignment and soft-delete filters. */
|
|
6989
7391
|
filter?: string;
|