@meshery/schemas 1.3.59 → 1.3.61
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/README.md +9 -1
- package/dist/cloudApi.d.mts +19652 -6718
- package/dist/cloudApi.d.ts +19652 -6718
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta1/feature/Feature.d.ts +10 -10
- package/dist/constructs/v1beta1/feature/FeatureSchema.js +1 -1
- package/dist/constructs/v1beta1/feature/FeatureSchema.mjs +1 -1
- package/dist/constructs/v1beta1/organization_smtp/OrganizationSmtp.d.ts +2 -2
- 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 +6 -6
- package/dist/constructs/v1beta1/registry/RegistrySchema.js +3 -3
- package/dist/constructs/v1beta1/registry/RegistrySchema.mjs +3 -3
- package/dist/constructs/v1beta3/blowhorn_binding/BlowhornBinding.d.ts +462 -0
- package/dist/constructs/v1beta3/blowhorn_binding/BlowhornBinding.js +1 -0
- package/dist/constructs/v1beta3/blowhorn_binding/BlowhornBinding.mjs +0 -0
- package/dist/constructs/v1beta3/blowhorn_binding/BlowhornBindingSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/blowhorn_binding/BlowhornBindingSchema.js +23 -0
- package/dist/constructs/v1beta3/blowhorn_binding/BlowhornBindingSchema.mjs +23 -0
- package/dist/constructs/v1beta3/blowhorn_content/BlowhornContent.d.ts +719 -0
- package/dist/constructs/v1beta3/blowhorn_content/BlowhornContent.js +1 -0
- package/dist/constructs/v1beta3/blowhorn_content/BlowhornContent.mjs +0 -0
- package/dist/constructs/v1beta3/blowhorn_content/BlowhornContentSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/blowhorn_content/BlowhornContentSchema.js +43 -0
- package/dist/constructs/v1beta3/blowhorn_content/BlowhornContentSchema.mjs +43 -0
- package/dist/constructs/v1beta3/blowhorn_destination/BlowhornDestination.d.ts +516 -0
- package/dist/constructs/v1beta3/blowhorn_destination/BlowhornDestination.js +1 -0
- package/dist/constructs/v1beta3/blowhorn_destination/BlowhornDestination.mjs +0 -0
- package/dist/constructs/v1beta3/blowhorn_destination/BlowhornDestinationSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/blowhorn_destination/BlowhornDestinationSchema.js +23 -0
- package/dist/constructs/v1beta3/blowhorn_destination/BlowhornDestinationSchema.mjs +23 -0
- package/dist/constructs/v1beta3/blowhorn_health/BlowhornHealth.d.ts +131 -0
- package/dist/constructs/v1beta3/blowhorn_health/BlowhornHealth.js +1 -0
- package/dist/constructs/v1beta3/blowhorn_health/BlowhornHealth.mjs +0 -0
- package/dist/constructs/v1beta3/blowhorn_health/BlowhornHealthSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/blowhorn_health/BlowhornHealthSchema.js +7 -0
- package/dist/constructs/v1beta3/blowhorn_health/BlowhornHealthSchema.mjs +7 -0
- package/dist/constructs/v1beta3/blowhorn_ledger/BlowhornLedger.d.ts +1546 -0
- package/dist/constructs/v1beta3/blowhorn_ledger/BlowhornLedger.js +1 -0
- package/dist/constructs/v1beta3/blowhorn_ledger/BlowhornLedger.mjs +0 -0
- package/dist/constructs/v1beta3/blowhorn_ledger/BlowhornLedgerSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/blowhorn_ledger/BlowhornLedgerSchema.js +69 -0
- package/dist/constructs/v1beta3/blowhorn_ledger/BlowhornLedgerSchema.mjs +69 -0
- package/dist/constructs/v1beta3/blowhorn_profile/BlowhornProfile.d.ts +776 -0
- package/dist/constructs/v1beta3/blowhorn_profile/BlowhornProfile.js +1 -0
- package/dist/constructs/v1beta3/blowhorn_profile/BlowhornProfile.mjs +0 -0
- package/dist/constructs/v1beta3/blowhorn_profile/BlowhornProfileSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/blowhorn_profile/BlowhornProfileSchema.js +45 -0
- package/dist/constructs/v1beta3/blowhorn_profile/BlowhornProfileSchema.mjs +45 -0
- package/dist/constructs/v1beta3/blowhorn_run/BlowhornRun.d.ts +784 -0
- package/dist/constructs/v1beta3/blowhorn_run/BlowhornRun.js +1 -0
- package/dist/constructs/v1beta3/blowhorn_run/BlowhornRun.mjs +0 -0
- package/dist/constructs/v1beta3/blowhorn_run/BlowhornRunSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/blowhorn_run/BlowhornRunSchema.js +51 -0
- package/dist/constructs/v1beta3/blowhorn_run/BlowhornRunSchema.mjs +51 -0
- package/dist/constructs/v1beta3/connection/Connection.d.ts +14 -14
- 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 +12 -12
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.js +1 -1
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.mjs +1 -1
- package/dist/constructs/v1beta3/job_lease/JobLease.d.ts +2570 -0
- package/dist/constructs/v1beta3/job_lease/JobLease.js +1 -0
- package/dist/constructs/v1beta3/job_lease/JobLease.mjs +0 -0
- package/dist/constructs/v1beta3/job_lease/JobLeaseSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/job_lease/JobLeaseSchema.js +83 -0
- package/dist/constructs/v1beta3/job_lease/JobLeaseSchema.mjs +83 -0
- package/dist/constructs/v1beta3/token/Token.d.ts +4 -2
- package/dist/constructs/v1beta3/token/TokenSchema.js +1 -1
- package/dist/constructs/v1beta3/token/TokenSchema.mjs +1 -1
- package/dist/constructs/v1beta3/workspace/Workspace.d.ts +2 -2
- package/dist/constructs/v1beta3/workspace/WorkspaceSchema.js +1 -1
- package/dist/constructs/v1beta3/workspace/WorkspaceSchema.mjs +1 -1
- package/dist/index.d.mts +6 -6
- package/dist/index.d.ts +6 -6
- package/dist/mesheryApi.d.mts +24 -24
- package/dist/mesheryApi.d.ts +24 -24
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/dist/permissions.d.mts +211 -1
- package/dist/permissions.d.ts +211 -1
- package/dist/permissions.js +1 -1
- package/dist/permissions.mjs +1 -1
- package/package.json +2 -1
package/dist/mesheryApi.d.mts
CHANGED
|
@@ -6697,7 +6697,7 @@ 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. `blowhorn` designates an environment the platform itself provisions to hold an organization's Blowhorn configuration and secrets, resolved by the purpose-typed credential chain; it is privileged in the same sense as `administrative`.
|
|
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
|
|
|
@@ -6706,7 +6706,7 @@ type RegisterRegistryComponentApiArg = {
|
|
|
6706
6706
|
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.
|
|
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" | "blowhorn";
|
|
6710
6710
|
}[];
|
|
6711
6711
|
/** Specifies the version of the schema used for the definition. */
|
|
6712
6712
|
schemaVersion: string;
|
|
@@ -7395,7 +7395,7 @@ 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. `blowhorn` designates an environment the platform itself provisions to hold an organization's Blowhorn configuration and secrets, resolved by the purpose-typed credential chain; it is privileged in the same sense as `administrative`.
|
|
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
|
|
|
@@ -7404,7 +7404,7 @@ type RegisterRegistryRelationshipApiArg = {
|
|
|
7404
7404
|
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.
|
|
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" | "blowhorn";
|
|
7408
7408
|
}[];
|
|
7409
7409
|
/** Specifies the version of the schema used for the definition. */
|
|
7410
7410
|
schemaVersion: string;
|
|
@@ -10544,7 +10544,7 @@ type GetConnectionsApiResponse = {
|
|
|
10544
10544
|
updatedAt?: string;
|
|
10545
10545
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
10546
10546
|
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.
|
|
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. `blowhorn` designates an environment the platform itself provisions to hold an organization's Blowhorn configuration and secrets, resolved by the purpose-typed credential chain; it is privileged in the same sense as `administrative`.
|
|
10548
10548
|
|
|
10549
10549
|
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
10550
|
|
|
@@ -10553,7 +10553,7 @@ type GetConnectionsApiResponse = {
|
|
|
10553
10553
|
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.
|
|
10554
10554
|
|
|
10555
10555
|
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";
|
|
10556
|
+
purpose?: "user" | "administrative" | "blowhorn";
|
|
10557
10557
|
}[];
|
|
10558
10558
|
/** Specifies the version of the schema used for the definition. */
|
|
10559
10559
|
schemaVersion: string;
|
|
@@ -10811,7 +10811,7 @@ type RegisterConnectionApiResponse = {
|
|
|
10811
10811
|
updatedAt?: string;
|
|
10812
10812
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
10813
10813
|
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.
|
|
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. `blowhorn` designates an environment the platform itself provisions to hold an organization's Blowhorn configuration and secrets, resolved by the purpose-typed credential chain; it is privileged in the same sense as `administrative`.
|
|
10815
10815
|
|
|
10816
10816
|
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
10817
|
|
|
@@ -10820,7 +10820,7 @@ type RegisterConnectionApiResponse = {
|
|
|
10820
10820
|
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.
|
|
10821
10821
|
|
|
10822
10822
|
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";
|
|
10823
|
+
purpose?: "user" | "administrative" | "blowhorn";
|
|
10824
10824
|
}[];
|
|
10825
10825
|
/** Specifies the version of the schema used for the definition. */
|
|
10826
10826
|
schemaVersion: string;
|
|
@@ -11243,7 +11243,7 @@ type GetConnectionByIdApiResponse = {
|
|
|
11243
11243
|
updatedAt?: string;
|
|
11244
11244
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
11245
11245
|
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.
|
|
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. `blowhorn` designates an environment the platform itself provisions to hold an organization's Blowhorn configuration and secrets, resolved by the purpose-typed credential chain; it is privileged in the same sense as `administrative`.
|
|
11247
11247
|
|
|
11248
11248
|
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
11249
|
|
|
@@ -11252,7 +11252,7 @@ type GetConnectionByIdApiResponse = {
|
|
|
11252
11252
|
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.
|
|
11253
11253
|
|
|
11254
11254
|
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";
|
|
11255
|
+
purpose?: "user" | "administrative" | "blowhorn";
|
|
11256
11256
|
}[];
|
|
11257
11257
|
/** Specifies the version of the schema used for the definition. */
|
|
11258
11258
|
schemaVersion: string;
|
|
@@ -11481,7 +11481,7 @@ type UpdateConnectionApiResponse = {
|
|
|
11481
11481
|
updatedAt?: string;
|
|
11482
11482
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
11483
11483
|
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.
|
|
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. `blowhorn` designates an environment the platform itself provisions to hold an organization's Blowhorn configuration and secrets, resolved by the purpose-typed credential chain; it is privileged in the same sense as `administrative`.
|
|
11485
11485
|
|
|
11486
11486
|
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
11487
|
|
|
@@ -11490,7 +11490,7 @@ type UpdateConnectionApiResponse = {
|
|
|
11490
11490
|
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.
|
|
11491
11491
|
|
|
11492
11492
|
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";
|
|
11493
|
+
purpose?: "user" | "administrative" | "blowhorn";
|
|
11494
11494
|
}[];
|
|
11495
11495
|
/** Specifies the version of the schema used for the definition. */
|
|
11496
11496
|
schemaVersion: string;
|
|
@@ -11881,7 +11881,7 @@ type PerformConnectionActionApiResponse =
|
|
|
11881
11881
|
updatedAt?: string;
|
|
11882
11882
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
11883
11883
|
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.
|
|
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. `blowhorn` designates an environment the platform itself provisions to hold an organization's Blowhorn configuration and secrets, resolved by the purpose-typed credential chain; it is privileged in the same sense as `administrative`.
|
|
11885
11885
|
|
|
11886
11886
|
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
11887
|
|
|
@@ -11890,7 +11890,7 @@ type PerformConnectionActionApiResponse =
|
|
|
11890
11890
|
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.
|
|
11891
11891
|
|
|
11892
11892
|
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";
|
|
11893
|
+
purpose?: "user" | "administrative" | "blowhorn";
|
|
11894
11894
|
}[];
|
|
11895
11895
|
/** Specifies the version of the schema used for the definition. */
|
|
11896
11896
|
schemaVersion: string;
|
|
@@ -12664,7 +12664,7 @@ type CreateEnvironmentApiResponse = {
|
|
|
12664
12664
|
updatedAt?: string;
|
|
12665
12665
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
12666
12666
|
deletedAt?: string | null;
|
|
12667
|
-
/** 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.
|
|
12667
|
+
/** 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. `blowhorn` designates an environment the platform itself provisions to hold an organization's Blowhorn configuration and secrets, resolved by the purpose-typed credential chain; it is privileged in the same sense as `administrative`.
|
|
12668
12668
|
|
|
12669
12669
|
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.
|
|
12670
12670
|
|
|
@@ -12673,7 +12673,7 @@ type CreateEnvironmentApiResponse = {
|
|
|
12673
12673
|
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.
|
|
12674
12674
|
|
|
12675
12675
|
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. */
|
|
12676
|
-
purpose?: "user" | "administrative";
|
|
12676
|
+
purpose?: "user" | "administrative" | "blowhorn";
|
|
12677
12677
|
};
|
|
12678
12678
|
type CreateEnvironmentApiArg = {
|
|
12679
12679
|
/** Body for creating environment */
|
|
@@ -12715,7 +12715,7 @@ type GetEnvironmentsApiResponse = {
|
|
|
12715
12715
|
updatedAt?: string;
|
|
12716
12716
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
12717
12717
|
deletedAt?: string | null;
|
|
12718
|
-
/** 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.
|
|
12718
|
+
/** 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. `blowhorn` designates an environment the platform itself provisions to hold an organization's Blowhorn configuration and secrets, resolved by the purpose-typed credential chain; it is privileged in the same sense as `administrative`.
|
|
12719
12719
|
|
|
12720
12720
|
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.
|
|
12721
12721
|
|
|
@@ -12724,7 +12724,7 @@ type GetEnvironmentsApiResponse = {
|
|
|
12724
12724
|
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.
|
|
12725
12725
|
|
|
12726
12726
|
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. */
|
|
12727
|
-
purpose?: "user" | "administrative";
|
|
12727
|
+
purpose?: "user" | "administrative" | "blowhorn";
|
|
12728
12728
|
}[];
|
|
12729
12729
|
};
|
|
12730
12730
|
type GetEnvironmentsApiArg = {
|
|
@@ -12770,7 +12770,7 @@ type GetEnvironmentByIdApiResponse = {
|
|
|
12770
12770
|
updatedAt?: string;
|
|
12771
12771
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
12772
12772
|
deletedAt?: string | null;
|
|
12773
|
-
/** 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.
|
|
12773
|
+
/** 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. `blowhorn` designates an environment the platform itself provisions to hold an organization's Blowhorn configuration and secrets, resolved by the purpose-typed credential chain; it is privileged in the same sense as `administrative`.
|
|
12774
12774
|
|
|
12775
12775
|
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.
|
|
12776
12776
|
|
|
@@ -12779,7 +12779,7 @@ type GetEnvironmentByIdApiResponse = {
|
|
|
12779
12779
|
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.
|
|
12780
12780
|
|
|
12781
12781
|
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. */
|
|
12782
|
-
purpose?: "user" | "administrative";
|
|
12782
|
+
purpose?: "user" | "administrative" | "blowhorn";
|
|
12783
12783
|
}[];
|
|
12784
12784
|
};
|
|
12785
12785
|
type GetEnvironmentByIdApiArg = {
|
|
@@ -12817,7 +12817,7 @@ type UpdateEnvironmentApiResponse = {
|
|
|
12817
12817
|
updatedAt?: string;
|
|
12818
12818
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
12819
12819
|
deletedAt?: string | null;
|
|
12820
|
-
/** 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.
|
|
12820
|
+
/** 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. `blowhorn` designates an environment the platform itself provisions to hold an organization's Blowhorn configuration and secrets, resolved by the purpose-typed credential chain; it is privileged in the same sense as `administrative`.
|
|
12821
12821
|
|
|
12822
12822
|
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.
|
|
12823
12823
|
|
|
@@ -12826,7 +12826,7 @@ type UpdateEnvironmentApiResponse = {
|
|
|
12826
12826
|
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.
|
|
12827
12827
|
|
|
12828
12828
|
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. */
|
|
12829
|
-
purpose?: "user" | "administrative";
|
|
12829
|
+
purpose?: "user" | "administrative" | "blowhorn";
|
|
12830
12830
|
}[];
|
|
12831
12831
|
};
|
|
12832
12832
|
type UpdateEnvironmentApiArg = {
|
|
@@ -13635,7 +13635,7 @@ type GetEnvironmentsOfWorkspaceApiResponse = {
|
|
|
13635
13635
|
updatedAt?: string;
|
|
13636
13636
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
13637
13637
|
deletedAt?: string | null;
|
|
13638
|
-
/** 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.
|
|
13638
|
+
/** 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. `blowhorn` designates an environment the platform itself provisions to hold an organization's Blowhorn configuration and secrets, resolved by the purpose-typed credential chain; it is privileged in the same sense as `administrative`.
|
|
13639
13639
|
|
|
13640
13640
|
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.
|
|
13641
13641
|
|
|
@@ -13644,7 +13644,7 @@ type GetEnvironmentsOfWorkspaceApiResponse = {
|
|
|
13644
13644
|
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.
|
|
13645
13645
|
|
|
13646
13646
|
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. */
|
|
13647
|
-
purpose?: "user" | "administrative";
|
|
13647
|
+
purpose?: "user" | "administrative" | "blowhorn";
|
|
13648
13648
|
}[];
|
|
13649
13649
|
};
|
|
13650
13650
|
type GetEnvironmentsOfWorkspaceApiArg = {
|
package/dist/mesheryApi.d.ts
CHANGED
|
@@ -6697,7 +6697,7 @@ 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. `blowhorn` designates an environment the platform itself provisions to hold an organization's Blowhorn configuration and secrets, resolved by the purpose-typed credential chain; it is privileged in the same sense as `administrative`.
|
|
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
|
|
|
@@ -6706,7 +6706,7 @@ type RegisterRegistryComponentApiArg = {
|
|
|
6706
6706
|
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.
|
|
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" | "blowhorn";
|
|
6710
6710
|
}[];
|
|
6711
6711
|
/** Specifies the version of the schema used for the definition. */
|
|
6712
6712
|
schemaVersion: string;
|
|
@@ -7395,7 +7395,7 @@ 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. `blowhorn` designates an environment the platform itself provisions to hold an organization's Blowhorn configuration and secrets, resolved by the purpose-typed credential chain; it is privileged in the same sense as `administrative`.
|
|
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
|
|
|
@@ -7404,7 +7404,7 @@ type RegisterRegistryRelationshipApiArg = {
|
|
|
7404
7404
|
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.
|
|
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" | "blowhorn";
|
|
7408
7408
|
}[];
|
|
7409
7409
|
/** Specifies the version of the schema used for the definition. */
|
|
7410
7410
|
schemaVersion: string;
|
|
@@ -10544,7 +10544,7 @@ type GetConnectionsApiResponse = {
|
|
|
10544
10544
|
updatedAt?: string;
|
|
10545
10545
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
10546
10546
|
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.
|
|
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. `blowhorn` designates an environment the platform itself provisions to hold an organization's Blowhorn configuration and secrets, resolved by the purpose-typed credential chain; it is privileged in the same sense as `administrative`.
|
|
10548
10548
|
|
|
10549
10549
|
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
10550
|
|
|
@@ -10553,7 +10553,7 @@ type GetConnectionsApiResponse = {
|
|
|
10553
10553
|
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.
|
|
10554
10554
|
|
|
10555
10555
|
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";
|
|
10556
|
+
purpose?: "user" | "administrative" | "blowhorn";
|
|
10557
10557
|
}[];
|
|
10558
10558
|
/** Specifies the version of the schema used for the definition. */
|
|
10559
10559
|
schemaVersion: string;
|
|
@@ -10811,7 +10811,7 @@ type RegisterConnectionApiResponse = {
|
|
|
10811
10811
|
updatedAt?: string;
|
|
10812
10812
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
10813
10813
|
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.
|
|
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. `blowhorn` designates an environment the platform itself provisions to hold an organization's Blowhorn configuration and secrets, resolved by the purpose-typed credential chain; it is privileged in the same sense as `administrative`.
|
|
10815
10815
|
|
|
10816
10816
|
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
10817
|
|
|
@@ -10820,7 +10820,7 @@ type RegisterConnectionApiResponse = {
|
|
|
10820
10820
|
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.
|
|
10821
10821
|
|
|
10822
10822
|
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";
|
|
10823
|
+
purpose?: "user" | "administrative" | "blowhorn";
|
|
10824
10824
|
}[];
|
|
10825
10825
|
/** Specifies the version of the schema used for the definition. */
|
|
10826
10826
|
schemaVersion: string;
|
|
@@ -11243,7 +11243,7 @@ type GetConnectionByIdApiResponse = {
|
|
|
11243
11243
|
updatedAt?: string;
|
|
11244
11244
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
11245
11245
|
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.
|
|
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. `blowhorn` designates an environment the platform itself provisions to hold an organization's Blowhorn configuration and secrets, resolved by the purpose-typed credential chain; it is privileged in the same sense as `administrative`.
|
|
11247
11247
|
|
|
11248
11248
|
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
11249
|
|
|
@@ -11252,7 +11252,7 @@ type GetConnectionByIdApiResponse = {
|
|
|
11252
11252
|
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.
|
|
11253
11253
|
|
|
11254
11254
|
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";
|
|
11255
|
+
purpose?: "user" | "administrative" | "blowhorn";
|
|
11256
11256
|
}[];
|
|
11257
11257
|
/** Specifies the version of the schema used for the definition. */
|
|
11258
11258
|
schemaVersion: string;
|
|
@@ -11481,7 +11481,7 @@ type UpdateConnectionApiResponse = {
|
|
|
11481
11481
|
updatedAt?: string;
|
|
11482
11482
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
11483
11483
|
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.
|
|
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. `blowhorn` designates an environment the platform itself provisions to hold an organization's Blowhorn configuration and secrets, resolved by the purpose-typed credential chain; it is privileged in the same sense as `administrative`.
|
|
11485
11485
|
|
|
11486
11486
|
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
11487
|
|
|
@@ -11490,7 +11490,7 @@ type UpdateConnectionApiResponse = {
|
|
|
11490
11490
|
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.
|
|
11491
11491
|
|
|
11492
11492
|
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";
|
|
11493
|
+
purpose?: "user" | "administrative" | "blowhorn";
|
|
11494
11494
|
}[];
|
|
11495
11495
|
/** Specifies the version of the schema used for the definition. */
|
|
11496
11496
|
schemaVersion: string;
|
|
@@ -11881,7 +11881,7 @@ type PerformConnectionActionApiResponse =
|
|
|
11881
11881
|
updatedAt?: string;
|
|
11882
11882
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
11883
11883
|
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.
|
|
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. `blowhorn` designates an environment the platform itself provisions to hold an organization's Blowhorn configuration and secrets, resolved by the purpose-typed credential chain; it is privileged in the same sense as `administrative`.
|
|
11885
11885
|
|
|
11886
11886
|
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
11887
|
|
|
@@ -11890,7 +11890,7 @@ type PerformConnectionActionApiResponse =
|
|
|
11890
11890
|
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.
|
|
11891
11891
|
|
|
11892
11892
|
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";
|
|
11893
|
+
purpose?: "user" | "administrative" | "blowhorn";
|
|
11894
11894
|
}[];
|
|
11895
11895
|
/** Specifies the version of the schema used for the definition. */
|
|
11896
11896
|
schemaVersion: string;
|
|
@@ -12664,7 +12664,7 @@ type CreateEnvironmentApiResponse = {
|
|
|
12664
12664
|
updatedAt?: string;
|
|
12665
12665
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
12666
12666
|
deletedAt?: string | null;
|
|
12667
|
-
/** 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.
|
|
12667
|
+
/** 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. `blowhorn` designates an environment the platform itself provisions to hold an organization's Blowhorn configuration and secrets, resolved by the purpose-typed credential chain; it is privileged in the same sense as `administrative`.
|
|
12668
12668
|
|
|
12669
12669
|
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.
|
|
12670
12670
|
|
|
@@ -12673,7 +12673,7 @@ type CreateEnvironmentApiResponse = {
|
|
|
12673
12673
|
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.
|
|
12674
12674
|
|
|
12675
12675
|
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. */
|
|
12676
|
-
purpose?: "user" | "administrative";
|
|
12676
|
+
purpose?: "user" | "administrative" | "blowhorn";
|
|
12677
12677
|
};
|
|
12678
12678
|
type CreateEnvironmentApiArg = {
|
|
12679
12679
|
/** Body for creating environment */
|
|
@@ -12715,7 +12715,7 @@ type GetEnvironmentsApiResponse = {
|
|
|
12715
12715
|
updatedAt?: string;
|
|
12716
12716
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
12717
12717
|
deletedAt?: string | null;
|
|
12718
|
-
/** 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.
|
|
12718
|
+
/** 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. `blowhorn` designates an environment the platform itself provisions to hold an organization's Blowhorn configuration and secrets, resolved by the purpose-typed credential chain; it is privileged in the same sense as `administrative`.
|
|
12719
12719
|
|
|
12720
12720
|
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.
|
|
12721
12721
|
|
|
@@ -12724,7 +12724,7 @@ type GetEnvironmentsApiResponse = {
|
|
|
12724
12724
|
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.
|
|
12725
12725
|
|
|
12726
12726
|
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. */
|
|
12727
|
-
purpose?: "user" | "administrative";
|
|
12727
|
+
purpose?: "user" | "administrative" | "blowhorn";
|
|
12728
12728
|
}[];
|
|
12729
12729
|
};
|
|
12730
12730
|
type GetEnvironmentsApiArg = {
|
|
@@ -12770,7 +12770,7 @@ type GetEnvironmentByIdApiResponse = {
|
|
|
12770
12770
|
updatedAt?: string;
|
|
12771
12771
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
12772
12772
|
deletedAt?: string | null;
|
|
12773
|
-
/** 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.
|
|
12773
|
+
/** 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. `blowhorn` designates an environment the platform itself provisions to hold an organization's Blowhorn configuration and secrets, resolved by the purpose-typed credential chain; it is privileged in the same sense as `administrative`.
|
|
12774
12774
|
|
|
12775
12775
|
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.
|
|
12776
12776
|
|
|
@@ -12779,7 +12779,7 @@ type GetEnvironmentByIdApiResponse = {
|
|
|
12779
12779
|
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.
|
|
12780
12780
|
|
|
12781
12781
|
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. */
|
|
12782
|
-
purpose?: "user" | "administrative";
|
|
12782
|
+
purpose?: "user" | "administrative" | "blowhorn";
|
|
12783
12783
|
}[];
|
|
12784
12784
|
};
|
|
12785
12785
|
type GetEnvironmentByIdApiArg = {
|
|
@@ -12817,7 +12817,7 @@ type UpdateEnvironmentApiResponse = {
|
|
|
12817
12817
|
updatedAt?: string;
|
|
12818
12818
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
12819
12819
|
deletedAt?: string | null;
|
|
12820
|
-
/** 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.
|
|
12820
|
+
/** 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. `blowhorn` designates an environment the platform itself provisions to hold an organization's Blowhorn configuration and secrets, resolved by the purpose-typed credential chain; it is privileged in the same sense as `administrative`.
|
|
12821
12821
|
|
|
12822
12822
|
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.
|
|
12823
12823
|
|
|
@@ -12826,7 +12826,7 @@ type UpdateEnvironmentApiResponse = {
|
|
|
12826
12826
|
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.
|
|
12827
12827
|
|
|
12828
12828
|
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. */
|
|
12829
|
-
purpose?: "user" | "administrative";
|
|
12829
|
+
purpose?: "user" | "administrative" | "blowhorn";
|
|
12830
12830
|
}[];
|
|
12831
12831
|
};
|
|
12832
12832
|
type UpdateEnvironmentApiArg = {
|
|
@@ -13635,7 +13635,7 @@ type GetEnvironmentsOfWorkspaceApiResponse = {
|
|
|
13635
13635
|
updatedAt?: string;
|
|
13636
13636
|
/** Timestamp when the environment was soft deleted. Null while the environment remains active. */
|
|
13637
13637
|
deletedAt?: string | null;
|
|
13638
|
-
/** 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.
|
|
13638
|
+
/** 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. `blowhorn` designates an environment the platform itself provisions to hold an organization's Blowhorn configuration and secrets, resolved by the purpose-typed credential chain; it is privileged in the same sense as `administrative`.
|
|
13639
13639
|
|
|
13640
13640
|
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.
|
|
13641
13641
|
|
|
@@ -13644,7 +13644,7 @@ type GetEnvironmentsOfWorkspaceApiResponse = {
|
|
|
13644
13644
|
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.
|
|
13645
13645
|
|
|
13646
13646
|
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. */
|
|
13647
|
-
purpose?: "user" | "administrative";
|
|
13647
|
+
purpose?: "user" | "administrative" | "blowhorn";
|
|
13648
13648
|
}[];
|
|
13649
13649
|
};
|
|
13650
13650
|
type GetEnvironmentsOfWorkspaceApiArg = {
|