@meshery/schemas 1.3.52 → 1.3.54

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.
Files changed (27) hide show
  1. package/dist/cloudApi.d.mts +114 -0
  2. package/dist/cloudApi.d.ts +114 -0
  3. package/dist/constructs/v1beta1/organization_smtp/OrganizationSmtp.d.ts +13 -0
  4. package/dist/constructs/v1beta1/organization_smtp/OrganizationSmtpSchema.js +1 -1
  5. package/dist/constructs/v1beta1/organization_smtp/OrganizationSmtpSchema.mjs +1 -1
  6. package/dist/constructs/v1beta1/registry/Registry.d.ts +39 -0
  7. package/dist/constructs/v1beta1/registry/RegistrySchema.js +3 -3
  8. package/dist/constructs/v1beta1/registry/RegistrySchema.mjs +3 -3
  9. package/dist/constructs/v1beta2/organization/Organization.d.ts +80 -0
  10. package/dist/constructs/v1beta2/organization/OrganizationSchema.js +1 -1
  11. package/dist/constructs/v1beta2/organization/OrganizationSchema.mjs +1 -1
  12. package/dist/constructs/v1beta3/connection/Connection.d.ts +91 -0
  13. package/dist/constructs/v1beta3/connection/ConnectionSchema.js +1 -1
  14. package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +1 -1
  15. package/dist/constructs/v1beta3/environment/Environment.d.ts +80 -1
  16. package/dist/constructs/v1beta3/environment/EnvironmentSchema.js +1 -1
  17. package/dist/constructs/v1beta3/environment/EnvironmentSchema.mjs +1 -1
  18. package/dist/constructs/v1beta3/workspace/Workspace.d.ts +13 -0
  19. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.js +1 -1
  20. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.mjs +1 -1
  21. package/dist/index.d.mts +45 -0
  22. package/dist/index.d.ts +45 -0
  23. package/dist/index.js +1 -1
  24. package/dist/index.mjs +1 -1
  25. package/dist/mesheryApi.d.mts +134 -0
  26. package/dist/mesheryApi.d.ts +134 -0
  27. package/package.json +1 -1
@@ -6695,6 +6695,16 @@ type RegisterRegistryComponentApiArg = {
6695
6695
  updatedAt?: string;
6696
6696
  /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
6697
6697
  deletedAt?: string | null;
6698
+ /** 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.
6699
+
6700
+ 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.
6701
+
6702
+ 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.
6703
+
6704
+ Server-owned and not client-settable. It is absent from `EnvironmentPayload`, which every environment POST and PUT requestBody references, and from the create-or-edit form, so the environment create and update endpoints have no field for it. That exclusion 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.
6705
+
6706
+ 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. */
6707
+ purpose?: "user" | "administrative";
6698
6708
  }[];
6699
6709
  /** Specifies the version of the schema used for the definition. */
6700
6710
  schemaVersion: string;
@@ -7383,6 +7393,16 @@ type RegisterRegistryRelationshipApiArg = {
7383
7393
  updatedAt?: string;
7384
7394
  /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
7385
7395
  deletedAt?: string | null;
7396
+ /** 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.
7397
+
7398
+ 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.
7399
+
7400
+ 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.
7401
+
7402
+ Server-owned and not client-settable. It is absent from `EnvironmentPayload`, which every environment POST and PUT requestBody references, and from the create-or-edit form, so the environment create and update endpoints have no field for it. That exclusion 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.
7403
+
7404
+ 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. */
7405
+ purpose?: "user" | "administrative";
7386
7406
  }[];
7387
7407
  /** Specifies the version of the schema used for the definition. */
7388
7408
  schemaVersion: string;
@@ -8632,6 +8652,8 @@ type GetOrgsApiResponse = {
8632
8652
  linkedin?: string;
8633
8653
  /** URL of the organization's X (formerly Twitter) profile. */
8634
8654
  x?: string;
8655
+ /** URL of the organization's YouTube channel. */
8656
+ youtube?: string;
8635
8657
  };
8636
8658
  };
8637
8659
  /** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
@@ -8764,6 +8786,8 @@ type CreateOrgApiResponse = {
8764
8786
  linkedin?: string;
8765
8787
  /** URL of the organization's X (formerly Twitter) profile. */
8766
8788
  x?: string;
8789
+ /** URL of the organization's YouTube channel. */
8790
+ youtube?: string;
8767
8791
  };
8768
8792
  };
8769
8793
  /** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
@@ -8872,6 +8896,8 @@ type CreateOrgApiArg = {
8872
8896
  linkedin?: string;
8873
8897
  /** URL of the organization's X (formerly Twitter) profile. */
8874
8898
  x?: string;
8899
+ /** URL of the organization's YouTube channel. */
8900
+ youtube?: string;
8875
8901
  };
8876
8902
  };
8877
8903
  /** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
@@ -9013,6 +9039,8 @@ type GetOrgApiResponse = {
9013
9039
  linkedin?: string;
9014
9040
  /** URL of the organization's X (formerly Twitter) profile. */
9015
9041
  x?: string;
9042
+ /** URL of the organization's YouTube channel. */
9043
+ youtube?: string;
9016
9044
  };
9017
9045
  };
9018
9046
  /** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
@@ -9142,6 +9170,8 @@ type UpdateOrgApiResponse = {
9142
9170
  linkedin?: string;
9143
9171
  /** URL of the organization's X (formerly Twitter) profile. */
9144
9172
  x?: string;
9173
+ /** URL of the organization's YouTube channel. */
9174
+ youtube?: string;
9145
9175
  };
9146
9176
  };
9147
9177
  /** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
@@ -9252,6 +9282,8 @@ type UpdateOrgApiArg = {
9252
9282
  linkedin?: string;
9253
9283
  /** URL of the organization's X (formerly Twitter) profile. */
9254
9284
  x?: string;
9285
+ /** URL of the organization's YouTube channel. */
9286
+ youtube?: string;
9255
9287
  };
9256
9288
  };
9257
9289
  /** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
@@ -9341,6 +9373,8 @@ type GetOrgPreferencesApiResponse = {
9341
9373
  linkedin?: string;
9342
9374
  /** URL of the organization's X (formerly Twitter) profile. */
9343
9375
  x?: string;
9376
+ /** URL of the organization's YouTube channel. */
9377
+ youtube?: string;
9344
9378
  };
9345
9379
  };
9346
9380
  /** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
@@ -10247,6 +10281,16 @@ type GetConnectionsApiResponse = {
10247
10281
  updatedAt?: string;
10248
10282
  /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
10249
10283
  deletedAt?: string | null;
10284
+ /** 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.
10285
+
10286
+ 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.
10287
+
10288
+ 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.
10289
+
10290
+ Server-owned and not client-settable. It is absent from `EnvironmentPayload`, which every environment POST and PUT requestBody references, and from the create-or-edit form, so the environment create and update endpoints have no field for it. That exclusion 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.
10291
+
10292
+ 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. */
10293
+ purpose?: "user" | "administrative";
10250
10294
  }[];
10251
10295
  /** Specifies the version of the schema used for the definition. */
10252
10296
  schemaVersion: string;
@@ -10504,6 +10548,16 @@ type RegisterConnectionApiResponse = {
10504
10548
  updatedAt?: string;
10505
10549
  /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
10506
10550
  deletedAt?: string | null;
10551
+ /** 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.
10552
+
10553
+ 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.
10554
+
10555
+ 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.
10556
+
10557
+ Server-owned and not client-settable. It is absent from `EnvironmentPayload`, which every environment POST and PUT requestBody references, and from the create-or-edit form, so the environment create and update endpoints have no field for it. That exclusion 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.
10558
+
10559
+ 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. */
10560
+ purpose?: "user" | "administrative";
10507
10561
  }[];
10508
10562
  /** Specifies the version of the schema used for the definition. */
10509
10563
  schemaVersion: string;
@@ -10926,6 +10980,16 @@ type GetConnectionByIdApiResponse = {
10926
10980
  updatedAt?: string;
10927
10981
  /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
10928
10982
  deletedAt?: string | null;
10983
+ /** 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.
10984
+
10985
+ 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.
10986
+
10987
+ 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.
10988
+
10989
+ Server-owned and not client-settable. It is absent from `EnvironmentPayload`, which every environment POST and PUT requestBody references, and from the create-or-edit form, so the environment create and update endpoints have no field for it. That exclusion 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.
10990
+
10991
+ 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. */
10992
+ purpose?: "user" | "administrative";
10929
10993
  }[];
10930
10994
  /** Specifies the version of the schema used for the definition. */
10931
10995
  schemaVersion: string;
@@ -11154,6 +11218,16 @@ type UpdateConnectionApiResponse = {
11154
11218
  updatedAt?: string;
11155
11219
  /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
11156
11220
  deletedAt?: string | null;
11221
+ /** 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.
11222
+
11223
+ 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.
11224
+
11225
+ 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.
11226
+
11227
+ Server-owned and not client-settable. It is absent from `EnvironmentPayload`, which every environment POST and PUT requestBody references, and from the create-or-edit form, so the environment create and update endpoints have no field for it. That exclusion 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.
11228
+
11229
+ 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. */
11230
+ purpose?: "user" | "administrative";
11157
11231
  }[];
11158
11232
  /** Specifies the version of the schema used for the definition. */
11159
11233
  schemaVersion: string;
@@ -11544,6 +11618,16 @@ type PerformConnectionActionApiResponse =
11544
11618
  updatedAt?: string;
11545
11619
  /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
11546
11620
  deletedAt?: string | null;
11621
+ /** 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.
11622
+
11623
+ 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.
11624
+
11625
+ 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.
11626
+
11627
+ Server-owned and not client-settable. It is absent from `EnvironmentPayload`, which every environment POST and PUT requestBody references, and from the create-or-edit form, so the environment create and update endpoints have no field for it. That exclusion 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.
11628
+
11629
+ 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. */
11630
+ purpose?: "user" | "administrative";
11547
11631
  }[];
11548
11632
  /** Specifies the version of the schema used for the definition. */
11549
11633
  schemaVersion: string;
@@ -12317,6 +12401,16 @@ type CreateEnvironmentApiResponse = {
12317
12401
  updatedAt?: string;
12318
12402
  /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
12319
12403
  deletedAt?: string | null;
12404
+ /** 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.
12405
+
12406
+ 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.
12407
+
12408
+ 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.
12409
+
12410
+ Server-owned and not client-settable. It is absent from `EnvironmentPayload`, which every environment POST and PUT requestBody references, and from the create-or-edit form, so the environment create and update endpoints have no field for it. That exclusion 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.
12411
+
12412
+ 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. */
12413
+ purpose?: "user" | "administrative";
12320
12414
  };
12321
12415
  type CreateEnvironmentApiArg = {
12322
12416
  /** Body for creating environment */
@@ -12358,6 +12452,16 @@ type GetEnvironmentsApiResponse = {
12358
12452
  updatedAt?: string;
12359
12453
  /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
12360
12454
  deletedAt?: string | null;
12455
+ /** 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.
12456
+
12457
+ 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.
12458
+
12459
+ 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.
12460
+
12461
+ Server-owned and not client-settable. It is absent from `EnvironmentPayload`, which every environment POST and PUT requestBody references, and from the create-or-edit form, so the environment create and update endpoints have no field for it. That exclusion 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.
12462
+
12463
+ 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. */
12464
+ purpose?: "user" | "administrative";
12361
12465
  }[];
12362
12466
  };
12363
12467
  type GetEnvironmentsApiArg = {
@@ -12403,6 +12507,16 @@ type GetEnvironmentByIdApiResponse = {
12403
12507
  updatedAt?: string;
12404
12508
  /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
12405
12509
  deletedAt?: string | null;
12510
+ /** 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.
12511
+
12512
+ 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.
12513
+
12514
+ 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.
12515
+
12516
+ Server-owned and not client-settable. It is absent from `EnvironmentPayload`, which every environment POST and PUT requestBody references, and from the create-or-edit form, so the environment create and update endpoints have no field for it. That exclusion 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.
12517
+
12518
+ 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. */
12519
+ purpose?: "user" | "administrative";
12406
12520
  }[];
12407
12521
  };
12408
12522
  type GetEnvironmentByIdApiArg = {
@@ -12440,6 +12554,16 @@ type UpdateEnvironmentApiResponse = {
12440
12554
  updatedAt?: string;
12441
12555
  /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
12442
12556
  deletedAt?: string | null;
12557
+ /** 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.
12558
+
12559
+ 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.
12560
+
12561
+ 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.
12562
+
12563
+ Server-owned and not client-settable. It is absent from `EnvironmentPayload`, which every environment POST and PUT requestBody references, and from the create-or-edit form, so the environment create and update endpoints have no field for it. That exclusion 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.
12564
+
12565
+ 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. */
12566
+ purpose?: "user" | "administrative";
12443
12567
  }[];
12444
12568
  };
12445
12569
  type UpdateEnvironmentApiArg = {
@@ -13243,6 +13367,16 @@ type GetEnvironmentsOfWorkspaceApiResponse = {
13243
13367
  updatedAt?: string;
13244
13368
  /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
13245
13369
  deletedAt?: string | null;
13370
+ /** 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.
13371
+
13372
+ 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.
13373
+
13374
+ 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.
13375
+
13376
+ Server-owned and not client-settable. It is absent from `EnvironmentPayload`, which every environment POST and PUT requestBody references, and from the create-or-edit form, so the environment create and update endpoints have no field for it. That exclusion 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.
13377
+
13378
+ 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. */
13379
+ purpose?: "user" | "administrative";
13246
13380
  }[];
13247
13381
  };
13248
13382
  type GetEnvironmentsOfWorkspaceApiArg = {
@@ -6695,6 +6695,16 @@ type RegisterRegistryComponentApiArg = {
6695
6695
  updatedAt?: string;
6696
6696
  /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
6697
6697
  deletedAt?: string | null;
6698
+ /** 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.
6699
+
6700
+ 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.
6701
+
6702
+ 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.
6703
+
6704
+ Server-owned and not client-settable. It is absent from `EnvironmentPayload`, which every environment POST and PUT requestBody references, and from the create-or-edit form, so the environment create and update endpoints have no field for it. That exclusion 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.
6705
+
6706
+ 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. */
6707
+ purpose?: "user" | "administrative";
6698
6708
  }[];
6699
6709
  /** Specifies the version of the schema used for the definition. */
6700
6710
  schemaVersion: string;
@@ -7383,6 +7393,16 @@ type RegisterRegistryRelationshipApiArg = {
7383
7393
  updatedAt?: string;
7384
7394
  /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
7385
7395
  deletedAt?: string | null;
7396
+ /** 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.
7397
+
7398
+ 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.
7399
+
7400
+ 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.
7401
+
7402
+ Server-owned and not client-settable. It is absent from `EnvironmentPayload`, which every environment POST and PUT requestBody references, and from the create-or-edit form, so the environment create and update endpoints have no field for it. That exclusion 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.
7403
+
7404
+ 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. */
7405
+ purpose?: "user" | "administrative";
7386
7406
  }[];
7387
7407
  /** Specifies the version of the schema used for the definition. */
7388
7408
  schemaVersion: string;
@@ -8632,6 +8652,8 @@ type GetOrgsApiResponse = {
8632
8652
  linkedin?: string;
8633
8653
  /** URL of the organization's X (formerly Twitter) profile. */
8634
8654
  x?: string;
8655
+ /** URL of the organization's YouTube channel. */
8656
+ youtube?: string;
8635
8657
  };
8636
8658
  };
8637
8659
  /** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
@@ -8764,6 +8786,8 @@ type CreateOrgApiResponse = {
8764
8786
  linkedin?: string;
8765
8787
  /** URL of the organization's X (formerly Twitter) profile. */
8766
8788
  x?: string;
8789
+ /** URL of the organization's YouTube channel. */
8790
+ youtube?: string;
8767
8791
  };
8768
8792
  };
8769
8793
  /** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
@@ -8872,6 +8896,8 @@ type CreateOrgApiArg = {
8872
8896
  linkedin?: string;
8873
8897
  /** URL of the organization's X (formerly Twitter) profile. */
8874
8898
  x?: string;
8899
+ /** URL of the organization's YouTube channel. */
8900
+ youtube?: string;
8875
8901
  };
8876
8902
  };
8877
8903
  /** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
@@ -9013,6 +9039,8 @@ type GetOrgApiResponse = {
9013
9039
  linkedin?: string;
9014
9040
  /** URL of the organization's X (formerly Twitter) profile. */
9015
9041
  x?: string;
9042
+ /** URL of the organization's YouTube channel. */
9043
+ youtube?: string;
9016
9044
  };
9017
9045
  };
9018
9046
  /** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
@@ -9142,6 +9170,8 @@ type UpdateOrgApiResponse = {
9142
9170
  linkedin?: string;
9143
9171
  /** URL of the organization's X (formerly Twitter) profile. */
9144
9172
  x?: string;
9173
+ /** URL of the organization's YouTube channel. */
9174
+ youtube?: string;
9145
9175
  };
9146
9176
  };
9147
9177
  /** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
@@ -9252,6 +9282,8 @@ type UpdateOrgApiArg = {
9252
9282
  linkedin?: string;
9253
9283
  /** URL of the organization's X (formerly Twitter) profile. */
9254
9284
  x?: string;
9285
+ /** URL of the organization's YouTube channel. */
9286
+ youtube?: string;
9255
9287
  };
9256
9288
  };
9257
9289
  /** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
@@ -9341,6 +9373,8 @@ type GetOrgPreferencesApiResponse = {
9341
9373
  linkedin?: string;
9342
9374
  /** URL of the organization's X (formerly Twitter) profile. */
9343
9375
  x?: string;
9376
+ /** URL of the organization's YouTube channel. */
9377
+ youtube?: string;
9344
9378
  };
9345
9379
  };
9346
9380
  /** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
@@ -10247,6 +10281,16 @@ type GetConnectionsApiResponse = {
10247
10281
  updatedAt?: string;
10248
10282
  /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
10249
10283
  deletedAt?: string | null;
10284
+ /** 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.
10285
+
10286
+ 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.
10287
+
10288
+ 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.
10289
+
10290
+ Server-owned and not client-settable. It is absent from `EnvironmentPayload`, which every environment POST and PUT requestBody references, and from the create-or-edit form, so the environment create and update endpoints have no field for it. That exclusion 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.
10291
+
10292
+ 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. */
10293
+ purpose?: "user" | "administrative";
10250
10294
  }[];
10251
10295
  /** Specifies the version of the schema used for the definition. */
10252
10296
  schemaVersion: string;
@@ -10504,6 +10548,16 @@ type RegisterConnectionApiResponse = {
10504
10548
  updatedAt?: string;
10505
10549
  /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
10506
10550
  deletedAt?: string | null;
10551
+ /** 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.
10552
+
10553
+ 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.
10554
+
10555
+ 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.
10556
+
10557
+ Server-owned and not client-settable. It is absent from `EnvironmentPayload`, which every environment POST and PUT requestBody references, and from the create-or-edit form, so the environment create and update endpoints have no field for it. That exclusion 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.
10558
+
10559
+ 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. */
10560
+ purpose?: "user" | "administrative";
10507
10561
  }[];
10508
10562
  /** Specifies the version of the schema used for the definition. */
10509
10563
  schemaVersion: string;
@@ -10926,6 +10980,16 @@ type GetConnectionByIdApiResponse = {
10926
10980
  updatedAt?: string;
10927
10981
  /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
10928
10982
  deletedAt?: string | null;
10983
+ /** 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.
10984
+
10985
+ 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.
10986
+
10987
+ 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.
10988
+
10989
+ Server-owned and not client-settable. It is absent from `EnvironmentPayload`, which every environment POST and PUT requestBody references, and from the create-or-edit form, so the environment create and update endpoints have no field for it. That exclusion 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.
10990
+
10991
+ 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. */
10992
+ purpose?: "user" | "administrative";
10929
10993
  }[];
10930
10994
  /** Specifies the version of the schema used for the definition. */
10931
10995
  schemaVersion: string;
@@ -11154,6 +11218,16 @@ type UpdateConnectionApiResponse = {
11154
11218
  updatedAt?: string;
11155
11219
  /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
11156
11220
  deletedAt?: string | null;
11221
+ /** 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.
11222
+
11223
+ 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.
11224
+
11225
+ 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.
11226
+
11227
+ Server-owned and not client-settable. It is absent from `EnvironmentPayload`, which every environment POST and PUT requestBody references, and from the create-or-edit form, so the environment create and update endpoints have no field for it. That exclusion 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.
11228
+
11229
+ 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. */
11230
+ purpose?: "user" | "administrative";
11157
11231
  }[];
11158
11232
  /** Specifies the version of the schema used for the definition. */
11159
11233
  schemaVersion: string;
@@ -11544,6 +11618,16 @@ type PerformConnectionActionApiResponse =
11544
11618
  updatedAt?: string;
11545
11619
  /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
11546
11620
  deletedAt?: string | null;
11621
+ /** 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.
11622
+
11623
+ 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.
11624
+
11625
+ 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.
11626
+
11627
+ Server-owned and not client-settable. It is absent from `EnvironmentPayload`, which every environment POST and PUT requestBody references, and from the create-or-edit form, so the environment create and update endpoints have no field for it. That exclusion 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.
11628
+
11629
+ 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. */
11630
+ purpose?: "user" | "administrative";
11547
11631
  }[];
11548
11632
  /** Specifies the version of the schema used for the definition. */
11549
11633
  schemaVersion: string;
@@ -12317,6 +12401,16 @@ type CreateEnvironmentApiResponse = {
12317
12401
  updatedAt?: string;
12318
12402
  /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
12319
12403
  deletedAt?: string | null;
12404
+ /** 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.
12405
+
12406
+ 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.
12407
+
12408
+ 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.
12409
+
12410
+ Server-owned and not client-settable. It is absent from `EnvironmentPayload`, which every environment POST and PUT requestBody references, and from the create-or-edit form, so the environment create and update endpoints have no field for it. That exclusion 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.
12411
+
12412
+ 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. */
12413
+ purpose?: "user" | "administrative";
12320
12414
  };
12321
12415
  type CreateEnvironmentApiArg = {
12322
12416
  /** Body for creating environment */
@@ -12358,6 +12452,16 @@ type GetEnvironmentsApiResponse = {
12358
12452
  updatedAt?: string;
12359
12453
  /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
12360
12454
  deletedAt?: string | null;
12455
+ /** 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.
12456
+
12457
+ 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.
12458
+
12459
+ 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.
12460
+
12461
+ Server-owned and not client-settable. It is absent from `EnvironmentPayload`, which every environment POST and PUT requestBody references, and from the create-or-edit form, so the environment create and update endpoints have no field for it. That exclusion 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.
12462
+
12463
+ 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. */
12464
+ purpose?: "user" | "administrative";
12361
12465
  }[];
12362
12466
  };
12363
12467
  type GetEnvironmentsApiArg = {
@@ -12403,6 +12507,16 @@ type GetEnvironmentByIdApiResponse = {
12403
12507
  updatedAt?: string;
12404
12508
  /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
12405
12509
  deletedAt?: string | null;
12510
+ /** 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.
12511
+
12512
+ 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.
12513
+
12514
+ 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.
12515
+
12516
+ Server-owned and not client-settable. It is absent from `EnvironmentPayload`, which every environment POST and PUT requestBody references, and from the create-or-edit form, so the environment create and update endpoints have no field for it. That exclusion 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.
12517
+
12518
+ 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. */
12519
+ purpose?: "user" | "administrative";
12406
12520
  }[];
12407
12521
  };
12408
12522
  type GetEnvironmentByIdApiArg = {
@@ -12440,6 +12554,16 @@ type UpdateEnvironmentApiResponse = {
12440
12554
  updatedAt?: string;
12441
12555
  /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
12442
12556
  deletedAt?: string | null;
12557
+ /** 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.
12558
+
12559
+ 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.
12560
+
12561
+ 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.
12562
+
12563
+ Server-owned and not client-settable. It is absent from `EnvironmentPayload`, which every environment POST and PUT requestBody references, and from the create-or-edit form, so the environment create and update endpoints have no field for it. That exclusion 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.
12564
+
12565
+ 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. */
12566
+ purpose?: "user" | "administrative";
12443
12567
  }[];
12444
12568
  };
12445
12569
  type UpdateEnvironmentApiArg = {
@@ -13243,6 +13367,16 @@ type GetEnvironmentsOfWorkspaceApiResponse = {
13243
13367
  updatedAt?: string;
13244
13368
  /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
13245
13369
  deletedAt?: string | null;
13370
+ /** 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.
13371
+
13372
+ 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.
13373
+
13374
+ 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.
13375
+
13376
+ Server-owned and not client-settable. It is absent from `EnvironmentPayload`, which every environment POST and PUT requestBody references, and from the create-or-edit form, so the environment create and update endpoints have no field for it. That exclusion 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.
13377
+
13378
+ 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. */
13379
+ purpose?: "user" | "administrative";
13246
13380
  }[];
13247
13381
  };
13248
13382
  type GetEnvironmentsOfWorkspaceApiArg = {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@meshery/schemas",
3
- "version": "1.3.52",
3
+ "version": "1.3.54",
4
4
  "description": "<p style=\"text-align:center;\" align=\"center\"><a href=\"https://meshery.io\"><picture> <source media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/meshery/meshery/master/.github/assets/images/readme/meshery-logo-light-text-side.svg\"> <source media=\"(prefers-color-scheme: light)\" srcset=\"https://raw.githubusercontent.com/meshery/meshery/master/.github/assets/images/readme/meshery-logo-dark-text-side.svg\"> <img src=\"https://raw.githubusercontent.com/meshery/meshery/master/.github/assets/images/readme/meshery-logo-dark-text-side.svg\" alt=\"Meshery Logo\" width=\"70%\" /></picture></a><br /><br /></p> <p align=\"center\"> <a href=\"https://hub.docker.com/r/meshery/meshery\" alt=\"Docker pulls\"> <img src=\"https://img.shields.io/docker/pulls/meshery/meshery.svg\" /></a> <a href=\"https://github.com/issues?q=is%3Aopen+is%3Aissue+archived%3Afalse+org%meshery+org%3Ameshery+org%3Aservice-mesh-performance+org%3Aservice-mesh-patterns+org%3A+label%3A%22help+wanted%22+\" alt=\"GitHub issues by-label\"> <img src=\"https://img.shields.io/github/issues/meshery/meshery/help%20wanted.svg?color=informational\" /></a> <a href=\"https://github.com/meshery/meshery/blob/master/LICENSE\" alt=\"LICENSE\"> <img src=\"https://img.shields.io/github/license/meshery/meshery?color=brightgreen\" /></a> <a href=\"https://artifacthub.io/packages/helm/meshery/meshery\" alt=\"Artifact Hub Meshery\"> <img src=\"https://img.shields.io/endpoint?color=brightgreen&label=Helm%20Chart&style=plastic&url=https%3A%2F%2Fartifacthub.io%2Fbadge%2Frepository%2Fartifact-hub\" /></a> <a href=\"https://goreportcard.com/report/github.com/meshery/meshery\" alt=\"Go Report Card\"> <img src=\"https://goreportcard.com/badge/github.com/meshery/meshery\" /></a> <a href=\"https://github.com/meshery/meshery/actions\" alt=\"Build Status\"> <img src=\"https://img.shields.io/github/actions/workflow/status/meshery/meshery/release-drafter.yml\" /></a> <a href=\"https://bestpractices.coreinfrastructure.org/projects/3564\" alt=\"CLI Best Practices\"> <img src=\"https://bestpractices.coreinfrastructure.org/projects/3564/badge\" /></a> <a href=\"http://discuss.meshery.io\" alt=\"Discuss Users\"> <img src=\"https://img.shields.io/discourse/users?label=discuss&logo=discourse&server=https%3A%2F%2Fdiscuss.meshery.io\" /></a> <a href=\"https://slack.meshery.io\" alt=\"Join Slack\"> <img src=\"https://img.shields.io/badge/Slack-@meshery.svg?logo=slack\" /></a> <a href=\"https://twitter.com/intent/follow?screen_name=mesheryio\" alt=\"Twitter Follow\"> <img src=\"https://img.shields.io/twitter/follow/mesheryio.svg?label=Follow+Meshery&style=social\" /></a> <a href=\"https://github.com/meshery/meshery/releases\" alt=\"Meshery Downloads\"> <img src=\"https://img.shields.io/github/downloads/meshery/meshery/total\" /></a> <!-- <a href=\"https://app.fossa.com/projects/git%2Bgithub.com%2Fmeshery%2Fmeshery?ref=badge_shield\" alt=\"License Scan Report\"> <img src=\"https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmeshery%2Fmeshery.svg?type=shield\"/></a> --> </p>",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",