@meshery/schemas 1.3.79 → 1.3.81

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.
@@ -6492,7 +6492,7 @@ type RegisterRegistryComponentApiArg = {
6492
6492
  type: string;
6493
6493
  /** Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
6494
6494
  subType: string;
6495
- /** Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
6495
+ /** Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github, desktop) */
6496
6496
  kind: string;
6497
6497
  /** Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
6498
6498
  modelReference?: {
@@ -6675,6 +6675,9 @@ type RegisterRegistryComponentApiArg = {
6675
6675
  updatedAt?: string;
6676
6676
  /** Timestamp when the connection was soft-deleted, if applicable. */
6677
6677
  deletedAt?: string | null;
6678
+ /** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.machineId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
6679
+ */
6680
+ organizationId?: string;
6678
6681
  /** Associated environments for this connection */
6679
6682
  environments?: {
6680
6683
  /** ID */
@@ -7190,7 +7193,7 @@ type RegisterRegistryRelationshipApiArg = {
7190
7193
  type: string;
7191
7194
  /** Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
7192
7195
  subType: string;
7193
- /** Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
7196
+ /** Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github, desktop) */
7194
7197
  kind: string;
7195
7198
  /** Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
7196
7199
  modelReference?: {
@@ -7373,6 +7376,9 @@ type RegisterRegistryRelationshipApiArg = {
7373
7376
  updatedAt?: string;
7374
7377
  /** Timestamp when the connection was soft-deleted, if applicable. */
7375
7378
  deletedAt?: string | null;
7379
+ /** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.machineId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
7380
+ */
7381
+ organizationId?: string;
7376
7382
  /** Associated environments for this connection */
7377
7383
  environments?: {
7378
7384
  /** ID */
@@ -10426,7 +10432,7 @@ type GetConnectionsApiResponse = {
10426
10432
  type: string;
10427
10433
  /** Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
10428
10434
  subType: string;
10429
- /** Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
10435
+ /** Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github, desktop) */
10430
10436
  kind: string;
10431
10437
  /** Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
10432
10438
  modelReference?: {
@@ -10609,6 +10615,9 @@ type GetConnectionsApiResponse = {
10609
10615
  updatedAt?: string;
10610
10616
  /** Timestamp when the connection was soft-deleted, if applicable. */
10611
10617
  deletedAt?: string | null;
10618
+ /** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.machineId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
10619
+ */
10620
+ organizationId?: string;
10612
10621
  /** Associated environments for this connection */
10613
10622
  environments?: {
10614
10623
  /** ID */
@@ -10693,7 +10702,7 @@ type RegisterConnectionApiResponse = {
10693
10702
  type: string;
10694
10703
  /** Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
10695
10704
  subType: string;
10696
- /** Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
10705
+ /** Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github, desktop) */
10697
10706
  kind: string;
10698
10707
  /** Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
10699
10708
  modelReference?: {
@@ -10876,6 +10885,9 @@ type RegisterConnectionApiResponse = {
10876
10885
  updatedAt?: string;
10877
10886
  /** Timestamp when the connection was soft-deleted, if applicable. */
10878
10887
  deletedAt?: string | null;
10888
+ /** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.machineId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
10889
+ */
10890
+ organizationId?: string;
10879
10891
  /** Associated environments for this connection */
10880
10892
  environments?: {
10881
10893
  /** ID */
@@ -10899,20 +10911,259 @@ type RegisterConnectionApiResponse = {
10899
10911
  /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
10900
10912
  deletedAt?: string | null;
10901
10913
  /** What the environment exists for. `user` is an ordinary environment that people create to logically group Connections and their Credentials. `administrative` designates an environment the platform itself provisions to hold organization-level configuration, and which resolvers of that configuration therefore trust. `profile` is an ordinary, non-privileged environment that holds one profile, by convention one per profile: `name` is the profile's short name, `owner` is the profile's user, `metadata` holds the profile's settings, and the profile's accounts are linked as Connections. Like `user`, it carries no authority and a client may choose it.
10902
-
10903
- Absent means `user`. Nothing may read an unset or unrecognised value as administrative: test for the administrative value explicitly rather than for "not user", so the property fails closed.
10904
-
10905
- At most one live environment per organization may carry any single privileged purpose - `administrative`, and each privileged value a later version adds. Name those values explicitly wherever the rule is enforced, including the database index predicate: a "not `user`" test also matches the empty value that unmigrated rows and un-normalised writes read back as, which means ordinary. A resolver that selects an environment by purpose MUST fail closed when more than one live row matches: return an error rather than whichever row the database happened to return first.
10906
-
10907
- Privileged values are server-owned and never client-settable. `EnvironmentPayload`, which every environment POST and PUT requestBody references, accepts only the non-privileged values (`user` and `profile`), and the create-or-edit form has no field for it, so the environment create and update endpoints cannot designate an environment administrative. That restriction is a codegen guarantee, never access control: the registrant connection inlines the full environment entity, so `registerRegistryComponent` and `registerRegistryRelationship` do carry `purpose` in a request type and consumers MUST refuse it on input there too. Whatever surface a value arrives on, every consumer MUST assign this property only from server-side provisioning or a data migration. Permission to create an environment does not confer the ability to make one administrative.
10908
-
10909
- The database index that enforces the uniqueness invariant, the migration path for environments that are administrative by naming convention today, and each consumer's obligations are specified in https://github.com/meshery/schemas/blob/master/docs/environment-purpose-contract.md. */
10914
+
10915
+ Absent means `user`. Nothing may read an unset or unrecognised value as administrative: test for the administrative value explicitly rather than for "not user", so the property fails closed.
10916
+
10917
+ At most one live environment per organization may carry any single privileged purpose - `administrative`, and each privileged value a later version adds. Name those values explicitly wherever the rule is enforced, including the database index predicate: a "not `user`" test also matches the empty value that unmigrated rows and un-normalised writes read back as, which means ordinary. A resolver that selects an environment by purpose MUST fail closed when more than one live row matches: return an error rather than whichever row the database happened to return first.
10918
+
10919
+ Privileged values are server-owned and never client-settable. `EnvironmentPayload`, which every environment POST and PUT requestBody references, accepts only the non-privileged values (`user` and `profile`), and the create-or-edit form has no field for it, so the environment create and update endpoints cannot designate an environment administrative. That restriction is a codegen guarantee, never access control: the registrant connection inlines the full environment entity, so `registerRegistryComponent` and `registerRegistryRelationship` do carry `purpose` in a request type and consumers MUST refuse it on input there too. Whatever surface a value arrives on, every consumer MUST assign this property only from server-side provisioning or a data migration. Permission to create an environment does not confer the ability to make one administrative.
10920
+
10921
+ The database index that enforces the uniqueness invariant, the migration path for environments that are administrative by naming convention today, and each consumer's obligations are specified in https://github.com/meshery/schemas/blob/master/docs/environment-purpose-contract.md. */
10922
+ purpose?: "user" | "administrative" | "profile";
10923
+ }[];
10924
+ /** Specifies the version of the schema used for the definition. */
10925
+ schemaVersion: string;
10926
+ } | /** status 201 Connection registered */ {
10927
+ /** Connection ID */
10928
+ id: string;
10929
+ /** Connection Name */
10930
+ name: string;
10931
+ /** Human-readable description of the connection and its purpose. */
10932
+ description?: string;
10933
+ /** URL of the remote resource this connection points to (e.g. the Helm repository URL, the Kubernetes API server endpoint, the Grafana instance URL). */
10934
+ url?: string;
10935
+ /** Associated Credential ID */
10936
+ credentialId?: string;
10937
+ /** Connection Type (platform, telemetry, collaboration) */
10938
+ type: string;
10939
+ /** Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
10940
+ subType: string;
10941
+ /** Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github, desktop) */
10942
+ kind: string;
10943
+ /** Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
10944
+ modelReference?: {
10945
+ /** A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. */
10946
+ id: string;
10947
+ /** The unique name for the model within the scope of a registrant. */
10948
+ name: string;
10949
+ /** Version of the model definition. */
10950
+ version: string;
10951
+ /** Human-readable name for the model. */
10952
+ displayName: string;
10953
+ /** Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
10954
+ model: {
10955
+ /** Version of the model as defined by the registrant. */
10956
+ version: string;
10957
+ };
10958
+ registrant: {
10959
+ /** Kind of the registrant. */
10960
+ kind: string;
10961
+ };
10962
+ };
10963
+ /** Additional connection metadata */
10964
+ metadata?: object;
10965
+ /** Schema for the credential Associated with the connection */
10966
+ credentialSchema?: object;
10967
+ /** Schema for the connection */
10968
+ connectionSchema?: object;
10969
+ /** Visualization styles for the connection, including svgColor and svgWhite used for UI representation. */
10970
+ styles?: {
10971
+ /** Primary color of the component used for UI representation. */
10972
+ primaryColor: string;
10973
+ /** Secondary color of the entity used for UI representation. */
10974
+ secondaryColor?: string;
10975
+ /** White SVG of the entity used for UI representation on dark background. */
10976
+ svgWhite: string;
10977
+ /** Colored SVG of the entity used for UI representation on light background. */
10978
+ svgColor: string;
10979
+ /** Complete SVG of the entity used for UI representation, often inclusive of background. */
10980
+ svgComplete: string;
10981
+ /** The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
10982
+ color?: string;
10983
+ /** The opacity of the label text, including its outline. */
10984
+ textOpacity?: number;
10985
+ /** A comma-separated list of font names to use on the label text. */
10986
+ fontFamily?: string;
10987
+ /** The size of the label text. */
10988
+ fontSize?: string;
10989
+ /** A CSS font style to be applied to the label text. */
10990
+ fontStyle?: string;
10991
+ /** A CSS font weight to be applied to the label text. */
10992
+ fontWeight?: string;
10993
+ /** A transformation to apply to the label text */
10994
+ textTransform?: "none" | "uppercase" | "lowercase";
10995
+ /** 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. */
10996
+ opacity?: number;
10997
+ /** 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. */
10998
+ zIndex?: number;
10999
+ /** The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
11000
+ label?: string;
11001
+ /** The animation to apply to the element. example ripple,bounce,etc */
11002
+ animation?: object;
11003
+ [key: string]: any;
11004
+ } & {
11005
+ /** 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) */
11006
+ 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";
11007
+ /** 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. */
11008
+ position?: {
11009
+ /** The x-coordinate of the node. */
11010
+ x: number;
11011
+ /** The y-coordinate of the node. */
11012
+ y: number;
11013
+ };
11014
+ /** The text to display for an element's body. Can give a path, e.g. data(id) will label with the elements id */
11015
+ bodyText?: string;
11016
+ /** How to wrap the text in the node. Can be 'none', 'wrap', or 'ellipsis'. */
11017
+ bodyTextWrap?: "none" | "wrap" | "ellipsis";
11018
+ /** The maximum width for wrapping text in the node. */
11019
+ bodyTextMaxWidth?: string;
11020
+ /** The opacity of the node's body text, including its outline. */
11021
+ bodyTextOpacity?: number;
11022
+ /** The colour of the node's body text background. Colours may be specified by name (e.g. red), hex (e.g. */
11023
+ bodyTextBackgroundColor?: string;
11024
+ /** The size of the node's body text. */
11025
+ bodyTextFontSize?: number;
11026
+ /** The colour of the node's body text. Colours may be specified by name (e.g. red), hex (e.g. */
11027
+ bodyTextColor?: string;
11028
+ /** A CSS font weight to be applied to the node's body text. */
11029
+ bodyTextFontWeight?: string;
11030
+ /** A CSS horizontal alignment to be applied to the node's body text. */
11031
+ bodyTextHorizontalAlign?: string;
11032
+ /** A CSS text decoration to be applied to the node's body text. */
11033
+ bodyTextDecoration?: string;
11034
+ /** A CSS vertical alignment to be applied to the node's body text. */
11035
+ bodyTextVerticalAlign?: string;
11036
+ /** The width of the node's body or the width of an edge's line. */
11037
+ width?: number;
11038
+ /** The height of the node's body */
11039
+ height?: number;
11040
+ /** The URL that points to the image to show in the node. */
11041
+ backgroundImage?: string;
11042
+ /** The colour of the node's body. Colours may be specified by name (e.g. red), hex (e.g. */
11043
+ backgroundColor?: string;
11044
+ /** Blackens the node's body for values from 0 to 1; whitens the node's body for values from 0 to -1. */
11045
+ backgroundBlacken?: number;
11046
+ /** The opacity level of the node's background colour */
11047
+ backgroundOpacity?: number;
11048
+ /** The x position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
11049
+ backgroundPositionX?: string;
11050
+ /** The y position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
11051
+ backgroundPositionY?: string;
11052
+ /** The x offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
11053
+ backgroundOffsetX?: string;
11054
+ /** The y offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
11055
+ backgroundOffsetY?: string;
11056
+ /** How the background image is fit to the node. Can be 'none', 'contain', or 'cover'. */
11057
+ backgroundFit?: "none" | "contain" | "cover";
11058
+ /** How the background image is clipped to the node. Can be 'none', 'node', or 'node-border'. */
11059
+ backgroundClip?: "none" | "node" | "node-border";
11060
+ /** How the background image's width is determined. Can be 'none', 'inner', or 'outer'. */
11061
+ backgroundWidthRelativeTo?: "none" | "inner" | "outer";
11062
+ /** How the background image's height is determined. Can be 'none', 'inner', or 'outer'. */
11063
+ backgroundHeightRelativeTo?: "none" | "inner" | "outer";
11064
+ /** The size of the node's border. */
11065
+ borderWidth?: number;
11066
+ /** The style of the node's border */
11067
+ borderStyle?: "solid" | "dotted" | "dashed" | "double";
11068
+ /** The colour of the node's border. Colours may be specified by name (e.g. red), hex (e.g. */
11069
+ borderColor?: string;
11070
+ /** The opacity of the node's border */
11071
+ borderOpacity?: number;
11072
+ /** The amount of padding around all sides of the node. */
11073
+ padding?: number;
11074
+ /** The horizontal alignment of a node's label */
11075
+ textHalign?: "left" | "center" | "right";
11076
+ /** The vertical alignment of a node's label */
11077
+ textValign?: "top" | "center" | "bottom";
11078
+ /** Whether to use the ghost effect, a semitransparent duplicate of the element drawn at an offset. */
11079
+ ghost?: "yes" | "no";
11080
+ /** 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. */
11081
+ activeBgColor?: string;
11082
+ /** The opacity of the active background indicator. Selector needs to be *core*. */
11083
+ activeBgOpacity?: string;
11084
+ /** The opacity of the active background indicator. Selector needs to be *core*. */
11085
+ activeBgSize?: string;
11086
+ /** 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. */
11087
+ selectionBoxColor?: string;
11088
+ /** The size of the border on the selection box. Selector needs to be *core* */
11089
+ selectionBoxBorderWidth?: number;
11090
+ /** The opacity of the selection box. Selector needs to be *core* */
11091
+ selectionBoxOpacity?: number;
11092
+ /** 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. */
11093
+ outsideTextureBgColor?: string;
11094
+ /** The opacity of the area outside the viewport texture. Selector needs to be *core* */
11095
+ outsideTextureBgOpacity?: number;
11096
+ /** 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 ) */
11097
+ shapePolygonPoints?: string;
11098
+ /** The colour of the background of the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
11099
+ menuBackgroundColor?: string;
11100
+ /** The opacity of the background of the component menu. */
11101
+ menuBackgroundOpacity?: number;
11102
+ /** The colour of the text or icons in the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
11103
+ menuForgroundColor?: string;
11104
+ };
11105
+ /** Connection Status */
11106
+ status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
11107
+ /** 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, along with a description of each transition. */
11108
+ transitionMap?: {
11109
+ [key: string]: {
11110
+ /** Connection Status Value */
11111
+ nextState: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
11112
+ /** Human-readable explanation of when or why this transition occurs. */
11113
+ description?: string;
11114
+ }[];
11115
+ };
11116
+ /** User ID who owns this connection */
11117
+ owner?: string;
11118
+ /** Timestamp when the connection was created. */
11119
+ createdAt?: string;
11120
+ /** Timestamp when the connection was last updated. */
11121
+ updatedAt?: string;
11122
+ /** Timestamp when the connection was soft-deleted, if applicable. */
11123
+ deletedAt?: string | null;
11124
+ /** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.machineId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
11125
+ */
11126
+ organizationId?: string;
11127
+ /** Associated environments for this connection */
11128
+ environments?: {
11129
+ /** ID */
11130
+ id: string;
11131
+ /** Specifies the version of the schema to which the environment conforms. */
11132
+ schemaVersion: string;
11133
+ /** Environment name */
11134
+ name: string;
11135
+ /** Environment description */
11136
+ description: string;
11137
+ /** Environment organization ID */
11138
+ organizationId: string;
11139
+ /** Environment owner */
11140
+ owner?: string;
11141
+ /** Timestamp when the environment was created. */
11142
+ createdAt?: string;
11143
+ /** Additional metadata associated with the environment. */
11144
+ metadata?: object;
11145
+ /** Timestamp when the environment was last updated. */
11146
+ updatedAt?: string;
11147
+ /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
11148
+ deletedAt?: string | null;
11149
+ /** What the environment exists for. `user` is an ordinary environment that people create to logically group Connections and their Credentials. `administrative` designates an environment the platform itself provisions to hold organization-level configuration, and which resolvers of that configuration therefore trust. `profile` is an ordinary, non-privileged environment that holds one profile, by convention one per profile: `name` is the profile's short name, `owner` is the profile's user, `metadata` holds the profile's settings, and the profile's accounts are linked as Connections. Like `user`, it carries no authority and a client may choose it.
11150
+
11151
+ Absent means `user`. Nothing may read an unset or unrecognised value as administrative: test for the administrative value explicitly rather than for "not user", so the property fails closed.
11152
+
11153
+ At most one live environment per organization may carry any single privileged purpose - `administrative`, and each privileged value a later version adds. Name those values explicitly wherever the rule is enforced, including the database index predicate: a "not `user`" test also matches the empty value that unmigrated rows and un-normalised writes read back as, which means ordinary. A resolver that selects an environment by purpose MUST fail closed when more than one live row matches: return an error rather than whichever row the database happened to return first.
11154
+
11155
+ Privileged values are server-owned and never client-settable. `EnvironmentPayload`, which every environment POST and PUT requestBody references, accepts only the non-privileged values (`user` and `profile`), and the create-or-edit form has no field for it, so the environment create and update endpoints cannot designate an environment administrative. That restriction is a codegen guarantee, never access control: the registrant connection inlines the full environment entity, so `registerRegistryComponent` and `registerRegistryRelationship` do carry `purpose` in a request type and consumers MUST refuse it on input there too. Whatever surface a value arrives on, every consumer MUST assign this property only from server-side provisioning or a data migration. Permission to create an environment does not confer the ability to make one administrative.
11156
+
11157
+ The database index that enforces the uniqueness invariant, the migration path for environments that are administrative by naming convention today, and each consumer's obligations are specified in https://github.com/meshery/schemas/blob/master/docs/environment-purpose-contract.md. */
10910
11158
  purpose?: "user" | "administrative" | "profile";
10911
11159
  }[];
10912
11160
  /** Specifies the version of the schema used for the definition. */
10913
11161
  schemaVersion: string;
10914
11162
  };
10915
11163
  type RegisterConnectionApiArg = {
11164
+ /** Organization the connection is registered in. Required for kind `desktop`; ignored for other kinds.
11165
+ */
11166
+ "X-Current-Orgid"?: string;
10916
11167
  body: {
10917
11168
  /** Connection ID */
10918
11169
  id?: string;
@@ -11125,7 +11376,7 @@ type GetConnectionByIdApiResponse = {
11125
11376
  type: string;
11126
11377
  /** Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
11127
11378
  subType: string;
11128
- /** Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
11379
+ /** Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github, desktop) */
11129
11380
  kind: string;
11130
11381
  /** Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
11131
11382
  modelReference?: {
@@ -11308,6 +11559,9 @@ type GetConnectionByIdApiResponse = {
11308
11559
  updatedAt?: string;
11309
11560
  /** Timestamp when the connection was soft-deleted, if applicable. */
11310
11561
  deletedAt?: string | null;
11562
+ /** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.machineId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
11563
+ */
11564
+ organizationId?: string;
11311
11565
  /** Associated environments for this connection */
11312
11566
  environments?: {
11313
11567
  /** ID */
@@ -11363,7 +11617,7 @@ type UpdateConnectionApiResponse = {
11363
11617
  type: string;
11364
11618
  /** Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
11365
11619
  subType: string;
11366
- /** Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
11620
+ /** Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github, desktop) */
11367
11621
  kind: string;
11368
11622
  /** Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
11369
11623
  modelReference?: {
@@ -11546,6 +11800,9 @@ type UpdateConnectionApiResponse = {
11546
11800
  updatedAt?: string;
11547
11801
  /** Timestamp when the connection was soft-deleted, if applicable. */
11548
11802
  deletedAt?: string | null;
11803
+ /** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.machineId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
11804
+ */
11805
+ organizationId?: string;
11549
11806
  /** Associated environments for this connection */
11550
11807
  environments?: {
11551
11808
  /** ID */
@@ -11763,7 +12020,7 @@ type PerformConnectionActionApiResponse =
11763
12020
  type: string;
11764
12021
  /** Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
11765
12022
  subType: string;
11766
- /** Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
12023
+ /** Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github, desktop) */
11767
12024
  kind: string;
11768
12025
  /** Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
11769
12026
  modelReference?: {
@@ -11946,6 +12203,9 @@ type PerformConnectionActionApiResponse =
11946
12203
  updatedAt?: string;
11947
12204
  /** Timestamp when the connection was soft-deleted, if applicable. */
11948
12205
  deletedAt?: string | null;
12206
+ /** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.machineId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
12207
+ */
12208
+ organizationId?: string;
11949
12209
  /** Associated environments for this connection */
11950
12210
  environments?: {
11951
12211
  /** ID */