@meshery/schemas 1.3.91 → 1.3.93
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 +71 -64
- package/dist/cloudApi.d.ts +71 -64
- 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/v1beta3/connection/Connection.d.ts +27 -27
- package/dist/constructs/v1beta3/connection/ConnectionSchema.js +3 -3
- package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +3 -3
- package/dist/constructs/v1beta3/environment/Environment.d.ts +29 -29
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.js +1 -1
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.mjs +1 -1
- package/dist/constructs/v1beta3/ledger/Ledger.d.ts +74 -35
- package/dist/constructs/v1beta3/ledger/LedgerSchema.js +20 -16
- package/dist/constructs/v1beta3/ledger/LedgerSchema.mjs +20 -16
- package/dist/constructs/v1beta3/profile/Profile.d.ts +3 -3
- package/dist/constructs/v1beta3/profile/ProfileSchema.js +1 -1
- package/dist/constructs/v1beta3/profile/ProfileSchema.mjs +1 -1
- 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/mesheryApi.d.mts +44 -44
- package/dist/mesheryApi.d.ts +44 -44
- package/package.json +1 -1
|
@@ -136,18 +136,18 @@ export interface components {
|
|
|
136
136
|
*/
|
|
137
137
|
deletedAt?: string | null;
|
|
138
138
|
/**
|
|
139
|
-
* @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.
|
|
139
|
+
* @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. Profiles are not environments: they are their own construct (`schemas/constructs/v1beta3/profile`, served at `/api/profiles` and assigned to workspaces under `/api/workspaces/{workspaceId}/profiles`).
|
|
140
140
|
*
|
|
141
141
|
* 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.
|
|
142
142
|
*
|
|
143
143
|
* 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.
|
|
144
144
|
*
|
|
145
|
-
* Privileged values are server-owned and never client-settable. `EnvironmentPayload`, which every environment POST and PUT requestBody references, accepts only the non-privileged
|
|
145
|
+
* Privileged values are server-owned and never client-settable. `EnvironmentPayload`, which every environment POST and PUT requestBody references, accepts only the non-privileged value `user`, 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.
|
|
146
146
|
*
|
|
147
147
|
* 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.
|
|
148
148
|
* @enum {string}
|
|
149
149
|
*/
|
|
150
|
-
purpose?: "user" | "administrative"
|
|
150
|
+
purpose?: "user" | "administrative";
|
|
151
151
|
};
|
|
152
152
|
/** @description Junction record linking an environment to a connection. */
|
|
153
153
|
EnvironmentConnectionMapping: {
|
|
@@ -198,16 +198,16 @@ export interface components {
|
|
|
198
198
|
[key: string]: unknown;
|
|
199
199
|
};
|
|
200
200
|
/**
|
|
201
|
-
* @description The
|
|
201
|
+
* @description The purpose a client may give an environment on create or update: `user` (an ordinary environment). Profiles are not environments; they are their own construct at `/api/profiles`, assigned to workspaces. 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.
|
|
202
202
|
* @enum {string}
|
|
203
203
|
*/
|
|
204
|
-
purpose?: "user"
|
|
204
|
+
purpose?: "user";
|
|
205
205
|
};
|
|
206
206
|
/**
|
|
207
|
-
* @description The
|
|
207
|
+
* @description The purpose a client may give an environment on create or update: `user` (an ordinary environment). Profiles are not environments; they are their own construct at `/api/profiles`, assigned to workspaces. 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.
|
|
208
208
|
* @enum {string}
|
|
209
209
|
*/
|
|
210
|
-
EnvironmentPayloadPurpose: "user"
|
|
210
|
+
EnvironmentPayloadPurpose: "user";
|
|
211
211
|
/** @description Paginated list of environments. */
|
|
212
212
|
EnvironmentPage: {
|
|
213
213
|
/** @description Zero-based page index returned in this response. */
|
|
@@ -268,18 +268,18 @@ export interface components {
|
|
|
268
268
|
*/
|
|
269
269
|
deletedAt?: string | null;
|
|
270
270
|
/**
|
|
271
|
-
* @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.
|
|
271
|
+
* @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. Profiles are not environments: they are their own construct (`schemas/constructs/v1beta3/profile`, served at `/api/profiles` and assigned to workspaces under `/api/workspaces/{workspaceId}/profiles`).
|
|
272
272
|
*
|
|
273
273
|
* 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.
|
|
274
274
|
*
|
|
275
275
|
* 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.
|
|
276
276
|
*
|
|
277
|
-
* Privileged values are server-owned and never client-settable. `EnvironmentPayload`, which every environment POST and PUT requestBody references, accepts only the non-privileged
|
|
277
|
+
* Privileged values are server-owned and never client-settable. `EnvironmentPayload`, which every environment POST and PUT requestBody references, accepts only the non-privileged value `user`, 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.
|
|
278
278
|
*
|
|
279
279
|
* 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.
|
|
280
280
|
* @enum {string}
|
|
281
281
|
*/
|
|
282
|
-
purpose?: "user" | "administrative"
|
|
282
|
+
purpose?: "user" | "administrative";
|
|
283
283
|
}[];
|
|
284
284
|
};
|
|
285
285
|
/** @description Paginated list of connections associated with an environment. */
|
|
@@ -423,10 +423,10 @@ export interface components {
|
|
|
423
423
|
[key: string]: unknown;
|
|
424
424
|
};
|
|
425
425
|
/**
|
|
426
|
-
* @description The
|
|
426
|
+
* @description The purpose a client may give an environment on create or update: `user` (an ordinary environment). Profiles are not environments; they are their own construct at `/api/profiles`, assigned to workspaces. 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.
|
|
427
427
|
* @enum {string}
|
|
428
428
|
*/
|
|
429
|
-
purpose?: "user"
|
|
429
|
+
purpose?: "user";
|
|
430
430
|
};
|
|
431
431
|
};
|
|
432
432
|
};
|
|
@@ -455,7 +455,7 @@ export interface operations {
|
|
|
455
455
|
/** @description User's organization ID */
|
|
456
456
|
orgId: string;
|
|
457
457
|
/** @description 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. */
|
|
458
|
-
purpose?: "user" | "administrative"
|
|
458
|
+
purpose?: "user" | "administrative";
|
|
459
459
|
};
|
|
460
460
|
header?: never;
|
|
461
461
|
path?: never;
|
|
@@ -528,18 +528,18 @@ export interface operations {
|
|
|
528
528
|
*/
|
|
529
529
|
deletedAt?: string | null;
|
|
530
530
|
/**
|
|
531
|
-
* @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.
|
|
531
|
+
* @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. Profiles are not environments: they are their own construct (`schemas/constructs/v1beta3/profile`, served at `/api/profiles` and assigned to workspaces under `/api/workspaces/{workspaceId}/profiles`).
|
|
532
532
|
*
|
|
533
533
|
* 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.
|
|
534
534
|
*
|
|
535
535
|
* 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.
|
|
536
536
|
*
|
|
537
|
-
* Privileged values are server-owned and never client-settable. `EnvironmentPayload`, which every environment POST and PUT requestBody references, accepts only the non-privileged
|
|
537
|
+
* Privileged values are server-owned and never client-settable. `EnvironmentPayload`, which every environment POST and PUT requestBody references, accepts only the non-privileged value `user`, 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.
|
|
538
538
|
*
|
|
539
539
|
* 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.
|
|
540
540
|
* @enum {string}
|
|
541
541
|
*/
|
|
542
|
-
purpose?: "user" | "administrative"
|
|
542
|
+
purpose?: "user" | "administrative";
|
|
543
543
|
}[];
|
|
544
544
|
};
|
|
545
545
|
};
|
|
@@ -589,10 +589,10 @@ export interface operations {
|
|
|
589
589
|
[key: string]: unknown;
|
|
590
590
|
};
|
|
591
591
|
/**
|
|
592
|
-
* @description The
|
|
592
|
+
* @description The purpose a client may give an environment on create or update: `user` (an ordinary environment). Profiles are not environments; they are their own construct at `/api/profiles`, assigned to workspaces. 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.
|
|
593
593
|
* @enum {string}
|
|
594
594
|
*/
|
|
595
|
-
purpose?: "user"
|
|
595
|
+
purpose?: "user";
|
|
596
596
|
};
|
|
597
597
|
};
|
|
598
598
|
};
|
|
@@ -654,18 +654,18 @@ export interface operations {
|
|
|
654
654
|
*/
|
|
655
655
|
deletedAt?: string | null;
|
|
656
656
|
/**
|
|
657
|
-
* @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.
|
|
657
|
+
* @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. Profiles are not environments: they are their own construct (`schemas/constructs/v1beta3/profile`, served at `/api/profiles` and assigned to workspaces under `/api/workspaces/{workspaceId}/profiles`).
|
|
658
658
|
*
|
|
659
659
|
* 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.
|
|
660
660
|
*
|
|
661
661
|
* 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.
|
|
662
662
|
*
|
|
663
|
-
* Privileged values are server-owned and never client-settable. `EnvironmentPayload`, which every environment POST and PUT requestBody references, accepts only the non-privileged
|
|
663
|
+
* Privileged values are server-owned and never client-settable. `EnvironmentPayload`, which every environment POST and PUT requestBody references, accepts only the non-privileged value `user`, 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.
|
|
664
664
|
*
|
|
665
665
|
* 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.
|
|
666
666
|
* @enum {string}
|
|
667
667
|
*/
|
|
668
|
-
purpose?: "user" | "administrative"
|
|
668
|
+
purpose?: "user" | "administrative";
|
|
669
669
|
};
|
|
670
670
|
};
|
|
671
671
|
};
|
|
@@ -778,18 +778,18 @@ export interface operations {
|
|
|
778
778
|
*/
|
|
779
779
|
deletedAt?: string | null;
|
|
780
780
|
/**
|
|
781
|
-
* @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.
|
|
781
|
+
* @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. Profiles are not environments: they are their own construct (`schemas/constructs/v1beta3/profile`, served at `/api/profiles` and assigned to workspaces under `/api/workspaces/{workspaceId}/profiles`).
|
|
782
782
|
*
|
|
783
783
|
* 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.
|
|
784
784
|
*
|
|
785
785
|
* 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.
|
|
786
786
|
*
|
|
787
|
-
* Privileged values are server-owned and never client-settable. `EnvironmentPayload`, which every environment POST and PUT requestBody references, accepts only the non-privileged
|
|
787
|
+
* Privileged values are server-owned and never client-settable. `EnvironmentPayload`, which every environment POST and PUT requestBody references, accepts only the non-privileged value `user`, 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.
|
|
788
788
|
*
|
|
789
789
|
* 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.
|
|
790
790
|
* @enum {string}
|
|
791
791
|
*/
|
|
792
|
-
purpose?: "user" | "administrative"
|
|
792
|
+
purpose?: "user" | "administrative";
|
|
793
793
|
}[];
|
|
794
794
|
};
|
|
795
795
|
};
|
|
@@ -860,10 +860,10 @@ export interface operations {
|
|
|
860
860
|
[key: string]: unknown;
|
|
861
861
|
};
|
|
862
862
|
/**
|
|
863
|
-
* @description The
|
|
863
|
+
* @description The purpose a client may give an environment on create or update: `user` (an ordinary environment). Profiles are not environments; they are their own construct at `/api/profiles`, assigned to workspaces. 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.
|
|
864
864
|
* @enum {string}
|
|
865
865
|
*/
|
|
866
|
-
purpose?: "user"
|
|
866
|
+
purpose?: "user";
|
|
867
867
|
};
|
|
868
868
|
};
|
|
869
869
|
};
|
|
@@ -933,18 +933,18 @@ export interface operations {
|
|
|
933
933
|
*/
|
|
934
934
|
deletedAt?: string | null;
|
|
935
935
|
/**
|
|
936
|
-
* @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.
|
|
936
|
+
* @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. Profiles are not environments: they are their own construct (`schemas/constructs/v1beta3/profile`, served at `/api/profiles` and assigned to workspaces under `/api/workspaces/{workspaceId}/profiles`).
|
|
937
937
|
*
|
|
938
938
|
* 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.
|
|
939
939
|
*
|
|
940
940
|
* 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.
|
|
941
941
|
*
|
|
942
|
-
* Privileged values are server-owned and never client-settable. `EnvironmentPayload`, which every environment POST and PUT requestBody references, accepts only the non-privileged
|
|
942
|
+
* Privileged values are server-owned and never client-settable. `EnvironmentPayload`, which every environment POST and PUT requestBody references, accepts only the non-privileged value `user`, 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.
|
|
943
943
|
*
|
|
944
944
|
* 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.
|
|
945
945
|
* @enum {string}
|
|
946
946
|
*/
|
|
947
|
-
purpose?: "user" | "administrative"
|
|
947
|
+
purpose?: "user" | "administrative";
|
|
948
948
|
}[];
|
|
949
949
|
};
|
|
950
950
|
};
|