@meshery/schemas 1.3.77 → 1.3.78
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cloudApi.d.mts +241 -1357
- package/dist/cloudApi.d.ts +241 -1357
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta1/organization_smtp/OrganizationSmtp.d.ts +3 -3
- package/dist/constructs/v1beta1/organization_smtp/OrganizationSmtpSchema.js +1 -1
- package/dist/constructs/v1beta1/organization_smtp/OrganizationSmtpSchema.mjs +1 -1
- package/dist/constructs/v1beta1/registry/Registry.d.ts +9 -9
- package/dist/constructs/v1beta1/registry/RegistrySchema.js +3 -3
- package/dist/constructs/v1beta1/registry/RegistrySchema.mjs +3 -3
- package/dist/constructs/v1beta2/organization/Organization.d.ts +334 -2
- package/dist/constructs/v1beta2/organization/OrganizationSchema.js +1 -1
- package/dist/constructs/v1beta2/organization/OrganizationSchema.mjs +1 -1
- package/dist/constructs/v1beta3/connection/Connection.d.ts +21 -21
- package/dist/constructs/v1beta3/connection/ConnectionSchema.js +1 -1
- package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +1 -1
- package/dist/constructs/v1beta3/environment/Environment.d.ts +62 -19
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.js +1 -1
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.mjs +1 -1
- package/dist/constructs/v1beta3/schedule/Schedule.d.ts +334 -1038
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.js +12 -36
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.mjs +12 -36
- package/dist/constructs/v1beta3/workspace/Workspace.d.ts +3 -3
- package/dist/constructs/v1beta3/workspace/WorkspaceSchema.js +1 -1
- package/dist/constructs/v1beta3/workspace/WorkspaceSchema.mjs +1 -1
- package/dist/index.d.mts +224 -0
- package/dist/index.d.ts +224 -0
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/dist/mesheryApi.d.mts +137 -36
- package/dist/mesheryApi.d.ts +137 -36
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/package.json +1 -1
package/dist/mesheryApi.d.mts
CHANGED
|
@@ -6697,16 +6697,16 @@ type RegisterRegistryComponentApiArg = {
|
|
|
6697
6697
|
updatedAt?: string;
|
|
6698
6698
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
6699
6699
|
deletedAt?: string | null;
|
|
6700
|
-
/** 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. `
|
|
6700
|
+
/** 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.
|
|
6701
6701
|
|
|
6702
6702
|
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.
|
|
6703
6703
|
|
|
6704
6704
|
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.
|
|
6705
6705
|
|
|
6706
|
-
|
|
6706
|
+
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.
|
|
6707
6707
|
|
|
6708
6708
|
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. */
|
|
6709
|
-
purpose?: "user" | "administrative" | "
|
|
6709
|
+
purpose?: "user" | "administrative" | "profile";
|
|
6710
6710
|
}[];
|
|
6711
6711
|
/** Specifies the version of the schema used for the definition. */
|
|
6712
6712
|
schemaVersion: string;
|
|
@@ -7395,16 +7395,16 @@ type RegisterRegistryRelationshipApiArg = {
|
|
|
7395
7395
|
updatedAt?: string;
|
|
7396
7396
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
7397
7397
|
deletedAt?: string | null;
|
|
7398
|
-
/** 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. `
|
|
7398
|
+
/** 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.
|
|
7399
7399
|
|
|
7400
7400
|
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.
|
|
7401
7401
|
|
|
7402
7402
|
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.
|
|
7403
7403
|
|
|
7404
|
-
|
|
7404
|
+
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.
|
|
7405
7405
|
|
|
7406
7406
|
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. */
|
|
7407
|
-
purpose?: "user" | "administrative" | "
|
|
7407
|
+
purpose?: "user" | "administrative" | "profile";
|
|
7408
7408
|
}[];
|
|
7409
7409
|
/** Specifies the version of the schema used for the definition. */
|
|
7410
7410
|
schemaVersion: string;
|
|
@@ -8660,6 +8660,17 @@ type GetOrgsApiResponse = {
|
|
|
8660
8660
|
};
|
|
8661
8661
|
/** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
|
|
8662
8662
|
showAuthCarousel?: boolean;
|
|
8663
|
+
/** Organization-wide schedule pause. Only organization admins may set or lift it; a write from anyone else that changes it is refused with 403. Omitting schedulePause from a preferences write keeps the current pause unchanged; it does not lift the pause. */
|
|
8664
|
+
schedulePause?: {
|
|
8665
|
+
/** Whether every schedule in the organization is paused. */
|
|
8666
|
+
paused?: boolean;
|
|
8667
|
+
/** Reason given for the pause. Cleared when the pause is lifted. */
|
|
8668
|
+
reason?: string;
|
|
8669
|
+
/** Time the pause was set. Server-managed; recorded when `paused` turns true and cleared when it is lifted. */
|
|
8670
|
+
pausedAt?: string;
|
|
8671
|
+
/** Identity that set the pause. Server-managed; recorded when `paused` turns true and cleared when it is lifted. */
|
|
8672
|
+
pausedBy?: string;
|
|
8673
|
+
};
|
|
8663
8674
|
};
|
|
8664
8675
|
};
|
|
8665
8676
|
/** Timestamp when the organization was created. */
|
|
@@ -8794,6 +8805,17 @@ type CreateOrgApiResponse = {
|
|
|
8794
8805
|
};
|
|
8795
8806
|
/** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
|
|
8796
8807
|
showAuthCarousel?: boolean;
|
|
8808
|
+
/** Organization-wide schedule pause. Only organization admins may set or lift it; a write from anyone else that changes it is refused with 403. Omitting schedulePause from a preferences write keeps the current pause unchanged; it does not lift the pause. */
|
|
8809
|
+
schedulePause?: {
|
|
8810
|
+
/** Whether every schedule in the organization is paused. */
|
|
8811
|
+
paused?: boolean;
|
|
8812
|
+
/** Reason given for the pause. Cleared when the pause is lifted. */
|
|
8813
|
+
reason?: string;
|
|
8814
|
+
/** Time the pause was set. Server-managed; recorded when `paused` turns true and cleared when it is lifted. */
|
|
8815
|
+
pausedAt?: string;
|
|
8816
|
+
/** Identity that set the pause. Server-managed; recorded when `paused` turns true and cleared when it is lifted. */
|
|
8817
|
+
pausedBy?: string;
|
|
8818
|
+
};
|
|
8797
8819
|
};
|
|
8798
8820
|
};
|
|
8799
8821
|
/** Timestamp when the organization was created. */
|
|
@@ -8904,6 +8926,13 @@ type CreateOrgApiArg = {
|
|
|
8904
8926
|
};
|
|
8905
8927
|
/** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
|
|
8906
8928
|
showAuthCarousel?: boolean;
|
|
8929
|
+
/** Organization-wide schedule pause. Only organization admins may set or lift it; a write from anyone else that changes it is refused with 403. Omitting schedulePause from a preferences write keeps the current pause unchanged; it does not lift the pause. */
|
|
8930
|
+
schedulePause?: {
|
|
8931
|
+
/** Whether every schedule in the organization is paused. */
|
|
8932
|
+
paused: boolean;
|
|
8933
|
+
/** Reason given for the pause. Cleared when the pause is lifted. */
|
|
8934
|
+
reason?: string;
|
|
8935
|
+
};
|
|
8907
8936
|
};
|
|
8908
8937
|
};
|
|
8909
8938
|
};
|
|
@@ -9047,6 +9076,17 @@ type GetOrgApiResponse = {
|
|
|
9047
9076
|
};
|
|
9048
9077
|
/** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
|
|
9049
9078
|
showAuthCarousel?: boolean;
|
|
9079
|
+
/** Organization-wide schedule pause. Only organization admins may set or lift it; a write from anyone else that changes it is refused with 403. Omitting schedulePause from a preferences write keeps the current pause unchanged; it does not lift the pause. */
|
|
9080
|
+
schedulePause?: {
|
|
9081
|
+
/** Whether every schedule in the organization is paused. */
|
|
9082
|
+
paused?: boolean;
|
|
9083
|
+
/** Reason given for the pause. Cleared when the pause is lifted. */
|
|
9084
|
+
reason?: string;
|
|
9085
|
+
/** Time the pause was set. Server-managed; recorded when `paused` turns true and cleared when it is lifted. */
|
|
9086
|
+
pausedAt?: string;
|
|
9087
|
+
/** Identity that set the pause. Server-managed; recorded when `paused` turns true and cleared when it is lifted. */
|
|
9088
|
+
pausedBy?: string;
|
|
9089
|
+
};
|
|
9050
9090
|
};
|
|
9051
9091
|
};
|
|
9052
9092
|
/** Timestamp when the organization was created. */
|
|
@@ -9178,6 +9218,17 @@ type UpdateOrgApiResponse = {
|
|
|
9178
9218
|
};
|
|
9179
9219
|
/** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
|
|
9180
9220
|
showAuthCarousel?: boolean;
|
|
9221
|
+
/** Organization-wide schedule pause. Only organization admins may set or lift it; a write from anyone else that changes it is refused with 403. Omitting schedulePause from a preferences write keeps the current pause unchanged; it does not lift the pause. */
|
|
9222
|
+
schedulePause?: {
|
|
9223
|
+
/** Whether every schedule in the organization is paused. */
|
|
9224
|
+
paused?: boolean;
|
|
9225
|
+
/** Reason given for the pause. Cleared when the pause is lifted. */
|
|
9226
|
+
reason?: string;
|
|
9227
|
+
/** Time the pause was set. Server-managed; recorded when `paused` turns true and cleared when it is lifted. */
|
|
9228
|
+
pausedAt?: string;
|
|
9229
|
+
/** Identity that set the pause. Server-managed; recorded when `paused` turns true and cleared when it is lifted. */
|
|
9230
|
+
pausedBy?: string;
|
|
9231
|
+
};
|
|
9181
9232
|
};
|
|
9182
9233
|
};
|
|
9183
9234
|
/** Timestamp when the organization was created. */
|
|
@@ -9290,6 +9341,13 @@ type UpdateOrgApiArg = {
|
|
|
9290
9341
|
};
|
|
9291
9342
|
/** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
|
|
9292
9343
|
showAuthCarousel?: boolean;
|
|
9344
|
+
/** Organization-wide schedule pause. Only organization admins may set or lift it; a write from anyone else that changes it is refused with 403. Omitting schedulePause from a preferences write keeps the current pause unchanged; it does not lift the pause. */
|
|
9345
|
+
schedulePause?: {
|
|
9346
|
+
/** Whether every schedule in the organization is paused. */
|
|
9347
|
+
paused: boolean;
|
|
9348
|
+
/** Reason given for the pause. Cleared when the pause is lifted. */
|
|
9349
|
+
reason?: string;
|
|
9350
|
+
};
|
|
9293
9351
|
};
|
|
9294
9352
|
};
|
|
9295
9353
|
};
|
|
@@ -9439,6 +9497,17 @@ type CreateChildOrgApiResponse =
|
|
|
9439
9497
|
};
|
|
9440
9498
|
/** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
|
|
9441
9499
|
showAuthCarousel?: boolean;
|
|
9500
|
+
/** Organization-wide schedule pause. Only organization admins may set or lift it; a write from anyone else that changes it is refused with 403. Omitting schedulePause from a preferences write keeps the current pause unchanged; it does not lift the pause. */
|
|
9501
|
+
schedulePause?: {
|
|
9502
|
+
/** Whether every schedule in the organization is paused. */
|
|
9503
|
+
paused?: boolean;
|
|
9504
|
+
/** Reason given for the pause. Cleared when the pause is lifted. */
|
|
9505
|
+
reason?: string;
|
|
9506
|
+
/** Time the pause was set. Server-managed; recorded when `paused` turns true and cleared when it is lifted. */
|
|
9507
|
+
pausedAt?: string;
|
|
9508
|
+
/** Identity that set the pause. Server-managed; recorded when `paused` turns true and cleared when it is lifted. */
|
|
9509
|
+
pausedBy?: string;
|
|
9510
|
+
};
|
|
9442
9511
|
};
|
|
9443
9512
|
};
|
|
9444
9513
|
/** Timestamp when the organization was created. */
|
|
@@ -9551,6 +9620,13 @@ type CreateChildOrgApiArg = {
|
|
|
9551
9620
|
};
|
|
9552
9621
|
/** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
|
|
9553
9622
|
showAuthCarousel?: boolean;
|
|
9623
|
+
/** Organization-wide schedule pause. Only organization admins may set or lift it; a write from anyone else that changes it is refused with 403. Omitting schedulePause from a preferences write keeps the current pause unchanged; it does not lift the pause. */
|
|
9624
|
+
schedulePause?: {
|
|
9625
|
+
/** Whether every schedule in the organization is paused. */
|
|
9626
|
+
paused: boolean;
|
|
9627
|
+
/** Reason given for the pause. Cleared when the pause is lifted. */
|
|
9628
|
+
reason?: string;
|
|
9629
|
+
};
|
|
9554
9630
|
};
|
|
9555
9631
|
};
|
|
9556
9632
|
};
|
|
@@ -9642,6 +9718,17 @@ type GetOrgPreferencesApiResponse = {
|
|
|
9642
9718
|
};
|
|
9643
9719
|
/** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
|
|
9644
9720
|
showAuthCarousel?: boolean;
|
|
9721
|
+
/** Organization-wide schedule pause. Only organization admins may set or lift it; a write from anyone else that changes it is refused with 403. Omitting schedulePause from a preferences write keeps the current pause unchanged; it does not lift the pause. */
|
|
9722
|
+
schedulePause?: {
|
|
9723
|
+
/** Whether every schedule in the organization is paused. */
|
|
9724
|
+
paused?: boolean;
|
|
9725
|
+
/** Reason given for the pause. Cleared when the pause is lifted. */
|
|
9726
|
+
reason?: string;
|
|
9727
|
+
/** Time the pause was set. Server-managed; recorded when `paused` turns true and cleared when it is lifted. */
|
|
9728
|
+
pausedAt?: string;
|
|
9729
|
+
/** Identity that set the pause. Server-managed; recorded when `paused` turns true and cleared when it is lifted. */
|
|
9730
|
+
pausedBy?: string;
|
|
9731
|
+
};
|
|
9645
9732
|
};
|
|
9646
9733
|
};
|
|
9647
9734
|
type GetOrgPreferencesApiArg = {
|
|
@@ -10544,16 +10631,16 @@ type GetConnectionsApiResponse = {
|
|
|
10544
10631
|
updatedAt?: string;
|
|
10545
10632
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
10546
10633
|
deletedAt?: string | null;
|
|
10547
|
-
/** 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. `
|
|
10634
|
+
/** 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.
|
|
10548
10635
|
|
|
10549
10636
|
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.
|
|
10550
10637
|
|
|
10551
10638
|
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.
|
|
10552
10639
|
|
|
10553
|
-
|
|
10640
|
+
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.
|
|
10554
10641
|
|
|
10555
10642
|
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. */
|
|
10556
|
-
purpose?: "user" | "administrative" | "
|
|
10643
|
+
purpose?: "user" | "administrative" | "profile";
|
|
10557
10644
|
}[];
|
|
10558
10645
|
/** Specifies the version of the schema used for the definition. */
|
|
10559
10646
|
schemaVersion: string;
|
|
@@ -10811,16 +10898,16 @@ type RegisterConnectionApiResponse = {
|
|
|
10811
10898
|
updatedAt?: string;
|
|
10812
10899
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
10813
10900
|
deletedAt?: string | null;
|
|
10814
|
-
/** 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. `
|
|
10901
|
+
/** 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.
|
|
10815
10902
|
|
|
10816
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.
|
|
10817
10904
|
|
|
10818
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.
|
|
10819
10906
|
|
|
10820
|
-
|
|
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.
|
|
10821
10908
|
|
|
10822
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. */
|
|
10823
|
-
purpose?: "user" | "administrative" | "
|
|
10910
|
+
purpose?: "user" | "administrative" | "profile";
|
|
10824
10911
|
}[];
|
|
10825
10912
|
/** Specifies the version of the schema used for the definition. */
|
|
10826
10913
|
schemaVersion: string;
|
|
@@ -11243,16 +11330,16 @@ type GetConnectionByIdApiResponse = {
|
|
|
11243
11330
|
updatedAt?: string;
|
|
11244
11331
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
11245
11332
|
deletedAt?: string | null;
|
|
11246
|
-
/** 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. `
|
|
11333
|
+
/** 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.
|
|
11247
11334
|
|
|
11248
11335
|
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.
|
|
11249
11336
|
|
|
11250
11337
|
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.
|
|
11251
11338
|
|
|
11252
|
-
|
|
11339
|
+
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.
|
|
11253
11340
|
|
|
11254
11341
|
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. */
|
|
11255
|
-
purpose?: "user" | "administrative" | "
|
|
11342
|
+
purpose?: "user" | "administrative" | "profile";
|
|
11256
11343
|
}[];
|
|
11257
11344
|
/** Specifies the version of the schema used for the definition. */
|
|
11258
11345
|
schemaVersion: string;
|
|
@@ -11481,16 +11568,16 @@ type UpdateConnectionApiResponse = {
|
|
|
11481
11568
|
updatedAt?: string;
|
|
11482
11569
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
11483
11570
|
deletedAt?: string | null;
|
|
11484
|
-
/** 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. `
|
|
11571
|
+
/** 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.
|
|
11485
11572
|
|
|
11486
11573
|
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.
|
|
11487
11574
|
|
|
11488
11575
|
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.
|
|
11489
11576
|
|
|
11490
|
-
|
|
11577
|
+
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.
|
|
11491
11578
|
|
|
11492
11579
|
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. */
|
|
11493
|
-
purpose?: "user" | "administrative" | "
|
|
11580
|
+
purpose?: "user" | "administrative" | "profile";
|
|
11494
11581
|
}[];
|
|
11495
11582
|
/** Specifies the version of the schema used for the definition. */
|
|
11496
11583
|
schemaVersion: string;
|
|
@@ -11881,16 +11968,16 @@ type PerformConnectionActionApiResponse =
|
|
|
11881
11968
|
updatedAt?: string;
|
|
11882
11969
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
11883
11970
|
deletedAt?: string | null;
|
|
11884
|
-
/** 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. `
|
|
11971
|
+
/** 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.
|
|
11885
11972
|
|
|
11886
11973
|
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.
|
|
11887
11974
|
|
|
11888
11975
|
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.
|
|
11889
11976
|
|
|
11890
|
-
|
|
11977
|
+
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.
|
|
11891
11978
|
|
|
11892
11979
|
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. */
|
|
11893
|
-
purpose?: "user" | "administrative" | "
|
|
11980
|
+
purpose?: "user" | "administrative" | "profile";
|
|
11894
11981
|
}[];
|
|
11895
11982
|
/** Specifies the version of the schema used for the definition. */
|
|
11896
11983
|
schemaVersion: string;
|
|
@@ -12665,16 +12752,16 @@ type CreateEnvironmentApiResponse = {
|
|
|
12665
12752
|
updatedAt?: string;
|
|
12666
12753
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
12667
12754
|
deletedAt?: string | null;
|
|
12668
|
-
/** 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. `
|
|
12755
|
+
/** 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.
|
|
12669
12756
|
|
|
12670
12757
|
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.
|
|
12671
12758
|
|
|
12672
12759
|
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.
|
|
12673
12760
|
|
|
12674
|
-
|
|
12761
|
+
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.
|
|
12675
12762
|
|
|
12676
12763
|
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. */
|
|
12677
|
-
purpose?: "user" | "administrative" | "
|
|
12764
|
+
purpose?: "user" | "administrative" | "profile";
|
|
12678
12765
|
};
|
|
12679
12766
|
type CreateEnvironmentApiArg = {
|
|
12680
12767
|
/** Body for creating environment */
|
|
@@ -12685,6 +12772,12 @@ type CreateEnvironmentApiArg = {
|
|
|
12685
12772
|
description?: string;
|
|
12686
12773
|
/** Select an organization in which you want to create this new environment. Keep in mind that the organization cannot be changed after creation. */
|
|
12687
12774
|
organizationId: string;
|
|
12775
|
+
/** Free-form settings stored with the environment, for example a profile's settings. */
|
|
12776
|
+
metadata?: {
|
|
12777
|
+
[key: string]: any;
|
|
12778
|
+
};
|
|
12779
|
+
/** The purposes a client may give an environment on create or update: `user` (an ordinary environment) or `profile` (an ordinary environment holding one profile's settings and accounts). Omitted means `user` on create and unchanged on update. A server refuses any other value with 400, and never lets this field change an environment that already carries a privileged purpose. */
|
|
12780
|
+
purpose?: "user" | "profile";
|
|
12688
12781
|
};
|
|
12689
12782
|
};
|
|
12690
12783
|
type GetEnvironmentsApiResponse = {
|
|
@@ -12716,16 +12809,16 @@ type GetEnvironmentsApiResponse = {
|
|
|
12716
12809
|
updatedAt?: string;
|
|
12717
12810
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
12718
12811
|
deletedAt?: string | null;
|
|
12719
|
-
/** 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. `
|
|
12812
|
+
/** 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.
|
|
12720
12813
|
|
|
12721
12814
|
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.
|
|
12722
12815
|
|
|
12723
12816
|
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.
|
|
12724
12817
|
|
|
12725
|
-
|
|
12818
|
+
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.
|
|
12726
12819
|
|
|
12727
12820
|
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. */
|
|
12728
|
-
purpose?: "user" | "administrative" | "
|
|
12821
|
+
purpose?: "user" | "administrative" | "profile";
|
|
12729
12822
|
}[];
|
|
12730
12823
|
};
|
|
12731
12824
|
type GetEnvironmentsApiArg = {
|
|
@@ -12741,6 +12834,8 @@ type GetEnvironmentsApiArg = {
|
|
|
12741
12834
|
pagesize?: number;
|
|
12742
12835
|
/** User's organization ID */
|
|
12743
12836
|
orgId: string;
|
|
12837
|
+
/** Return only environments with this purpose; absent returns every purpose the caller may see. The filter only narrows the environments the caller can already list and grants no visibility - a caller who cannot see administrative environments receives an empty page for purpose=administrative. */
|
|
12838
|
+
purpose?: "user" | "administrative" | "profile";
|
|
12744
12839
|
};
|
|
12745
12840
|
type GetEnvironmentByIdApiResponse = {
|
|
12746
12841
|
/** Zero-based page index returned in this response. */
|
|
@@ -12771,16 +12866,16 @@ type GetEnvironmentByIdApiResponse = {
|
|
|
12771
12866
|
updatedAt?: string;
|
|
12772
12867
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
12773
12868
|
deletedAt?: string | null;
|
|
12774
|
-
/** 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. `
|
|
12869
|
+
/** 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.
|
|
12775
12870
|
|
|
12776
12871
|
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.
|
|
12777
12872
|
|
|
12778
12873
|
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.
|
|
12779
12874
|
|
|
12780
|
-
|
|
12875
|
+
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.
|
|
12781
12876
|
|
|
12782
12877
|
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. */
|
|
12783
|
-
purpose?: "user" | "administrative" | "
|
|
12878
|
+
purpose?: "user" | "administrative" | "profile";
|
|
12784
12879
|
}[];
|
|
12785
12880
|
};
|
|
12786
12881
|
type GetEnvironmentByIdApiArg = {
|
|
@@ -12818,16 +12913,16 @@ type UpdateEnvironmentApiResponse = {
|
|
|
12818
12913
|
updatedAt?: string;
|
|
12819
12914
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
12820
12915
|
deletedAt?: string | null;
|
|
12821
|
-
/** 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. `
|
|
12916
|
+
/** 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.
|
|
12822
12917
|
|
|
12823
12918
|
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.
|
|
12824
12919
|
|
|
12825
12920
|
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.
|
|
12826
12921
|
|
|
12827
|
-
|
|
12922
|
+
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.
|
|
12828
12923
|
|
|
12829
12924
|
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. */
|
|
12830
|
-
purpose?: "user" | "administrative" | "
|
|
12925
|
+
purpose?: "user" | "administrative" | "profile";
|
|
12831
12926
|
}[];
|
|
12832
12927
|
};
|
|
12833
12928
|
type UpdateEnvironmentApiArg = {
|
|
@@ -12841,6 +12936,12 @@ type UpdateEnvironmentApiArg = {
|
|
|
12841
12936
|
description?: string;
|
|
12842
12937
|
/** Select an organization in which you want to create this new environment. Keep in mind that the organization cannot be changed after creation. */
|
|
12843
12938
|
organizationId: string;
|
|
12939
|
+
/** Free-form settings stored with the environment, for example a profile's settings. */
|
|
12940
|
+
metadata?: {
|
|
12941
|
+
[key: string]: any;
|
|
12942
|
+
};
|
|
12943
|
+
/** The purposes a client may give an environment on create or update: `user` (an ordinary environment) or `profile` (an ordinary environment holding one profile's settings and accounts). Omitted means `user` on create and unchanged on update. A server refuses any other value with 400, and never lets this field change an environment that already carries a privileged purpose. */
|
|
12944
|
+
purpose?: "user" | "profile";
|
|
12844
12945
|
};
|
|
12845
12946
|
};
|
|
12846
12947
|
type DeleteEnvironmentApiResponse = unknown;
|
|
@@ -13636,16 +13737,16 @@ type GetEnvironmentsOfWorkspaceApiResponse = {
|
|
|
13636
13737
|
updatedAt?: string;
|
|
13637
13738
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
13638
13739
|
deletedAt?: string | null;
|
|
13639
|
-
/** 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. `
|
|
13740
|
+
/** 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.
|
|
13640
13741
|
|
|
13641
13742
|
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.
|
|
13642
13743
|
|
|
13643
13744
|
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.
|
|
13644
13745
|
|
|
13645
|
-
|
|
13746
|
+
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.
|
|
13646
13747
|
|
|
13647
13748
|
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. */
|
|
13648
|
-
purpose?: "user" | "administrative" | "
|
|
13749
|
+
purpose?: "user" | "administrative" | "profile";
|
|
13649
13750
|
}[];
|
|
13650
13751
|
};
|
|
13651
13752
|
type GetEnvironmentsOfWorkspaceApiArg = {
|