@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.
- package/dist/cloudApi.d.mts +114 -0
- package/dist/cloudApi.d.ts +114 -0
- package/dist/constructs/v1beta1/organization_smtp/OrganizationSmtp.d.ts +13 -0
- 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 +39 -0
- 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 +80 -0
- 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 +91 -0
- 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 +80 -1
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.js +1 -1
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.mjs +1 -1
- package/dist/constructs/v1beta3/workspace/Workspace.d.ts +13 -0
- package/dist/constructs/v1beta3/workspace/WorkspaceSchema.js +1 -1
- package/dist/constructs/v1beta3/workspace/WorkspaceSchema.mjs +1 -1
- package/dist/index.d.mts +45 -0
- package/dist/index.d.ts +45 -0
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/dist/mesheryApi.d.mts +134 -0
- package/dist/mesheryApi.d.ts +134 -0
- package/package.json +1 -1
package/dist/cloudApi.d.mts
CHANGED
|
@@ -322,6 +322,16 @@ type GetOrganizationSmtpEnvironmentApiResponse =
|
|
|
322
322
|
updatedAt?: string;
|
|
323
323
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
324
324
|
deletedAt?: string | null;
|
|
325
|
+
/** 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.
|
|
326
|
+
|
|
327
|
+
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.
|
|
328
|
+
|
|
329
|
+
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.
|
|
330
|
+
|
|
331
|
+
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.
|
|
332
|
+
|
|
333
|
+
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. */
|
|
334
|
+
purpose?: "user" | "administrative";
|
|
325
335
|
};
|
|
326
336
|
type GetOrganizationSmtpEnvironmentApiArg = {
|
|
327
337
|
/** Organization ID */
|
|
@@ -1603,6 +1613,8 @@ type GetOrgsApiResponse = {
|
|
|
1603
1613
|
linkedin?: string;
|
|
1604
1614
|
/** URL of the organization's X (formerly Twitter) profile. */
|
|
1605
1615
|
x?: string;
|
|
1616
|
+
/** URL of the organization's YouTube channel. */
|
|
1617
|
+
youtube?: string;
|
|
1606
1618
|
};
|
|
1607
1619
|
};
|
|
1608
1620
|
/** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
|
|
@@ -1735,6 +1747,8 @@ type CreateOrgApiResponse = {
|
|
|
1735
1747
|
linkedin?: string;
|
|
1736
1748
|
/** URL of the organization's X (formerly Twitter) profile. */
|
|
1737
1749
|
x?: string;
|
|
1750
|
+
/** URL of the organization's YouTube channel. */
|
|
1751
|
+
youtube?: string;
|
|
1738
1752
|
};
|
|
1739
1753
|
};
|
|
1740
1754
|
/** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
|
|
@@ -1843,6 +1857,8 @@ type CreateOrgApiArg = {
|
|
|
1843
1857
|
linkedin?: string;
|
|
1844
1858
|
/** URL of the organization's X (formerly Twitter) profile. */
|
|
1845
1859
|
x?: string;
|
|
1860
|
+
/** URL of the organization's YouTube channel. */
|
|
1861
|
+
youtube?: string;
|
|
1846
1862
|
};
|
|
1847
1863
|
};
|
|
1848
1864
|
/** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
|
|
@@ -1984,6 +2000,8 @@ type GetOrgApiResponse = {
|
|
|
1984
2000
|
linkedin?: string;
|
|
1985
2001
|
/** URL of the organization's X (formerly Twitter) profile. */
|
|
1986
2002
|
x?: string;
|
|
2003
|
+
/** URL of the organization's YouTube channel. */
|
|
2004
|
+
youtube?: string;
|
|
1987
2005
|
};
|
|
1988
2006
|
};
|
|
1989
2007
|
/** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
|
|
@@ -2113,6 +2131,8 @@ type UpdateOrgApiResponse = {
|
|
|
2113
2131
|
linkedin?: string;
|
|
2114
2132
|
/** URL of the organization's X (formerly Twitter) profile. */
|
|
2115
2133
|
x?: string;
|
|
2134
|
+
/** URL of the organization's YouTube channel. */
|
|
2135
|
+
youtube?: string;
|
|
2116
2136
|
};
|
|
2117
2137
|
};
|
|
2118
2138
|
/** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
|
|
@@ -2223,6 +2243,8 @@ type UpdateOrgApiArg = {
|
|
|
2223
2243
|
linkedin?: string;
|
|
2224
2244
|
/** URL of the organization's X (formerly Twitter) profile. */
|
|
2225
2245
|
x?: string;
|
|
2246
|
+
/** URL of the organization's YouTube channel. */
|
|
2247
|
+
youtube?: string;
|
|
2226
2248
|
};
|
|
2227
2249
|
};
|
|
2228
2250
|
/** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
|
|
@@ -2312,6 +2334,8 @@ type GetOrgPreferencesApiResponse = {
|
|
|
2312
2334
|
linkedin?: string;
|
|
2313
2335
|
/** URL of the organization's X (formerly Twitter) profile. */
|
|
2314
2336
|
x?: string;
|
|
2337
|
+
/** URL of the organization's YouTube channel. */
|
|
2338
|
+
youtube?: string;
|
|
2315
2339
|
};
|
|
2316
2340
|
};
|
|
2317
2341
|
/** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
|
|
@@ -6174,6 +6198,16 @@ type GetConnectionsApiResponse = {
|
|
|
6174
6198
|
updatedAt?: string;
|
|
6175
6199
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
6176
6200
|
deletedAt?: string | null;
|
|
6201
|
+
/** 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.
|
|
6202
|
+
|
|
6203
|
+
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.
|
|
6204
|
+
|
|
6205
|
+
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.
|
|
6206
|
+
|
|
6207
|
+
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.
|
|
6208
|
+
|
|
6209
|
+
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. */
|
|
6210
|
+
purpose?: "user" | "administrative";
|
|
6177
6211
|
}[];
|
|
6178
6212
|
/** Specifies the version of the schema used for the definition. */
|
|
6179
6213
|
schemaVersion: string;
|
|
@@ -6431,6 +6465,16 @@ type RegisterConnectionApiResponse = {
|
|
|
6431
6465
|
updatedAt?: string;
|
|
6432
6466
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
6433
6467
|
deletedAt?: string | null;
|
|
6468
|
+
/** 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.
|
|
6469
|
+
|
|
6470
|
+
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.
|
|
6471
|
+
|
|
6472
|
+
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.
|
|
6473
|
+
|
|
6474
|
+
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.
|
|
6475
|
+
|
|
6476
|
+
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. */
|
|
6477
|
+
purpose?: "user" | "administrative";
|
|
6434
6478
|
}[];
|
|
6435
6479
|
/** Specifies the version of the schema used for the definition. */
|
|
6436
6480
|
schemaVersion: string;
|
|
@@ -6813,6 +6857,16 @@ type GetConnectionByIdApiResponse = {
|
|
|
6813
6857
|
updatedAt?: string;
|
|
6814
6858
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
6815
6859
|
deletedAt?: string | null;
|
|
6860
|
+
/** 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.
|
|
6861
|
+
|
|
6862
|
+
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.
|
|
6863
|
+
|
|
6864
|
+
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.
|
|
6865
|
+
|
|
6866
|
+
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.
|
|
6867
|
+
|
|
6868
|
+
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. */
|
|
6869
|
+
purpose?: "user" | "administrative";
|
|
6816
6870
|
}[];
|
|
6817
6871
|
/** Specifies the version of the schema used for the definition. */
|
|
6818
6872
|
schemaVersion: string;
|
|
@@ -7041,6 +7095,16 @@ type UpdateConnectionApiResponse = {
|
|
|
7041
7095
|
updatedAt?: string;
|
|
7042
7096
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
7043
7097
|
deletedAt?: string | null;
|
|
7098
|
+
/** 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.
|
|
7099
|
+
|
|
7100
|
+
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.
|
|
7101
|
+
|
|
7102
|
+
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.
|
|
7103
|
+
|
|
7104
|
+
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.
|
|
7105
|
+
|
|
7106
|
+
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. */
|
|
7107
|
+
purpose?: "user" | "administrative";
|
|
7044
7108
|
}[];
|
|
7045
7109
|
/** Specifies the version of the schema used for the definition. */
|
|
7046
7110
|
schemaVersion: string;
|
|
@@ -10048,6 +10112,16 @@ type CreateEnvironmentApiResponse = {
|
|
|
10048
10112
|
updatedAt?: string;
|
|
10049
10113
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
10050
10114
|
deletedAt?: string | null;
|
|
10115
|
+
/** 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.
|
|
10116
|
+
|
|
10117
|
+
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.
|
|
10118
|
+
|
|
10119
|
+
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.
|
|
10120
|
+
|
|
10121
|
+
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.
|
|
10122
|
+
|
|
10123
|
+
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. */
|
|
10124
|
+
purpose?: "user" | "administrative";
|
|
10051
10125
|
};
|
|
10052
10126
|
type CreateEnvironmentApiArg = {
|
|
10053
10127
|
/** Body for creating environment */
|
|
@@ -10089,6 +10163,16 @@ type GetEnvironmentsApiResponse = {
|
|
|
10089
10163
|
updatedAt?: string;
|
|
10090
10164
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
10091
10165
|
deletedAt?: string | null;
|
|
10166
|
+
/** 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.
|
|
10167
|
+
|
|
10168
|
+
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.
|
|
10169
|
+
|
|
10170
|
+
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.
|
|
10171
|
+
|
|
10172
|
+
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.
|
|
10173
|
+
|
|
10174
|
+
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. */
|
|
10175
|
+
purpose?: "user" | "administrative";
|
|
10092
10176
|
}[];
|
|
10093
10177
|
};
|
|
10094
10178
|
type GetEnvironmentsApiArg = {
|
|
@@ -10134,6 +10218,16 @@ type GetEnvironmentByIdApiResponse = {
|
|
|
10134
10218
|
updatedAt?: string;
|
|
10135
10219
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
10136
10220
|
deletedAt?: string | null;
|
|
10221
|
+
/** 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.
|
|
10222
|
+
|
|
10223
|
+
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.
|
|
10224
|
+
|
|
10225
|
+
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.
|
|
10226
|
+
|
|
10227
|
+
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.
|
|
10228
|
+
|
|
10229
|
+
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. */
|
|
10230
|
+
purpose?: "user" | "administrative";
|
|
10137
10231
|
}[];
|
|
10138
10232
|
};
|
|
10139
10233
|
type GetEnvironmentByIdApiArg = {
|
|
@@ -10171,6 +10265,16 @@ type UpdateEnvironmentApiResponse = {
|
|
|
10171
10265
|
updatedAt?: string;
|
|
10172
10266
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
10173
10267
|
deletedAt?: string | null;
|
|
10268
|
+
/** 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.
|
|
10269
|
+
|
|
10270
|
+
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.
|
|
10271
|
+
|
|
10272
|
+
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.
|
|
10273
|
+
|
|
10274
|
+
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.
|
|
10275
|
+
|
|
10276
|
+
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. */
|
|
10277
|
+
purpose?: "user" | "administrative";
|
|
10174
10278
|
}[];
|
|
10175
10279
|
};
|
|
10176
10280
|
type UpdateEnvironmentApiArg = {
|
|
@@ -12686,6 +12790,16 @@ type GetEnvironmentsOfWorkspaceApiResponse = {
|
|
|
12686
12790
|
updatedAt?: string;
|
|
12687
12791
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
12688
12792
|
deletedAt?: string | null;
|
|
12793
|
+
/** 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.
|
|
12794
|
+
|
|
12795
|
+
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.
|
|
12796
|
+
|
|
12797
|
+
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.
|
|
12798
|
+
|
|
12799
|
+
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.
|
|
12800
|
+
|
|
12801
|
+
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. */
|
|
12802
|
+
purpose?: "user" | "administrative";
|
|
12689
12803
|
}[];
|
|
12690
12804
|
};
|
|
12691
12805
|
type GetEnvironmentsOfWorkspaceApiArg = {
|
package/dist/cloudApi.d.ts
CHANGED
|
@@ -322,6 +322,16 @@ type GetOrganizationSmtpEnvironmentApiResponse =
|
|
|
322
322
|
updatedAt?: string;
|
|
323
323
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
324
324
|
deletedAt?: string | null;
|
|
325
|
+
/** 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.
|
|
326
|
+
|
|
327
|
+
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.
|
|
328
|
+
|
|
329
|
+
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.
|
|
330
|
+
|
|
331
|
+
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.
|
|
332
|
+
|
|
333
|
+
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. */
|
|
334
|
+
purpose?: "user" | "administrative";
|
|
325
335
|
};
|
|
326
336
|
type GetOrganizationSmtpEnvironmentApiArg = {
|
|
327
337
|
/** Organization ID */
|
|
@@ -1603,6 +1613,8 @@ type GetOrgsApiResponse = {
|
|
|
1603
1613
|
linkedin?: string;
|
|
1604
1614
|
/** URL of the organization's X (formerly Twitter) profile. */
|
|
1605
1615
|
x?: string;
|
|
1616
|
+
/** URL of the organization's YouTube channel. */
|
|
1617
|
+
youtube?: string;
|
|
1606
1618
|
};
|
|
1607
1619
|
};
|
|
1608
1620
|
/** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
|
|
@@ -1735,6 +1747,8 @@ type CreateOrgApiResponse = {
|
|
|
1735
1747
|
linkedin?: string;
|
|
1736
1748
|
/** URL of the organization's X (formerly Twitter) profile. */
|
|
1737
1749
|
x?: string;
|
|
1750
|
+
/** URL of the organization's YouTube channel. */
|
|
1751
|
+
youtube?: string;
|
|
1738
1752
|
};
|
|
1739
1753
|
};
|
|
1740
1754
|
/** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
|
|
@@ -1843,6 +1857,8 @@ type CreateOrgApiArg = {
|
|
|
1843
1857
|
linkedin?: string;
|
|
1844
1858
|
/** URL of the organization's X (formerly Twitter) profile. */
|
|
1845
1859
|
x?: string;
|
|
1860
|
+
/** URL of the organization's YouTube channel. */
|
|
1861
|
+
youtube?: string;
|
|
1846
1862
|
};
|
|
1847
1863
|
};
|
|
1848
1864
|
/** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
|
|
@@ -1984,6 +2000,8 @@ type GetOrgApiResponse = {
|
|
|
1984
2000
|
linkedin?: string;
|
|
1985
2001
|
/** URL of the organization's X (formerly Twitter) profile. */
|
|
1986
2002
|
x?: string;
|
|
2003
|
+
/** URL of the organization's YouTube channel. */
|
|
2004
|
+
youtube?: string;
|
|
1987
2005
|
};
|
|
1988
2006
|
};
|
|
1989
2007
|
/** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
|
|
@@ -2113,6 +2131,8 @@ type UpdateOrgApiResponse = {
|
|
|
2113
2131
|
linkedin?: string;
|
|
2114
2132
|
/** URL of the organization's X (formerly Twitter) profile. */
|
|
2115
2133
|
x?: string;
|
|
2134
|
+
/** URL of the organization's YouTube channel. */
|
|
2135
|
+
youtube?: string;
|
|
2116
2136
|
};
|
|
2117
2137
|
};
|
|
2118
2138
|
/** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
|
|
@@ -2223,6 +2243,8 @@ type UpdateOrgApiArg = {
|
|
|
2223
2243
|
linkedin?: string;
|
|
2224
2244
|
/** URL of the organization's X (formerly Twitter) profile. */
|
|
2225
2245
|
x?: string;
|
|
2246
|
+
/** URL of the organization's YouTube channel. */
|
|
2247
|
+
youtube?: string;
|
|
2226
2248
|
};
|
|
2227
2249
|
};
|
|
2228
2250
|
/** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
|
|
@@ -2312,6 +2334,8 @@ type GetOrgPreferencesApiResponse = {
|
|
|
2312
2334
|
linkedin?: string;
|
|
2313
2335
|
/** URL of the organization's X (formerly Twitter) profile. */
|
|
2314
2336
|
x?: string;
|
|
2337
|
+
/** URL of the organization's YouTube channel. */
|
|
2338
|
+
youtube?: string;
|
|
2315
2339
|
};
|
|
2316
2340
|
};
|
|
2317
2341
|
/** Whether the feature carousel renders on the organization's auth pages. Unset is treated as true (shown); set false to hide it. */
|
|
@@ -6174,6 +6198,16 @@ type GetConnectionsApiResponse = {
|
|
|
6174
6198
|
updatedAt?: string;
|
|
6175
6199
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
6176
6200
|
deletedAt?: string | null;
|
|
6201
|
+
/** 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.
|
|
6202
|
+
|
|
6203
|
+
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.
|
|
6204
|
+
|
|
6205
|
+
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.
|
|
6206
|
+
|
|
6207
|
+
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.
|
|
6208
|
+
|
|
6209
|
+
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. */
|
|
6210
|
+
purpose?: "user" | "administrative";
|
|
6177
6211
|
}[];
|
|
6178
6212
|
/** Specifies the version of the schema used for the definition. */
|
|
6179
6213
|
schemaVersion: string;
|
|
@@ -6431,6 +6465,16 @@ type RegisterConnectionApiResponse = {
|
|
|
6431
6465
|
updatedAt?: string;
|
|
6432
6466
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
6433
6467
|
deletedAt?: string | null;
|
|
6468
|
+
/** 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.
|
|
6469
|
+
|
|
6470
|
+
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.
|
|
6471
|
+
|
|
6472
|
+
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.
|
|
6473
|
+
|
|
6474
|
+
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.
|
|
6475
|
+
|
|
6476
|
+
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. */
|
|
6477
|
+
purpose?: "user" | "administrative";
|
|
6434
6478
|
}[];
|
|
6435
6479
|
/** Specifies the version of the schema used for the definition. */
|
|
6436
6480
|
schemaVersion: string;
|
|
@@ -6813,6 +6857,16 @@ type GetConnectionByIdApiResponse = {
|
|
|
6813
6857
|
updatedAt?: string;
|
|
6814
6858
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
6815
6859
|
deletedAt?: string | null;
|
|
6860
|
+
/** 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.
|
|
6861
|
+
|
|
6862
|
+
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.
|
|
6863
|
+
|
|
6864
|
+
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.
|
|
6865
|
+
|
|
6866
|
+
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.
|
|
6867
|
+
|
|
6868
|
+
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. */
|
|
6869
|
+
purpose?: "user" | "administrative";
|
|
6816
6870
|
}[];
|
|
6817
6871
|
/** Specifies the version of the schema used for the definition. */
|
|
6818
6872
|
schemaVersion: string;
|
|
@@ -7041,6 +7095,16 @@ type UpdateConnectionApiResponse = {
|
|
|
7041
7095
|
updatedAt?: string;
|
|
7042
7096
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
7043
7097
|
deletedAt?: string | null;
|
|
7098
|
+
/** 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.
|
|
7099
|
+
|
|
7100
|
+
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.
|
|
7101
|
+
|
|
7102
|
+
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.
|
|
7103
|
+
|
|
7104
|
+
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.
|
|
7105
|
+
|
|
7106
|
+
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. */
|
|
7107
|
+
purpose?: "user" | "administrative";
|
|
7044
7108
|
}[];
|
|
7045
7109
|
/** Specifies the version of the schema used for the definition. */
|
|
7046
7110
|
schemaVersion: string;
|
|
@@ -10048,6 +10112,16 @@ type CreateEnvironmentApiResponse = {
|
|
|
10048
10112
|
updatedAt?: string;
|
|
10049
10113
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
10050
10114
|
deletedAt?: string | null;
|
|
10115
|
+
/** 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.
|
|
10116
|
+
|
|
10117
|
+
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.
|
|
10118
|
+
|
|
10119
|
+
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.
|
|
10120
|
+
|
|
10121
|
+
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.
|
|
10122
|
+
|
|
10123
|
+
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. */
|
|
10124
|
+
purpose?: "user" | "administrative";
|
|
10051
10125
|
};
|
|
10052
10126
|
type CreateEnvironmentApiArg = {
|
|
10053
10127
|
/** Body for creating environment */
|
|
@@ -10089,6 +10163,16 @@ type GetEnvironmentsApiResponse = {
|
|
|
10089
10163
|
updatedAt?: string;
|
|
10090
10164
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
10091
10165
|
deletedAt?: string | null;
|
|
10166
|
+
/** 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.
|
|
10167
|
+
|
|
10168
|
+
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.
|
|
10169
|
+
|
|
10170
|
+
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.
|
|
10171
|
+
|
|
10172
|
+
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.
|
|
10173
|
+
|
|
10174
|
+
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. */
|
|
10175
|
+
purpose?: "user" | "administrative";
|
|
10092
10176
|
}[];
|
|
10093
10177
|
};
|
|
10094
10178
|
type GetEnvironmentsApiArg = {
|
|
@@ -10134,6 +10218,16 @@ type GetEnvironmentByIdApiResponse = {
|
|
|
10134
10218
|
updatedAt?: string;
|
|
10135
10219
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
10136
10220
|
deletedAt?: string | null;
|
|
10221
|
+
/** 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.
|
|
10222
|
+
|
|
10223
|
+
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.
|
|
10224
|
+
|
|
10225
|
+
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.
|
|
10226
|
+
|
|
10227
|
+
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.
|
|
10228
|
+
|
|
10229
|
+
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. */
|
|
10230
|
+
purpose?: "user" | "administrative";
|
|
10137
10231
|
}[];
|
|
10138
10232
|
};
|
|
10139
10233
|
type GetEnvironmentByIdApiArg = {
|
|
@@ -10171,6 +10265,16 @@ type UpdateEnvironmentApiResponse = {
|
|
|
10171
10265
|
updatedAt?: string;
|
|
10172
10266
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
10173
10267
|
deletedAt?: string | null;
|
|
10268
|
+
/** 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.
|
|
10269
|
+
|
|
10270
|
+
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.
|
|
10271
|
+
|
|
10272
|
+
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.
|
|
10273
|
+
|
|
10274
|
+
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.
|
|
10275
|
+
|
|
10276
|
+
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. */
|
|
10277
|
+
purpose?: "user" | "administrative";
|
|
10174
10278
|
}[];
|
|
10175
10279
|
};
|
|
10176
10280
|
type UpdateEnvironmentApiArg = {
|
|
@@ -12686,6 +12790,16 @@ type GetEnvironmentsOfWorkspaceApiResponse = {
|
|
|
12686
12790
|
updatedAt?: string;
|
|
12687
12791
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
12688
12792
|
deletedAt?: string | null;
|
|
12793
|
+
/** 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.
|
|
12794
|
+
|
|
12795
|
+
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.
|
|
12796
|
+
|
|
12797
|
+
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.
|
|
12798
|
+
|
|
12799
|
+
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.
|
|
12800
|
+
|
|
12801
|
+
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. */
|
|
12802
|
+
purpose?: "user" | "administrative";
|
|
12689
12803
|
}[];
|
|
12690
12804
|
};
|
|
12691
12805
|
type GetEnvironmentsOfWorkspaceApiArg = {
|
|
@@ -719,6 +719,19 @@ export interface operations {
|
|
|
719
719
|
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
720
720
|
*/
|
|
721
721
|
deletedAt?: string | null;
|
|
722
|
+
/**
|
|
723
|
+
* @description 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.
|
|
724
|
+
*
|
|
725
|
+
* 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.
|
|
726
|
+
*
|
|
727
|
+
* 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.
|
|
728
|
+
*
|
|
729
|
+
* 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.
|
|
730
|
+
*
|
|
731
|
+
* 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.
|
|
732
|
+
* @enum {string}
|
|
733
|
+
*/
|
|
734
|
+
purpose?: "user" | "administrative";
|
|
722
735
|
};
|
|
723
736
|
};
|
|
724
737
|
};
|