@meshery/schemas 1.3.95 → 1.3.96
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 +9 -9
- package/dist/cloudApi.d.ts +9 -9
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta1/registry/Registry.d.ts +3 -3
- 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 +23 -21
- package/dist/constructs/v1beta3/connection/ConnectionSchema.js +5 -4
- package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +5 -4
- package/dist/constructs/v1beta3/provider_capability/ProviderCapability.d.ts +2 -2
- package/dist/constructs/v1beta3/provider_capability/ProviderCapabilitySchema.js +2 -2
- package/dist/constructs/v1beta3/provider_capability/ProviderCapabilitySchema.mjs +2 -2
- package/dist/mesheryApi.d.mts +8 -8
- package/dist/mesheryApi.d.ts +8 -8
- package/dist/permissions.d.mts +141 -1
- package/dist/permissions.d.ts +141 -1
- package/dist/permissions.js +1 -1
- package/dist/permissions.mjs +1 -1
- package/package.json +1 -1
|
@@ -222,7 +222,7 @@ export interface components {
|
|
|
222
222
|
extensions?: {
|
|
223
223
|
[key: string]: unknown;
|
|
224
224
|
};
|
|
225
|
-
/** @description Features the provider serves and their endpoints. Clients read paths from here instead of hard-coding them. A provider serving desktop connections lists `register-connection`, `connection-heartbeat` and `deregister-desktop-connection`; an endpoint may hold `{connectionId}` or `{
|
|
225
|
+
/** @description Features the provider serves and their endpoints. Clients read paths from here instead of hard-coding them. A provider serving desktop connections lists `register-connection`, `connection-heartbeat` and `deregister-desktop-connection`; an endpoint may hold `{connectionId}` or `{installationId}` placeholders. */
|
|
226
226
|
capabilities?: {
|
|
227
227
|
/** @description Feature name, for example `persist-connection`. */
|
|
228
228
|
feature: string;
|
|
@@ -669,7 +669,7 @@ export interface operations {
|
|
|
669
669
|
extensions?: {
|
|
670
670
|
[key: string]: unknown;
|
|
671
671
|
};
|
|
672
|
-
/** @description Features the provider serves and their endpoints. Clients read paths from here instead of hard-coding them. A provider serving desktop connections lists `register-connection`, `connection-heartbeat` and `deregister-desktop-connection`; an endpoint may hold `{connectionId}` or `{
|
|
672
|
+
/** @description Features the provider serves and their endpoints. Clients read paths from here instead of hard-coding them. A provider serving desktop connections lists `register-connection`, `connection-heartbeat` and `deregister-desktop-connection`; an endpoint may hold `{connectionId}` or `{installationId}` placeholders. */
|
|
673
673
|
capabilities?: {
|
|
674
674
|
/** @description Feature name, for example `persist-connection`. */
|
|
675
675
|
feature: string;
|
|
@@ -29,7 +29,7 @@ it, which a client treats as not serving the contract.
|
|
|
29
29
|
named by \`X-Current-Orgid\`. Present only on an authenticated request
|
|
30
30
|
that carried that header.
|
|
31
31
|
`,additionalProperties:false,required:["organizationId","bound"],properties:{organizationId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},bound:{type:"boolean",description:"True when the caller is a live member of the organization."}}},compatibility:{type:"object",description:"Whether a client application's version meets the provider's minimum for that client. A client whose `compatible` is false must update before it registers or keeps a connection alive; the provider answers those calls with 426. A client the provider has no minimum for is compatible and has no `minimumVersion`.\n",additionalProperties:false,required:["clientName","clientVersion","compatible"],properties:{clientName:{type:"string",description:`Identifier of a client application, for example the product name of a desktop app, lowercase. It is a value chosen by the client; the provider keys its minimum client versions by it.
|
|
32
|
-
`,minLength:1,maxLength:64,pattern:"^[a-z0-9][a-z0-9-]*$"},clientVersion:{type:"string",description:"The client's version as it reported it, as `MAJOR.MINOR.PATCH` with an optional leading `v`, for example `v1.25.0`. Versions are ordered by their numeric parts, so `v1.9.0` is older than `v1.25.0`.",maxLength:64},minimumVersion:{type:"string",description:"Oldest client version the provider accepts for this client. Absent when the provider sets no minimum.",maxLength:64},compatible:{type:"boolean",description:"True when `clientVersion` is at or above `minimumVersion`, or when there is no minimum."},upgradeUrl:{type:"string",description:"Where the client can get an update, when the provider knows one.",maxLength:2048}}},session:{type:"object",description:"The authenticated caller's session as the provider sees it: who the caller is, the caller's roles, and, for the organization named by `X-Current-Orgid` when the caller is a live member of it, that organization's roles, plan, entitlements and device usage. Present only on an authenticated request.\n",additionalProperties:false,required:["userId","providerRoles"],properties:{userId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},providerRoles:{type:"array",description:"The caller's provider-wide role names.",items:{type:"string",maxLength:255}},organizationRoles:{type:"array",description:"The caller's role names in the organization.",items:{type:"string",maxLength:255}},plan:{description:"The plan of the organization's active subscription, when it has one.","x-go-type":"planv1beta3.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta3/plan",name:"planv1beta3"},type:"object",additionalProperties:false,required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},entitlements:{type:"array",description:"The features the organization's active subscriptions entitle it to.",items:{"x-go-type":"featurev1beta1.Feature","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/feature",name:"featurev1beta1"},type:"object",additionalProperties:false,description:"A feature is a quantified entitlement granted to an organization through its subscription plan, such as the number of components allowed in a design.",required:["id","plan_id","name","quantity","created_at","updated_at"],properties:{id:{description:"Unique identifier for the feature.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",csv:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan_id:{description:"Identifier of the plan granting this feature.","x-go-name":"PlanId","x-oapi-codegen-extra-tags":{db:"plan_id",csv:"plan_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan:{description:"The plan granting this feature. Populated only when the association is explicitly loaded.","x-go-type":"planv1beta3.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta3/plan",name:"planv1beta3"},"x-oapi-codegen-extra-tags":{belongs_to:"plans",fk_id:"PlanId",json:"plan,omitempty"},"x-order":3,type:"object",additionalProperties:false,required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},name:{description:"Name of the entitled feature.","x-go-type":"FeatureName","x-oapi-codegen-extra-tags":{db:"name",csv:"name"},"x-order":4,type:"string","x-enum-casing-exempt":true,enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign","BlowhornProfiles","BlowhornBrowserAutomation","BlowhornScheduler","BlowhornDevicesPerSeat","BlowhornPlatformLinkedIn","BlowhornPlatformX","BlowhornPlatformReddit","BlowhornPlatformHackerNews","BlowhornPlatformSlack","BlowhornPlatformBluesky","BlowhornPlatformGitHub","BlowhornPlatformBlog"],"x-enumDescriptions":{ComponentsInDesign:"Maximum number of components in a single design; 999999999999 is unlimited.",RelationshipsInDesign:"Maximum number of relationships in a single design; 999999999999 is unlimited.",DesignsInWorkspace:"Maximum number of designs in a single workspace; 999999999999 is unlimited.",WorkspacesInOrganization:"Maximum number of workspaces in an organization; 999999999999 is unlimited.",ImageSizeInDesign:"Maximum size, in bytes, of an image embedded in a design; 999999999999 is unlimited.",SizePerDesign:"Maximum size of a single design; 999999999999 is unlimited.",BlowhornProfiles:"Maximum number of Blowhorn posting profiles the organization may hold; 999999999999 is unlimited.",BlowhornBrowserAutomation:"Blowhorn may publish through browser automation; granted when quantity is greater than 0.",BlowhornScheduler:"Blowhorn may run scheduled publishes; granted when quantity is greater than 0.",BlowhornDevicesPerSeat:"Maximum number of devices one Blowhorn seat may publish from; 999999999999 is unlimited.",BlowhornPlatformLinkedIn:"Blowhorn may publish to LinkedIn; granted when quantity is greater than 0.",BlowhornPlatformX:"Blowhorn may publish to X; granted when quantity is greater than 0.",BlowhornPlatformReddit:"Blowhorn may publish to Reddit; granted when quantity is greater than 0.",BlowhornPlatformHackerNews:"Blowhorn may publish to Hacker News; granted when quantity is greater than 0.",BlowhornPlatformSlack:"Blowhorn may publish to Slack; granted when quantity is greater than 0.",BlowhornPlatformBluesky:"Blowhorn may publish to Bluesky; granted when quantity is greater than 0.",BlowhornPlatformGitHub:"Blowhorn may publish to GitHub; granted when quantity is greater than 0.",BlowhornPlatformBlog:"Blowhorn may publish to a blog; granted when quantity is greater than 0."}},quantity:{type:"number",format:"double",description:"Quantity of the feature granted by the plan. For a cap-style feature this is the maximum, and the sentinel value 999999999999 denotes unlimited. For a capability-style feature any value greater than 0 grants the capability.",minimum:0,"x-oapi-codegen-extra-tags":{db:"quantity",csv:"quantity"},"x-order":5},created_at:{"x-order":6,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":7,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}}},deviceUsage:{type:"object",description:"Registered devices (live `desktop` connections) in the organization against the organization's device limit. Registrations over the limit are accepted; `overLimit` flags the organization instead.\n",additionalProperties:false,required:["registered","overLimit"],properties:{registered:{type:"integer",minimum:0,description:"Live `desktop` connections registered in the organization."},limit:{type:"integer",minimum:0,description:"Devices the organization's subscriptions allow. Absent when unlimited or when no subscription sets a device limit."},overLimit:{type:"boolean",description:"True when `limit` is present and `registered` exceeds it."}}}}},extensions:{type:"object",description:"Extension points; shape owned by the provider.",additionalProperties:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true},capabilities:{type:"array",description:"Features the provider serves and their endpoints. Clients read paths from here instead of hard-coding them. A provider serving desktop connections lists `register-connection`, `connection-heartbeat` and `deregister-desktop-connection`; an endpoint may hold `{connectionId}` or `{machineId}` placeholders.\n",items:{type:"object",description:"One feature the provider serves and the endpoint that serves it.",additionalProperties:false,required:["feature"],properties:{feature:{type:"string",description:"Feature name, for example `persist-connection`.",maxLength:255},endpoint:{type:"string",description:"Path that serves the feature, relative to the provider's base URL.",maxLength:1024}}}},restrictedAccess:{type:"object",description:"Access restrictions applied to this client; shape owned by the provider.",additionalProperties:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}}},components:{securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},responses:{500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}},ClientUpgradeRequired:{description:`The client's version is below the provider's minimum for that client. The client must update before it can register or keep a connection alive; the body names the minimum and where to get an update.
|
|
32
|
+
`,minLength:1,maxLength:64,pattern:"^[a-z0-9][a-z0-9-]*$"},clientVersion:{type:"string",description:"The client's version as it reported it, as `MAJOR.MINOR.PATCH` with an optional leading `v`, for example `v1.25.0`. Versions are ordered by their numeric parts, so `v1.9.0` is older than `v1.25.0`.",maxLength:64},minimumVersion:{type:"string",description:"Oldest client version the provider accepts for this client. Absent when the provider sets no minimum.",maxLength:64},compatible:{type:"boolean",description:"True when `clientVersion` is at or above `minimumVersion`, or when there is no minimum."},upgradeUrl:{type:"string",description:"Where the client can get an update, when the provider knows one.",maxLength:2048}}},session:{type:"object",description:"The authenticated caller's session as the provider sees it: who the caller is, the caller's roles, and, for the organization named by `X-Current-Orgid` when the caller is a live member of it, that organization's roles, plan, entitlements and device usage. Present only on an authenticated request.\n",additionalProperties:false,required:["userId","providerRoles"],properties:{userId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},providerRoles:{type:"array",description:"The caller's provider-wide role names.",items:{type:"string",maxLength:255}},organizationRoles:{type:"array",description:"The caller's role names in the organization.",items:{type:"string",maxLength:255}},plan:{description:"The plan of the organization's active subscription, when it has one.","x-go-type":"planv1beta3.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta3/plan",name:"planv1beta3"},type:"object",additionalProperties:false,required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},entitlements:{type:"array",description:"The features the organization's active subscriptions entitle it to.",items:{"x-go-type":"featurev1beta1.Feature","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/feature",name:"featurev1beta1"},type:"object",additionalProperties:false,description:"A feature is a quantified entitlement granted to an organization through its subscription plan, such as the number of components allowed in a design.",required:["id","plan_id","name","quantity","created_at","updated_at"],properties:{id:{description:"Unique identifier for the feature.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",csv:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan_id:{description:"Identifier of the plan granting this feature.","x-go-name":"PlanId","x-oapi-codegen-extra-tags":{db:"plan_id",csv:"plan_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan:{description:"The plan granting this feature. Populated only when the association is explicitly loaded.","x-go-type":"planv1beta3.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta3/plan",name:"planv1beta3"},"x-oapi-codegen-extra-tags":{belongs_to:"plans",fk_id:"PlanId",json:"plan,omitempty"},"x-order":3,type:"object",additionalProperties:false,required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},name:{description:"Name of the entitled feature.","x-go-type":"FeatureName","x-oapi-codegen-extra-tags":{db:"name",csv:"name"},"x-order":4,type:"string","x-enum-casing-exempt":true,enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign","BlowhornProfiles","BlowhornBrowserAutomation","BlowhornScheduler","BlowhornDevicesPerSeat","BlowhornPlatformLinkedIn","BlowhornPlatformX","BlowhornPlatformReddit","BlowhornPlatformHackerNews","BlowhornPlatformSlack","BlowhornPlatformBluesky","BlowhornPlatformGitHub","BlowhornPlatformBlog"],"x-enumDescriptions":{ComponentsInDesign:"Maximum number of components in a single design; 999999999999 is unlimited.",RelationshipsInDesign:"Maximum number of relationships in a single design; 999999999999 is unlimited.",DesignsInWorkspace:"Maximum number of designs in a single workspace; 999999999999 is unlimited.",WorkspacesInOrganization:"Maximum number of workspaces in an organization; 999999999999 is unlimited.",ImageSizeInDesign:"Maximum size, in bytes, of an image embedded in a design; 999999999999 is unlimited.",SizePerDesign:"Maximum size of a single design; 999999999999 is unlimited.",BlowhornProfiles:"Maximum number of Blowhorn posting profiles the organization may hold; 999999999999 is unlimited.",BlowhornBrowserAutomation:"Blowhorn may publish through browser automation; granted when quantity is greater than 0.",BlowhornScheduler:"Blowhorn may run scheduled publishes; granted when quantity is greater than 0.",BlowhornDevicesPerSeat:"Maximum number of devices one Blowhorn seat may publish from; 999999999999 is unlimited.",BlowhornPlatformLinkedIn:"Blowhorn may publish to LinkedIn; granted when quantity is greater than 0.",BlowhornPlatformX:"Blowhorn may publish to X; granted when quantity is greater than 0.",BlowhornPlatformReddit:"Blowhorn may publish to Reddit; granted when quantity is greater than 0.",BlowhornPlatformHackerNews:"Blowhorn may publish to Hacker News; granted when quantity is greater than 0.",BlowhornPlatformSlack:"Blowhorn may publish to Slack; granted when quantity is greater than 0.",BlowhornPlatformBluesky:"Blowhorn may publish to Bluesky; granted when quantity is greater than 0.",BlowhornPlatformGitHub:"Blowhorn may publish to GitHub; granted when quantity is greater than 0.",BlowhornPlatformBlog:"Blowhorn may publish to a blog; granted when quantity is greater than 0."}},quantity:{type:"number",format:"double",description:"Quantity of the feature granted by the plan. For a cap-style feature this is the maximum, and the sentinel value 999999999999 denotes unlimited. For a capability-style feature any value greater than 0 grants the capability.",minimum:0,"x-oapi-codegen-extra-tags":{db:"quantity",csv:"quantity"},"x-order":5},created_at:{"x-order":6,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":7,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}}},deviceUsage:{type:"object",description:"Registered devices (live `desktop` connections) in the organization against the organization's device limit. Registrations over the limit are accepted; `overLimit` flags the organization instead.\n",additionalProperties:false,required:["registered","overLimit"],properties:{registered:{type:"integer",minimum:0,description:"Live `desktop` connections registered in the organization."},limit:{type:"integer",minimum:0,description:"Devices the organization's subscriptions allow. Absent when unlimited or when no subscription sets a device limit."},overLimit:{type:"boolean",description:"True when `limit` is present and `registered` exceeds it."}}}}},extensions:{type:"object",description:"Extension points; shape owned by the provider.",additionalProperties:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true},capabilities:{type:"array",description:"Features the provider serves and their endpoints. Clients read paths from here instead of hard-coding them. A provider serving desktop connections lists `register-connection`, `connection-heartbeat` and `deregister-desktop-connection`; an endpoint may hold `{connectionId}` or `{installationId}` placeholders.\n",items:{type:"object",description:"One feature the provider serves and the endpoint that serves it.",additionalProperties:false,required:["feature"],properties:{feature:{type:"string",description:"Feature name, for example `persist-connection`.",maxLength:255},endpoint:{type:"string",description:"Path that serves the feature, relative to the provider's base URL.",maxLength:1024}}}},restrictedAccess:{type:"object",description:"Access restrictions applied to this client; shape owned by the provider.",additionalProperties:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}}},components:{securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},responses:{500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}},ClientUpgradeRequired:{description:`The client's version is below the provider's minimum for that client. The client must update before it can register or keep a connection alive; the body names the minimum and where to get an update.
|
|
33
33
|
`,content:{"application/json":{schema:{type:"object",description:`Body of a 426 answer: a MeshKit error sentence plus the client's compatibility, so the client can show the minimum and where to update.
|
|
34
34
|
`,additionalProperties:false,required:["error","compatibility"],properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code allocated by the emitting service; not a stable part of this contract."},compatibility:{type:"object",description:"Whether a client application's version meets the provider's minimum for that client. A client whose `compatible` is false must update before it registers or keeps a connection alive; the provider answers those calls with 426. A client the provider has no minimum for is compatible and has no `minimumVersion`.\n",additionalProperties:false,required:["clientName","clientVersion","compatible"],properties:{clientName:{type:"string",description:`Identifier of a client application, for example the product name of a desktop app, lowercase. It is a value chosen by the client; the provider keys its minimum client versions by it.
|
|
35
35
|
`,minLength:1,maxLength:64,pattern:"^[a-z0-9][a-z0-9-]*$"},clientVersion:{type:"string",description:"The client's version as it reported it, as `MAJOR.MINOR.PATCH` with an optional leading `v`, for example `v1.25.0`. Versions are ordered by their numeric parts, so `v1.9.0` is older than `v1.25.0`.",maxLength:64},minimumVersion:{type:"string",description:"Oldest client version the provider accepts for this client. Absent when the provider sets no minimum.",maxLength:64},compatible:{type:"boolean",description:"True when `clientVersion` is at or above `minimumVersion`, or when there is no minimum."},upgradeUrl:{type:"string",description:"Where the client can get an update, when the provider knows one.",maxLength:2048}}}}}}}}},parameters:{version:{name:"version",in:"path",description:"Version of the requesting client, for example `v0.8.0`.",required:true,schema:{type:"string",maxLength:64}},client:{name:"client",in:"query",description:"Identifier of the requesting client application, for example the product name of a desktop app. When present, the document carries `compatibility` for this client at the `{version}` path parameter.\n",required:false,schema:{type:"string",description:`Identifier of a client application, for example the product name of a desktop app, lowercase. It is a value chosen by the client; the provider keys its minimum client versions by it.
|
|
@@ -41,7 +41,7 @@ it, which a client treats as not serving the contract.
|
|
|
41
41
|
named by \`X-Current-Orgid\`. Present only on an authenticated request
|
|
42
42
|
that carried that header.
|
|
43
43
|
`,additionalProperties:false,required:["organizationId","bound"],properties:{organizationId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},bound:{type:"boolean",description:"True when the caller is a live member of the organization."}}},compatibility:{type:"object",description:"Whether a client application's version meets the provider's minimum for that client. A client whose `compatible` is false must update before it registers or keeps a connection alive; the provider answers those calls with 426. A client the provider has no minimum for is compatible and has no `minimumVersion`.\n",additionalProperties:false,required:["clientName","clientVersion","compatible"],properties:{clientName:{type:"string",description:`Identifier of a client application, for example the product name of a desktop app, lowercase. It is a value chosen by the client; the provider keys its minimum client versions by it.
|
|
44
|
-
`,minLength:1,maxLength:64,pattern:"^[a-z0-9][a-z0-9-]*$"},clientVersion:{type:"string",description:"The client's version as it reported it, as `MAJOR.MINOR.PATCH` with an optional leading `v`, for example `v1.25.0`. Versions are ordered by their numeric parts, so `v1.9.0` is older than `v1.25.0`.",maxLength:64},minimumVersion:{type:"string",description:"Oldest client version the provider accepts for this client. Absent when the provider sets no minimum.",maxLength:64},compatible:{type:"boolean",description:"True when `clientVersion` is at or above `minimumVersion`, or when there is no minimum."},upgradeUrl:{type:"string",description:"Where the client can get an update, when the provider knows one.",maxLength:2048}}},session:{type:"object",description:"The authenticated caller's session as the provider sees it: who the caller is, the caller's roles, and, for the organization named by `X-Current-Orgid` when the caller is a live member of it, that organization's roles, plan, entitlements and device usage. Present only on an authenticated request.\n",additionalProperties:false,required:["userId","providerRoles"],properties:{userId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},providerRoles:{type:"array",description:"The caller's provider-wide role names.",items:{type:"string",maxLength:255}},organizationRoles:{type:"array",description:"The caller's role names in the organization.",items:{type:"string",maxLength:255}},plan:{description:"The plan of the organization's active subscription, when it has one.","x-go-type":"planv1beta3.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta3/plan",name:"planv1beta3"},type:"object",additionalProperties:false,required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},entitlements:{type:"array",description:"The features the organization's active subscriptions entitle it to.",items:{"x-go-type":"featurev1beta1.Feature","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/feature",name:"featurev1beta1"},type:"object",additionalProperties:false,description:"A feature is a quantified entitlement granted to an organization through its subscription plan, such as the number of components allowed in a design.",required:["id","plan_id","name","quantity","created_at","updated_at"],properties:{id:{description:"Unique identifier for the feature.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",csv:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan_id:{description:"Identifier of the plan granting this feature.","x-go-name":"PlanId","x-oapi-codegen-extra-tags":{db:"plan_id",csv:"plan_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan:{description:"The plan granting this feature. Populated only when the association is explicitly loaded.","x-go-type":"planv1beta3.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta3/plan",name:"planv1beta3"},"x-oapi-codegen-extra-tags":{belongs_to:"plans",fk_id:"PlanId",json:"plan,omitempty"},"x-order":3,type:"object",additionalProperties:false,required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},name:{description:"Name of the entitled feature.","x-go-type":"FeatureName","x-oapi-codegen-extra-tags":{db:"name",csv:"name"},"x-order":4,type:"string","x-enum-casing-exempt":true,enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign","BlowhornProfiles","BlowhornBrowserAutomation","BlowhornScheduler","BlowhornDevicesPerSeat","BlowhornPlatformLinkedIn","BlowhornPlatformX","BlowhornPlatformReddit","BlowhornPlatformHackerNews","BlowhornPlatformSlack","BlowhornPlatformBluesky","BlowhornPlatformGitHub","BlowhornPlatformBlog"],"x-enumDescriptions":{ComponentsInDesign:"Maximum number of components in a single design; 999999999999 is unlimited.",RelationshipsInDesign:"Maximum number of relationships in a single design; 999999999999 is unlimited.",DesignsInWorkspace:"Maximum number of designs in a single workspace; 999999999999 is unlimited.",WorkspacesInOrganization:"Maximum number of workspaces in an organization; 999999999999 is unlimited.",ImageSizeInDesign:"Maximum size, in bytes, of an image embedded in a design; 999999999999 is unlimited.",SizePerDesign:"Maximum size of a single design; 999999999999 is unlimited.",BlowhornProfiles:"Maximum number of Blowhorn posting profiles the organization may hold; 999999999999 is unlimited.",BlowhornBrowserAutomation:"Blowhorn may publish through browser automation; granted when quantity is greater than 0.",BlowhornScheduler:"Blowhorn may run scheduled publishes; granted when quantity is greater than 0.",BlowhornDevicesPerSeat:"Maximum number of devices one Blowhorn seat may publish from; 999999999999 is unlimited.",BlowhornPlatformLinkedIn:"Blowhorn may publish to LinkedIn; granted when quantity is greater than 0.",BlowhornPlatformX:"Blowhorn may publish to X; granted when quantity is greater than 0.",BlowhornPlatformReddit:"Blowhorn may publish to Reddit; granted when quantity is greater than 0.",BlowhornPlatformHackerNews:"Blowhorn may publish to Hacker News; granted when quantity is greater than 0.",BlowhornPlatformSlack:"Blowhorn may publish to Slack; granted when quantity is greater than 0.",BlowhornPlatformBluesky:"Blowhorn may publish to Bluesky; granted when quantity is greater than 0.",BlowhornPlatformGitHub:"Blowhorn may publish to GitHub; granted when quantity is greater than 0.",BlowhornPlatformBlog:"Blowhorn may publish to a blog; granted when quantity is greater than 0."}},quantity:{type:"number",format:"double",description:"Quantity of the feature granted by the plan. For a cap-style feature this is the maximum, and the sentinel value 999999999999 denotes unlimited. For a capability-style feature any value greater than 0 grants the capability.",minimum:0,"x-oapi-codegen-extra-tags":{db:"quantity",csv:"quantity"},"x-order":5},created_at:{"x-order":6,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":7,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}}},deviceUsage:{type:"object",description:"Registered devices (live `desktop` connections) in the organization against the organization's device limit. Registrations over the limit are accepted; `overLimit` flags the organization instead.\n",additionalProperties:false,required:["registered","overLimit"],properties:{registered:{type:"integer",minimum:0,description:"Live `desktop` connections registered in the organization."},limit:{type:"integer",minimum:0,description:"Devices the organization's subscriptions allow. Absent when unlimited or when no subscription sets a device limit."},overLimit:{type:"boolean",description:"True when `limit` is present and `registered` exceeds it."}}}}},extensions:{type:"object",description:"Extension points; shape owned by the provider.",additionalProperties:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true},capabilities:{type:"array",description:"Features the provider serves and their endpoints. Clients read paths from here instead of hard-coding them. A provider serving desktop connections lists `register-connection`, `connection-heartbeat` and `deregister-desktop-connection`; an endpoint may hold `{connectionId}` or `{machineId}` placeholders.\n",items:{type:"object",description:"One feature the provider serves and the endpoint that serves it.",additionalProperties:false,required:["feature"],properties:{feature:{type:"string",description:"Feature name, for example `persist-connection`.",maxLength:255},endpoint:{type:"string",description:"Path that serves the feature, relative to the provider's base URL.",maxLength:1024}}}},restrictedAccess:{type:"object",description:"Access restrictions applied to this client; shape owned by the provider.",additionalProperties:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true}}},ProviderFeature:{type:"object",description:"One feature the provider serves and the endpoint that serves it.",additionalProperties:false,required:["feature"],properties:{feature:{type:"string",description:"Feature name, for example `persist-connection`.",maxLength:255},endpoint:{type:"string",description:"Path that serves the feature, relative to the provider's base URL.",maxLength:1024}}},ProviderMembership:{type:"object",description:`Whether the authenticated caller is a live member of the organization
|
|
44
|
+
`,minLength:1,maxLength:64,pattern:"^[a-z0-9][a-z0-9-]*$"},clientVersion:{type:"string",description:"The client's version as it reported it, as `MAJOR.MINOR.PATCH` with an optional leading `v`, for example `v1.25.0`. Versions are ordered by their numeric parts, so `v1.9.0` is older than `v1.25.0`.",maxLength:64},minimumVersion:{type:"string",description:"Oldest client version the provider accepts for this client. Absent when the provider sets no minimum.",maxLength:64},compatible:{type:"boolean",description:"True when `clientVersion` is at or above `minimumVersion`, or when there is no minimum."},upgradeUrl:{type:"string",description:"Where the client can get an update, when the provider knows one.",maxLength:2048}}},session:{type:"object",description:"The authenticated caller's session as the provider sees it: who the caller is, the caller's roles, and, for the organization named by `X-Current-Orgid` when the caller is a live member of it, that organization's roles, plan, entitlements and device usage. Present only on an authenticated request.\n",additionalProperties:false,required:["userId","providerRoles"],properties:{userId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},providerRoles:{type:"array",description:"The caller's provider-wide role names.",items:{type:"string",maxLength:255}},organizationRoles:{type:"array",description:"The caller's role names in the organization.",items:{type:"string",maxLength:255}},plan:{description:"The plan of the organization's active subscription, when it has one.","x-go-type":"planv1beta3.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta3/plan",name:"planv1beta3"},type:"object",additionalProperties:false,required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},entitlements:{type:"array",description:"The features the organization's active subscriptions entitle it to.",items:{"x-go-type":"featurev1beta1.Feature","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/feature",name:"featurev1beta1"},type:"object",additionalProperties:false,description:"A feature is a quantified entitlement granted to an organization through its subscription plan, such as the number of components allowed in a design.",required:["id","plan_id","name","quantity","created_at","updated_at"],properties:{id:{description:"Unique identifier for the feature.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",csv:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan_id:{description:"Identifier of the plan granting this feature.","x-go-name":"PlanId","x-oapi-codegen-extra-tags":{db:"plan_id",csv:"plan_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan:{description:"The plan granting this feature. Populated only when the association is explicitly loaded.","x-go-type":"planv1beta3.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta3/plan",name:"planv1beta3"},"x-oapi-codegen-extra-tags":{belongs_to:"plans",fk_id:"PlanId",json:"plan,omitempty"},"x-order":3,type:"object",additionalProperties:false,required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},name:{description:"Name of the entitled feature.","x-go-type":"FeatureName","x-oapi-codegen-extra-tags":{db:"name",csv:"name"},"x-order":4,type:"string","x-enum-casing-exempt":true,enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign","BlowhornProfiles","BlowhornBrowserAutomation","BlowhornScheduler","BlowhornDevicesPerSeat","BlowhornPlatformLinkedIn","BlowhornPlatformX","BlowhornPlatformReddit","BlowhornPlatformHackerNews","BlowhornPlatformSlack","BlowhornPlatformBluesky","BlowhornPlatformGitHub","BlowhornPlatformBlog"],"x-enumDescriptions":{ComponentsInDesign:"Maximum number of components in a single design; 999999999999 is unlimited.",RelationshipsInDesign:"Maximum number of relationships in a single design; 999999999999 is unlimited.",DesignsInWorkspace:"Maximum number of designs in a single workspace; 999999999999 is unlimited.",WorkspacesInOrganization:"Maximum number of workspaces in an organization; 999999999999 is unlimited.",ImageSizeInDesign:"Maximum size, in bytes, of an image embedded in a design; 999999999999 is unlimited.",SizePerDesign:"Maximum size of a single design; 999999999999 is unlimited.",BlowhornProfiles:"Maximum number of Blowhorn posting profiles the organization may hold; 999999999999 is unlimited.",BlowhornBrowserAutomation:"Blowhorn may publish through browser automation; granted when quantity is greater than 0.",BlowhornScheduler:"Blowhorn may run scheduled publishes; granted when quantity is greater than 0.",BlowhornDevicesPerSeat:"Maximum number of devices one Blowhorn seat may publish from; 999999999999 is unlimited.",BlowhornPlatformLinkedIn:"Blowhorn may publish to LinkedIn; granted when quantity is greater than 0.",BlowhornPlatformX:"Blowhorn may publish to X; granted when quantity is greater than 0.",BlowhornPlatformReddit:"Blowhorn may publish to Reddit; granted when quantity is greater than 0.",BlowhornPlatformHackerNews:"Blowhorn may publish to Hacker News; granted when quantity is greater than 0.",BlowhornPlatformSlack:"Blowhorn may publish to Slack; granted when quantity is greater than 0.",BlowhornPlatformBluesky:"Blowhorn may publish to Bluesky; granted when quantity is greater than 0.",BlowhornPlatformGitHub:"Blowhorn may publish to GitHub; granted when quantity is greater than 0.",BlowhornPlatformBlog:"Blowhorn may publish to a blog; granted when quantity is greater than 0."}},quantity:{type:"number",format:"double",description:"Quantity of the feature granted by the plan. For a cap-style feature this is the maximum, and the sentinel value 999999999999 denotes unlimited. For a capability-style feature any value greater than 0 grants the capability.",minimum:0,"x-oapi-codegen-extra-tags":{db:"quantity",csv:"quantity"},"x-order":5},created_at:{"x-order":6,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":7,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}}},deviceUsage:{type:"object",description:"Registered devices (live `desktop` connections) in the organization against the organization's device limit. Registrations over the limit are accepted; `overLimit` flags the organization instead.\n",additionalProperties:false,required:["registered","overLimit"],properties:{registered:{type:"integer",minimum:0,description:"Live `desktop` connections registered in the organization."},limit:{type:"integer",minimum:0,description:"Devices the organization's subscriptions allow. Absent when unlimited or when no subscription sets a device limit."},overLimit:{type:"boolean",description:"True when `limit` is present and `registered` exceeds it."}}}}},extensions:{type:"object",description:"Extension points; shape owned by the provider.",additionalProperties:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true},capabilities:{type:"array",description:"Features the provider serves and their endpoints. Clients read paths from here instead of hard-coding them. A provider serving desktop connections lists `register-connection`, `connection-heartbeat` and `deregister-desktop-connection`; an endpoint may hold `{connectionId}` or `{installationId}` placeholders.\n",items:{type:"object",description:"One feature the provider serves and the endpoint that serves it.",additionalProperties:false,required:["feature"],properties:{feature:{type:"string",description:"Feature name, for example `persist-connection`.",maxLength:255},endpoint:{type:"string",description:"Path that serves the feature, relative to the provider's base URL.",maxLength:1024}}}},restrictedAccess:{type:"object",description:"Access restrictions applied to this client; shape owned by the provider.",additionalProperties:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true}}},ProviderFeature:{type:"object",description:"One feature the provider serves and the endpoint that serves it.",additionalProperties:false,required:["feature"],properties:{feature:{type:"string",description:"Feature name, for example `persist-connection`.",maxLength:255},endpoint:{type:"string",description:"Path that serves the feature, relative to the provider's base URL.",maxLength:1024}}},ProviderMembership:{type:"object",description:`Whether the authenticated caller is a live member of the organization
|
|
45
45
|
named by \`X-Current-Orgid\`. Present only on an authenticated request
|
|
46
46
|
that carried that header.
|
|
47
47
|
`,additionalProperties:false,required:["organizationId","bound"],properties:{organizationId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},bound:{type:"boolean",description:"True when the caller is a live member of the organization."}}},ClientName:{type:"string",description:`Identifier of a client application, for example the product name of a desktop app, lowercase. It is a value chosen by the client; the provider keys its minimum client versions by it.
|
|
@@ -29,7 +29,7 @@ it, which a client treats as not serving the contract.
|
|
|
29
29
|
named by \`X-Current-Orgid\`. Present only on an authenticated request
|
|
30
30
|
that carried that header.
|
|
31
31
|
`,additionalProperties:false,required:["organizationId","bound"],properties:{organizationId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},bound:{type:"boolean",description:"True when the caller is a live member of the organization."}}},compatibility:{type:"object",description:"Whether a client application's version meets the provider's minimum for that client. A client whose `compatible` is false must update before it registers or keeps a connection alive; the provider answers those calls with 426. A client the provider has no minimum for is compatible and has no `minimumVersion`.\n",additionalProperties:false,required:["clientName","clientVersion","compatible"],properties:{clientName:{type:"string",description:`Identifier of a client application, for example the product name of a desktop app, lowercase. It is a value chosen by the client; the provider keys its minimum client versions by it.
|
|
32
|
-
`,minLength:1,maxLength:64,pattern:"^[a-z0-9][a-z0-9-]*$"},clientVersion:{type:"string",description:"The client's version as it reported it, as `MAJOR.MINOR.PATCH` with an optional leading `v`, for example `v1.25.0`. Versions are ordered by their numeric parts, so `v1.9.0` is older than `v1.25.0`.",maxLength:64},minimumVersion:{type:"string",description:"Oldest client version the provider accepts for this client. Absent when the provider sets no minimum.",maxLength:64},compatible:{type:"boolean",description:"True when `clientVersion` is at or above `minimumVersion`, or when there is no minimum."},upgradeUrl:{type:"string",description:"Where the client can get an update, when the provider knows one.",maxLength:2048}}},session:{type:"object",description:"The authenticated caller's session as the provider sees it: who the caller is, the caller's roles, and, for the organization named by `X-Current-Orgid` when the caller is a live member of it, that organization's roles, plan, entitlements and device usage. Present only on an authenticated request.\n",additionalProperties:false,required:["userId","providerRoles"],properties:{userId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},providerRoles:{type:"array",description:"The caller's provider-wide role names.",items:{type:"string",maxLength:255}},organizationRoles:{type:"array",description:"The caller's role names in the organization.",items:{type:"string",maxLength:255}},plan:{description:"The plan of the organization's active subscription, when it has one.","x-go-type":"planv1beta3.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta3/plan",name:"planv1beta3"},type:"object",additionalProperties:false,required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},entitlements:{type:"array",description:"The features the organization's active subscriptions entitle it to.",items:{"x-go-type":"featurev1beta1.Feature","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/feature",name:"featurev1beta1"},type:"object",additionalProperties:false,description:"A feature is a quantified entitlement granted to an organization through its subscription plan, such as the number of components allowed in a design.",required:["id","plan_id","name","quantity","created_at","updated_at"],properties:{id:{description:"Unique identifier for the feature.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",csv:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan_id:{description:"Identifier of the plan granting this feature.","x-go-name":"PlanId","x-oapi-codegen-extra-tags":{db:"plan_id",csv:"plan_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan:{description:"The plan granting this feature. Populated only when the association is explicitly loaded.","x-go-type":"planv1beta3.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta3/plan",name:"planv1beta3"},"x-oapi-codegen-extra-tags":{belongs_to:"plans",fk_id:"PlanId",json:"plan,omitempty"},"x-order":3,type:"object",additionalProperties:false,required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},name:{description:"Name of the entitled feature.","x-go-type":"FeatureName","x-oapi-codegen-extra-tags":{db:"name",csv:"name"},"x-order":4,type:"string","x-enum-casing-exempt":true,enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign","BlowhornProfiles","BlowhornBrowserAutomation","BlowhornScheduler","BlowhornDevicesPerSeat","BlowhornPlatformLinkedIn","BlowhornPlatformX","BlowhornPlatformReddit","BlowhornPlatformHackerNews","BlowhornPlatformSlack","BlowhornPlatformBluesky","BlowhornPlatformGitHub","BlowhornPlatformBlog"],"x-enumDescriptions":{ComponentsInDesign:"Maximum number of components in a single design; 999999999999 is unlimited.",RelationshipsInDesign:"Maximum number of relationships in a single design; 999999999999 is unlimited.",DesignsInWorkspace:"Maximum number of designs in a single workspace; 999999999999 is unlimited.",WorkspacesInOrganization:"Maximum number of workspaces in an organization; 999999999999 is unlimited.",ImageSizeInDesign:"Maximum size, in bytes, of an image embedded in a design; 999999999999 is unlimited.",SizePerDesign:"Maximum size of a single design; 999999999999 is unlimited.",BlowhornProfiles:"Maximum number of Blowhorn posting profiles the organization may hold; 999999999999 is unlimited.",BlowhornBrowserAutomation:"Blowhorn may publish through browser automation; granted when quantity is greater than 0.",BlowhornScheduler:"Blowhorn may run scheduled publishes; granted when quantity is greater than 0.",BlowhornDevicesPerSeat:"Maximum number of devices one Blowhorn seat may publish from; 999999999999 is unlimited.",BlowhornPlatformLinkedIn:"Blowhorn may publish to LinkedIn; granted when quantity is greater than 0.",BlowhornPlatformX:"Blowhorn may publish to X; granted when quantity is greater than 0.",BlowhornPlatformReddit:"Blowhorn may publish to Reddit; granted when quantity is greater than 0.",BlowhornPlatformHackerNews:"Blowhorn may publish to Hacker News; granted when quantity is greater than 0.",BlowhornPlatformSlack:"Blowhorn may publish to Slack; granted when quantity is greater than 0.",BlowhornPlatformBluesky:"Blowhorn may publish to Bluesky; granted when quantity is greater than 0.",BlowhornPlatformGitHub:"Blowhorn may publish to GitHub; granted when quantity is greater than 0.",BlowhornPlatformBlog:"Blowhorn may publish to a blog; granted when quantity is greater than 0."}},quantity:{type:"number",format:"double",description:"Quantity of the feature granted by the plan. For a cap-style feature this is the maximum, and the sentinel value 999999999999 denotes unlimited. For a capability-style feature any value greater than 0 grants the capability.",minimum:0,"x-oapi-codegen-extra-tags":{db:"quantity",csv:"quantity"},"x-order":5},created_at:{"x-order":6,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":7,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}}},deviceUsage:{type:"object",description:"Registered devices (live `desktop` connections) in the organization against the organization's device limit. Registrations over the limit are accepted; `overLimit` flags the organization instead.\n",additionalProperties:false,required:["registered","overLimit"],properties:{registered:{type:"integer",minimum:0,description:"Live `desktop` connections registered in the organization."},limit:{type:"integer",minimum:0,description:"Devices the organization's subscriptions allow. Absent when unlimited or when no subscription sets a device limit."},overLimit:{type:"boolean",description:"True when `limit` is present and `registered` exceeds it."}}}}},extensions:{type:"object",description:"Extension points; shape owned by the provider.",additionalProperties:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true},capabilities:{type:"array",description:"Features the provider serves and their endpoints. Clients read paths from here instead of hard-coding them. A provider serving desktop connections lists `register-connection`, `connection-heartbeat` and `deregister-desktop-connection`; an endpoint may hold `{connectionId}` or `{machineId}` placeholders.\n",items:{type:"object",description:"One feature the provider serves and the endpoint that serves it.",additionalProperties:false,required:["feature"],properties:{feature:{type:"string",description:"Feature name, for example `persist-connection`.",maxLength:255},endpoint:{type:"string",description:"Path that serves the feature, relative to the provider's base URL.",maxLength:1024}}}},restrictedAccess:{type:"object",description:"Access restrictions applied to this client; shape owned by the provider.",additionalProperties:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}}},components:{securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},responses:{500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}},ClientUpgradeRequired:{description:`The client's version is below the provider's minimum for that client. The client must update before it can register or keep a connection alive; the body names the minimum and where to get an update.
|
|
32
|
+
`,minLength:1,maxLength:64,pattern:"^[a-z0-9][a-z0-9-]*$"},clientVersion:{type:"string",description:"The client's version as it reported it, as `MAJOR.MINOR.PATCH` with an optional leading `v`, for example `v1.25.0`. Versions are ordered by their numeric parts, so `v1.9.0` is older than `v1.25.0`.",maxLength:64},minimumVersion:{type:"string",description:"Oldest client version the provider accepts for this client. Absent when the provider sets no minimum.",maxLength:64},compatible:{type:"boolean",description:"True when `clientVersion` is at or above `minimumVersion`, or when there is no minimum."},upgradeUrl:{type:"string",description:"Where the client can get an update, when the provider knows one.",maxLength:2048}}},session:{type:"object",description:"The authenticated caller's session as the provider sees it: who the caller is, the caller's roles, and, for the organization named by `X-Current-Orgid` when the caller is a live member of it, that organization's roles, plan, entitlements and device usage. Present only on an authenticated request.\n",additionalProperties:false,required:["userId","providerRoles"],properties:{userId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},providerRoles:{type:"array",description:"The caller's provider-wide role names.",items:{type:"string",maxLength:255}},organizationRoles:{type:"array",description:"The caller's role names in the organization.",items:{type:"string",maxLength:255}},plan:{description:"The plan of the organization's active subscription, when it has one.","x-go-type":"planv1beta3.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta3/plan",name:"planv1beta3"},type:"object",additionalProperties:false,required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},entitlements:{type:"array",description:"The features the organization's active subscriptions entitle it to.",items:{"x-go-type":"featurev1beta1.Feature","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/feature",name:"featurev1beta1"},type:"object",additionalProperties:false,description:"A feature is a quantified entitlement granted to an organization through its subscription plan, such as the number of components allowed in a design.",required:["id","plan_id","name","quantity","created_at","updated_at"],properties:{id:{description:"Unique identifier for the feature.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",csv:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan_id:{description:"Identifier of the plan granting this feature.","x-go-name":"PlanId","x-oapi-codegen-extra-tags":{db:"plan_id",csv:"plan_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan:{description:"The plan granting this feature. Populated only when the association is explicitly loaded.","x-go-type":"planv1beta3.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta3/plan",name:"planv1beta3"},"x-oapi-codegen-extra-tags":{belongs_to:"plans",fk_id:"PlanId",json:"plan,omitempty"},"x-order":3,type:"object",additionalProperties:false,required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},name:{description:"Name of the entitled feature.","x-go-type":"FeatureName","x-oapi-codegen-extra-tags":{db:"name",csv:"name"},"x-order":4,type:"string","x-enum-casing-exempt":true,enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign","BlowhornProfiles","BlowhornBrowserAutomation","BlowhornScheduler","BlowhornDevicesPerSeat","BlowhornPlatformLinkedIn","BlowhornPlatformX","BlowhornPlatformReddit","BlowhornPlatformHackerNews","BlowhornPlatformSlack","BlowhornPlatformBluesky","BlowhornPlatformGitHub","BlowhornPlatformBlog"],"x-enumDescriptions":{ComponentsInDesign:"Maximum number of components in a single design; 999999999999 is unlimited.",RelationshipsInDesign:"Maximum number of relationships in a single design; 999999999999 is unlimited.",DesignsInWorkspace:"Maximum number of designs in a single workspace; 999999999999 is unlimited.",WorkspacesInOrganization:"Maximum number of workspaces in an organization; 999999999999 is unlimited.",ImageSizeInDesign:"Maximum size, in bytes, of an image embedded in a design; 999999999999 is unlimited.",SizePerDesign:"Maximum size of a single design; 999999999999 is unlimited.",BlowhornProfiles:"Maximum number of Blowhorn posting profiles the organization may hold; 999999999999 is unlimited.",BlowhornBrowserAutomation:"Blowhorn may publish through browser automation; granted when quantity is greater than 0.",BlowhornScheduler:"Blowhorn may run scheduled publishes; granted when quantity is greater than 0.",BlowhornDevicesPerSeat:"Maximum number of devices one Blowhorn seat may publish from; 999999999999 is unlimited.",BlowhornPlatformLinkedIn:"Blowhorn may publish to LinkedIn; granted when quantity is greater than 0.",BlowhornPlatformX:"Blowhorn may publish to X; granted when quantity is greater than 0.",BlowhornPlatformReddit:"Blowhorn may publish to Reddit; granted when quantity is greater than 0.",BlowhornPlatformHackerNews:"Blowhorn may publish to Hacker News; granted when quantity is greater than 0.",BlowhornPlatformSlack:"Blowhorn may publish to Slack; granted when quantity is greater than 0.",BlowhornPlatformBluesky:"Blowhorn may publish to Bluesky; granted when quantity is greater than 0.",BlowhornPlatformGitHub:"Blowhorn may publish to GitHub; granted when quantity is greater than 0.",BlowhornPlatformBlog:"Blowhorn may publish to a blog; granted when quantity is greater than 0."}},quantity:{type:"number",format:"double",description:"Quantity of the feature granted by the plan. For a cap-style feature this is the maximum, and the sentinel value 999999999999 denotes unlimited. For a capability-style feature any value greater than 0 grants the capability.",minimum:0,"x-oapi-codegen-extra-tags":{db:"quantity",csv:"quantity"},"x-order":5},created_at:{"x-order":6,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":7,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}}},deviceUsage:{type:"object",description:"Registered devices (live `desktop` connections) in the organization against the organization's device limit. Registrations over the limit are accepted; `overLimit` flags the organization instead.\n",additionalProperties:false,required:["registered","overLimit"],properties:{registered:{type:"integer",minimum:0,description:"Live `desktop` connections registered in the organization."},limit:{type:"integer",minimum:0,description:"Devices the organization's subscriptions allow. Absent when unlimited or when no subscription sets a device limit."},overLimit:{type:"boolean",description:"True when `limit` is present and `registered` exceeds it."}}}}},extensions:{type:"object",description:"Extension points; shape owned by the provider.",additionalProperties:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true},capabilities:{type:"array",description:"Features the provider serves and their endpoints. Clients read paths from here instead of hard-coding them. A provider serving desktop connections lists `register-connection`, `connection-heartbeat` and `deregister-desktop-connection`; an endpoint may hold `{connectionId}` or `{installationId}` placeholders.\n",items:{type:"object",description:"One feature the provider serves and the endpoint that serves it.",additionalProperties:false,required:["feature"],properties:{feature:{type:"string",description:"Feature name, for example `persist-connection`.",maxLength:255},endpoint:{type:"string",description:"Path that serves the feature, relative to the provider's base URL.",maxLength:1024}}}},restrictedAccess:{type:"object",description:"Access restrictions applied to this client; shape owned by the provider.",additionalProperties:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}}},components:{securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},responses:{500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}},ClientUpgradeRequired:{description:`The client's version is below the provider's minimum for that client. The client must update before it can register or keep a connection alive; the body names the minimum and where to get an update.
|
|
33
33
|
`,content:{"application/json":{schema:{type:"object",description:`Body of a 426 answer: a MeshKit error sentence plus the client's compatibility, so the client can show the minimum and where to update.
|
|
34
34
|
`,additionalProperties:false,required:["error","compatibility"],properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code allocated by the emitting service; not a stable part of this contract."},compatibility:{type:"object",description:"Whether a client application's version meets the provider's minimum for that client. A client whose `compatible` is false must update before it registers or keeps a connection alive; the provider answers those calls with 426. A client the provider has no minimum for is compatible and has no `minimumVersion`.\n",additionalProperties:false,required:["clientName","clientVersion","compatible"],properties:{clientName:{type:"string",description:`Identifier of a client application, for example the product name of a desktop app, lowercase. It is a value chosen by the client; the provider keys its minimum client versions by it.
|
|
35
35
|
`,minLength:1,maxLength:64,pattern:"^[a-z0-9][a-z0-9-]*$"},clientVersion:{type:"string",description:"The client's version as it reported it, as `MAJOR.MINOR.PATCH` with an optional leading `v`, for example `v1.25.0`. Versions are ordered by their numeric parts, so `v1.9.0` is older than `v1.25.0`.",maxLength:64},minimumVersion:{type:"string",description:"Oldest client version the provider accepts for this client. Absent when the provider sets no minimum.",maxLength:64},compatible:{type:"boolean",description:"True when `clientVersion` is at or above `minimumVersion`, or when there is no minimum."},upgradeUrl:{type:"string",description:"Where the client can get an update, when the provider knows one.",maxLength:2048}}}}}}}}},parameters:{version:{name:"version",in:"path",description:"Version of the requesting client, for example `v0.8.0`.",required:true,schema:{type:"string",maxLength:64}},client:{name:"client",in:"query",description:"Identifier of the requesting client application, for example the product name of a desktop app. When present, the document carries `compatibility` for this client at the `{version}` path parameter.\n",required:false,schema:{type:"string",description:`Identifier of a client application, for example the product name of a desktop app, lowercase. It is a value chosen by the client; the provider keys its minimum client versions by it.
|
|
@@ -41,7 +41,7 @@ it, which a client treats as not serving the contract.
|
|
|
41
41
|
named by \`X-Current-Orgid\`. Present only on an authenticated request
|
|
42
42
|
that carried that header.
|
|
43
43
|
`,additionalProperties:false,required:["organizationId","bound"],properties:{organizationId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},bound:{type:"boolean",description:"True when the caller is a live member of the organization."}}},compatibility:{type:"object",description:"Whether a client application's version meets the provider's minimum for that client. A client whose `compatible` is false must update before it registers or keeps a connection alive; the provider answers those calls with 426. A client the provider has no minimum for is compatible and has no `minimumVersion`.\n",additionalProperties:false,required:["clientName","clientVersion","compatible"],properties:{clientName:{type:"string",description:`Identifier of a client application, for example the product name of a desktop app, lowercase. It is a value chosen by the client; the provider keys its minimum client versions by it.
|
|
44
|
-
`,minLength:1,maxLength:64,pattern:"^[a-z0-9][a-z0-9-]*$"},clientVersion:{type:"string",description:"The client's version as it reported it, as `MAJOR.MINOR.PATCH` with an optional leading `v`, for example `v1.25.0`. Versions are ordered by their numeric parts, so `v1.9.0` is older than `v1.25.0`.",maxLength:64},minimumVersion:{type:"string",description:"Oldest client version the provider accepts for this client. Absent when the provider sets no minimum.",maxLength:64},compatible:{type:"boolean",description:"True when `clientVersion` is at or above `minimumVersion`, or when there is no minimum."},upgradeUrl:{type:"string",description:"Where the client can get an update, when the provider knows one.",maxLength:2048}}},session:{type:"object",description:"The authenticated caller's session as the provider sees it: who the caller is, the caller's roles, and, for the organization named by `X-Current-Orgid` when the caller is a live member of it, that organization's roles, plan, entitlements and device usage. Present only on an authenticated request.\n",additionalProperties:false,required:["userId","providerRoles"],properties:{userId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},providerRoles:{type:"array",description:"The caller's provider-wide role names.",items:{type:"string",maxLength:255}},organizationRoles:{type:"array",description:"The caller's role names in the organization.",items:{type:"string",maxLength:255}},plan:{description:"The plan of the organization's active subscription, when it has one.","x-go-type":"planv1beta3.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta3/plan",name:"planv1beta3"},type:"object",additionalProperties:false,required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},entitlements:{type:"array",description:"The features the organization's active subscriptions entitle it to.",items:{"x-go-type":"featurev1beta1.Feature","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/feature",name:"featurev1beta1"},type:"object",additionalProperties:false,description:"A feature is a quantified entitlement granted to an organization through its subscription plan, such as the number of components allowed in a design.",required:["id","plan_id","name","quantity","created_at","updated_at"],properties:{id:{description:"Unique identifier for the feature.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",csv:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan_id:{description:"Identifier of the plan granting this feature.","x-go-name":"PlanId","x-oapi-codegen-extra-tags":{db:"plan_id",csv:"plan_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan:{description:"The plan granting this feature. Populated only when the association is explicitly loaded.","x-go-type":"planv1beta3.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta3/plan",name:"planv1beta3"},"x-oapi-codegen-extra-tags":{belongs_to:"plans",fk_id:"PlanId",json:"plan,omitempty"},"x-order":3,type:"object",additionalProperties:false,required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},name:{description:"Name of the entitled feature.","x-go-type":"FeatureName","x-oapi-codegen-extra-tags":{db:"name",csv:"name"},"x-order":4,type:"string","x-enum-casing-exempt":true,enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign","BlowhornProfiles","BlowhornBrowserAutomation","BlowhornScheduler","BlowhornDevicesPerSeat","BlowhornPlatformLinkedIn","BlowhornPlatformX","BlowhornPlatformReddit","BlowhornPlatformHackerNews","BlowhornPlatformSlack","BlowhornPlatformBluesky","BlowhornPlatformGitHub","BlowhornPlatformBlog"],"x-enumDescriptions":{ComponentsInDesign:"Maximum number of components in a single design; 999999999999 is unlimited.",RelationshipsInDesign:"Maximum number of relationships in a single design; 999999999999 is unlimited.",DesignsInWorkspace:"Maximum number of designs in a single workspace; 999999999999 is unlimited.",WorkspacesInOrganization:"Maximum number of workspaces in an organization; 999999999999 is unlimited.",ImageSizeInDesign:"Maximum size, in bytes, of an image embedded in a design; 999999999999 is unlimited.",SizePerDesign:"Maximum size of a single design; 999999999999 is unlimited.",BlowhornProfiles:"Maximum number of Blowhorn posting profiles the organization may hold; 999999999999 is unlimited.",BlowhornBrowserAutomation:"Blowhorn may publish through browser automation; granted when quantity is greater than 0.",BlowhornScheduler:"Blowhorn may run scheduled publishes; granted when quantity is greater than 0.",BlowhornDevicesPerSeat:"Maximum number of devices one Blowhorn seat may publish from; 999999999999 is unlimited.",BlowhornPlatformLinkedIn:"Blowhorn may publish to LinkedIn; granted when quantity is greater than 0.",BlowhornPlatformX:"Blowhorn may publish to X; granted when quantity is greater than 0.",BlowhornPlatformReddit:"Blowhorn may publish to Reddit; granted when quantity is greater than 0.",BlowhornPlatformHackerNews:"Blowhorn may publish to Hacker News; granted when quantity is greater than 0.",BlowhornPlatformSlack:"Blowhorn may publish to Slack; granted when quantity is greater than 0.",BlowhornPlatformBluesky:"Blowhorn may publish to Bluesky; granted when quantity is greater than 0.",BlowhornPlatformGitHub:"Blowhorn may publish to GitHub; granted when quantity is greater than 0.",BlowhornPlatformBlog:"Blowhorn may publish to a blog; granted when quantity is greater than 0."}},quantity:{type:"number",format:"double",description:"Quantity of the feature granted by the plan. For a cap-style feature this is the maximum, and the sentinel value 999999999999 denotes unlimited. For a capability-style feature any value greater than 0 grants the capability.",minimum:0,"x-oapi-codegen-extra-tags":{db:"quantity",csv:"quantity"},"x-order":5},created_at:{"x-order":6,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":7,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}}},deviceUsage:{type:"object",description:"Registered devices (live `desktop` connections) in the organization against the organization's device limit. Registrations over the limit are accepted; `overLimit` flags the organization instead.\n",additionalProperties:false,required:["registered","overLimit"],properties:{registered:{type:"integer",minimum:0,description:"Live `desktop` connections registered in the organization."},limit:{type:"integer",minimum:0,description:"Devices the organization's subscriptions allow. Absent when unlimited or when no subscription sets a device limit."},overLimit:{type:"boolean",description:"True when `limit` is present and `registered` exceeds it."}}}}},extensions:{type:"object",description:"Extension points; shape owned by the provider.",additionalProperties:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true},capabilities:{type:"array",description:"Features the provider serves and their endpoints. Clients read paths from here instead of hard-coding them. A provider serving desktop connections lists `register-connection`, `connection-heartbeat` and `deregister-desktop-connection`; an endpoint may hold `{connectionId}` or `{machineId}` placeholders.\n",items:{type:"object",description:"One feature the provider serves and the endpoint that serves it.",additionalProperties:false,required:["feature"],properties:{feature:{type:"string",description:"Feature name, for example `persist-connection`.",maxLength:255},endpoint:{type:"string",description:"Path that serves the feature, relative to the provider's base URL.",maxLength:1024}}}},restrictedAccess:{type:"object",description:"Access restrictions applied to this client; shape owned by the provider.",additionalProperties:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true}}},ProviderFeature:{type:"object",description:"One feature the provider serves and the endpoint that serves it.",additionalProperties:false,required:["feature"],properties:{feature:{type:"string",description:"Feature name, for example `persist-connection`.",maxLength:255},endpoint:{type:"string",description:"Path that serves the feature, relative to the provider's base URL.",maxLength:1024}}},ProviderMembership:{type:"object",description:`Whether the authenticated caller is a live member of the organization
|
|
44
|
+
`,minLength:1,maxLength:64,pattern:"^[a-z0-9][a-z0-9-]*$"},clientVersion:{type:"string",description:"The client's version as it reported it, as `MAJOR.MINOR.PATCH` with an optional leading `v`, for example `v1.25.0`. Versions are ordered by their numeric parts, so `v1.9.0` is older than `v1.25.0`.",maxLength:64},minimumVersion:{type:"string",description:"Oldest client version the provider accepts for this client. Absent when the provider sets no minimum.",maxLength:64},compatible:{type:"boolean",description:"True when `clientVersion` is at or above `minimumVersion`, or when there is no minimum."},upgradeUrl:{type:"string",description:"Where the client can get an update, when the provider knows one.",maxLength:2048}}},session:{type:"object",description:"The authenticated caller's session as the provider sees it: who the caller is, the caller's roles, and, for the organization named by `X-Current-Orgid` when the caller is a live member of it, that organization's roles, plan, entitlements and device usage. Present only on an authenticated request.\n",additionalProperties:false,required:["userId","providerRoles"],properties:{userId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},providerRoles:{type:"array",description:"The caller's provider-wide role names.",items:{type:"string",maxLength:255}},organizationRoles:{type:"array",description:"The caller's role names in the organization.",items:{type:"string",maxLength:255}},plan:{description:"The plan of the organization's active subscription, when it has one.","x-go-type":"planv1beta3.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta3/plan",name:"planv1beta3"},type:"object",additionalProperties:false,required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},entitlements:{type:"array",description:"The features the organization's active subscriptions entitle it to.",items:{"x-go-type":"featurev1beta1.Feature","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/feature",name:"featurev1beta1"},type:"object",additionalProperties:false,description:"A feature is a quantified entitlement granted to an organization through its subscription plan, such as the number of components allowed in a design.",required:["id","plan_id","name","quantity","created_at","updated_at"],properties:{id:{description:"Unique identifier for the feature.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",csv:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan_id:{description:"Identifier of the plan granting this feature.","x-go-name":"PlanId","x-oapi-codegen-extra-tags":{db:"plan_id",csv:"plan_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan:{description:"The plan granting this feature. Populated only when the association is explicitly loaded.","x-go-type":"planv1beta3.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta3/plan",name:"planv1beta3"},"x-oapi-codegen-extra-tags":{belongs_to:"plans",fk_id:"PlanId",json:"plan,omitempty"},"x-order":3,type:"object",additionalProperties:false,required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},name:{description:"Name of the entitled feature.","x-go-type":"FeatureName","x-oapi-codegen-extra-tags":{db:"name",csv:"name"},"x-order":4,type:"string","x-enum-casing-exempt":true,enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign","BlowhornProfiles","BlowhornBrowserAutomation","BlowhornScheduler","BlowhornDevicesPerSeat","BlowhornPlatformLinkedIn","BlowhornPlatformX","BlowhornPlatformReddit","BlowhornPlatformHackerNews","BlowhornPlatformSlack","BlowhornPlatformBluesky","BlowhornPlatformGitHub","BlowhornPlatformBlog"],"x-enumDescriptions":{ComponentsInDesign:"Maximum number of components in a single design; 999999999999 is unlimited.",RelationshipsInDesign:"Maximum number of relationships in a single design; 999999999999 is unlimited.",DesignsInWorkspace:"Maximum number of designs in a single workspace; 999999999999 is unlimited.",WorkspacesInOrganization:"Maximum number of workspaces in an organization; 999999999999 is unlimited.",ImageSizeInDesign:"Maximum size, in bytes, of an image embedded in a design; 999999999999 is unlimited.",SizePerDesign:"Maximum size of a single design; 999999999999 is unlimited.",BlowhornProfiles:"Maximum number of Blowhorn posting profiles the organization may hold; 999999999999 is unlimited.",BlowhornBrowserAutomation:"Blowhorn may publish through browser automation; granted when quantity is greater than 0.",BlowhornScheduler:"Blowhorn may run scheduled publishes; granted when quantity is greater than 0.",BlowhornDevicesPerSeat:"Maximum number of devices one Blowhorn seat may publish from; 999999999999 is unlimited.",BlowhornPlatformLinkedIn:"Blowhorn may publish to LinkedIn; granted when quantity is greater than 0.",BlowhornPlatformX:"Blowhorn may publish to X; granted when quantity is greater than 0.",BlowhornPlatformReddit:"Blowhorn may publish to Reddit; granted when quantity is greater than 0.",BlowhornPlatformHackerNews:"Blowhorn may publish to Hacker News; granted when quantity is greater than 0.",BlowhornPlatformSlack:"Blowhorn may publish to Slack; granted when quantity is greater than 0.",BlowhornPlatformBluesky:"Blowhorn may publish to Bluesky; granted when quantity is greater than 0.",BlowhornPlatformGitHub:"Blowhorn may publish to GitHub; granted when quantity is greater than 0.",BlowhornPlatformBlog:"Blowhorn may publish to a blog; granted when quantity is greater than 0."}},quantity:{type:"number",format:"double",description:"Quantity of the feature granted by the plan. For a cap-style feature this is the maximum, and the sentinel value 999999999999 denotes unlimited. For a capability-style feature any value greater than 0 grants the capability.",minimum:0,"x-oapi-codegen-extra-tags":{db:"quantity",csv:"quantity"},"x-order":5},created_at:{"x-order":6,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":7,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}}},deviceUsage:{type:"object",description:"Registered devices (live `desktop` connections) in the organization against the organization's device limit. Registrations over the limit are accepted; `overLimit` flags the organization instead.\n",additionalProperties:false,required:["registered","overLimit"],properties:{registered:{type:"integer",minimum:0,description:"Live `desktop` connections registered in the organization."},limit:{type:"integer",minimum:0,description:"Devices the organization's subscriptions allow. Absent when unlimited or when no subscription sets a device limit."},overLimit:{type:"boolean",description:"True when `limit` is present and `registered` exceeds it."}}}}},extensions:{type:"object",description:"Extension points; shape owned by the provider.",additionalProperties:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true},capabilities:{type:"array",description:"Features the provider serves and their endpoints. Clients read paths from here instead of hard-coding them. A provider serving desktop connections lists `register-connection`, `connection-heartbeat` and `deregister-desktop-connection`; an endpoint may hold `{connectionId}` or `{installationId}` placeholders.\n",items:{type:"object",description:"One feature the provider serves and the endpoint that serves it.",additionalProperties:false,required:["feature"],properties:{feature:{type:"string",description:"Feature name, for example `persist-connection`.",maxLength:255},endpoint:{type:"string",description:"Path that serves the feature, relative to the provider's base URL.",maxLength:1024}}}},restrictedAccess:{type:"object",description:"Access restrictions applied to this client; shape owned by the provider.",additionalProperties:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true}}},ProviderFeature:{type:"object",description:"One feature the provider serves and the endpoint that serves it.",additionalProperties:false,required:["feature"],properties:{feature:{type:"string",description:"Feature name, for example `persist-connection`.",maxLength:255},endpoint:{type:"string",description:"Path that serves the feature, relative to the provider's base URL.",maxLength:1024}}},ProviderMembership:{type:"object",description:`Whether the authenticated caller is a live member of the organization
|
|
45
45
|
named by \`X-Current-Orgid\`. Present only on an authenticated request
|
|
46
46
|
that carried that header.
|
|
47
47
|
`,additionalProperties:false,required:["organizationId","bound"],properties:{organizationId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},bound:{type:"boolean",description:"True when the caller is a live member of the organization."}}},ClientName:{type:"string",description:`Identifier of a client application, for example the product name of a desktop app, lowercase. It is a value chosen by the client; the provider keys its minimum client versions by it.
|
package/dist/mesheryApi.d.mts
CHANGED
|
@@ -6676,7 +6676,7 @@ type RegisterRegistryComponentApiArg = {
|
|
|
6676
6676
|
updatedAt?: string;
|
|
6677
6677
|
/** Timestamp when the connection was soft-deleted, if applicable. */
|
|
6678
6678
|
deletedAt?: string | null;
|
|
6679
|
-
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.
|
|
6679
|
+
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.installationId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
|
|
6680
6680
|
*/
|
|
6681
6681
|
organizationId?: string;
|
|
6682
6682
|
/** Associated environments for this connection */
|
|
@@ -7377,7 +7377,7 @@ type RegisterRegistryRelationshipApiArg = {
|
|
|
7377
7377
|
updatedAt?: string;
|
|
7378
7378
|
/** Timestamp when the connection was soft-deleted, if applicable. */
|
|
7379
7379
|
deletedAt?: string | null;
|
|
7380
|
-
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.
|
|
7380
|
+
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.installationId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
|
|
7381
7381
|
*/
|
|
7382
7382
|
organizationId?: string;
|
|
7383
7383
|
/** Associated environments for this connection */
|
|
@@ -10817,7 +10817,7 @@ type GetConnectionsApiResponse = {
|
|
|
10817
10817
|
updatedAt?: string;
|
|
10818
10818
|
/** Timestamp when the connection was soft-deleted, if applicable. */
|
|
10819
10819
|
deletedAt?: string | null;
|
|
10820
|
-
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.
|
|
10820
|
+
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.installationId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
|
|
10821
10821
|
*/
|
|
10822
10822
|
organizationId?: string;
|
|
10823
10823
|
/** Associated environments for this connection */
|
|
@@ -11087,7 +11087,7 @@ type RegisterConnectionApiResponse = {
|
|
|
11087
11087
|
updatedAt?: string;
|
|
11088
11088
|
/** Timestamp when the connection was soft-deleted, if applicable. */
|
|
11089
11089
|
deletedAt?: string | null;
|
|
11090
|
-
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.
|
|
11090
|
+
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.installationId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
|
|
11091
11091
|
*/
|
|
11092
11092
|
organizationId?: string;
|
|
11093
11093
|
/** Associated environments for this connection */
|
|
@@ -11323,7 +11323,7 @@ type RegisterConnectionApiResponse = {
|
|
|
11323
11323
|
updatedAt?: string;
|
|
11324
11324
|
/** Timestamp when the connection was soft-deleted, if applicable. */
|
|
11325
11325
|
deletedAt?: string | null;
|
|
11326
|
-
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.
|
|
11326
|
+
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.installationId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
|
|
11327
11327
|
*/
|
|
11328
11328
|
organizationId?: string;
|
|
11329
11329
|
/** Associated environments for this connection */
|
|
@@ -11761,7 +11761,7 @@ type GetConnectionByIdApiResponse = {
|
|
|
11761
11761
|
updatedAt?: string;
|
|
11762
11762
|
/** Timestamp when the connection was soft-deleted, if applicable. */
|
|
11763
11763
|
deletedAt?: string | null;
|
|
11764
|
-
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.
|
|
11764
|
+
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.installationId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
|
|
11765
11765
|
*/
|
|
11766
11766
|
organizationId?: string;
|
|
11767
11767
|
/** Associated environments for this connection */
|
|
@@ -12002,7 +12002,7 @@ type UpdateConnectionApiResponse = {
|
|
|
12002
12002
|
updatedAt?: string;
|
|
12003
12003
|
/** Timestamp when the connection was soft-deleted, if applicable. */
|
|
12004
12004
|
deletedAt?: string | null;
|
|
12005
|
-
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.
|
|
12005
|
+
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.installationId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
|
|
12006
12006
|
*/
|
|
12007
12007
|
organizationId?: string;
|
|
12008
12008
|
/** Associated environments for this connection */
|
|
@@ -12405,7 +12405,7 @@ type PerformConnectionActionApiResponse =
|
|
|
12405
12405
|
updatedAt?: string;
|
|
12406
12406
|
/** Timestamp when the connection was soft-deleted, if applicable. */
|
|
12407
12407
|
deletedAt?: string | null;
|
|
12408
|
-
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.
|
|
12408
|
+
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.installationId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
|
|
12409
12409
|
*/
|
|
12410
12410
|
organizationId?: string;
|
|
12411
12411
|
/** Associated environments for this connection */
|
package/dist/mesheryApi.d.ts
CHANGED
|
@@ -6676,7 +6676,7 @@ type RegisterRegistryComponentApiArg = {
|
|
|
6676
6676
|
updatedAt?: string;
|
|
6677
6677
|
/** Timestamp when the connection was soft-deleted, if applicable. */
|
|
6678
6678
|
deletedAt?: string | null;
|
|
6679
|
-
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.
|
|
6679
|
+
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.installationId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
|
|
6680
6680
|
*/
|
|
6681
6681
|
organizationId?: string;
|
|
6682
6682
|
/** Associated environments for this connection */
|
|
@@ -7377,7 +7377,7 @@ type RegisterRegistryRelationshipApiArg = {
|
|
|
7377
7377
|
updatedAt?: string;
|
|
7378
7378
|
/** Timestamp when the connection was soft-deleted, if applicable. */
|
|
7379
7379
|
deletedAt?: string | null;
|
|
7380
|
-
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.
|
|
7380
|
+
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.installationId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
|
|
7381
7381
|
*/
|
|
7382
7382
|
organizationId?: string;
|
|
7383
7383
|
/** Associated environments for this connection */
|
|
@@ -10817,7 +10817,7 @@ type GetConnectionsApiResponse = {
|
|
|
10817
10817
|
updatedAt?: string;
|
|
10818
10818
|
/** Timestamp when the connection was soft-deleted, if applicable. */
|
|
10819
10819
|
deletedAt?: string | null;
|
|
10820
|
-
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.
|
|
10820
|
+
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.installationId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
|
|
10821
10821
|
*/
|
|
10822
10822
|
organizationId?: string;
|
|
10823
10823
|
/** Associated environments for this connection */
|
|
@@ -11087,7 +11087,7 @@ type RegisterConnectionApiResponse = {
|
|
|
11087
11087
|
updatedAt?: string;
|
|
11088
11088
|
/** Timestamp when the connection was soft-deleted, if applicable. */
|
|
11089
11089
|
deletedAt?: string | null;
|
|
11090
|
-
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.
|
|
11090
|
+
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.installationId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
|
|
11091
11091
|
*/
|
|
11092
11092
|
organizationId?: string;
|
|
11093
11093
|
/** Associated environments for this connection */
|
|
@@ -11323,7 +11323,7 @@ type RegisterConnectionApiResponse = {
|
|
|
11323
11323
|
updatedAt?: string;
|
|
11324
11324
|
/** Timestamp when the connection was soft-deleted, if applicable. */
|
|
11325
11325
|
deletedAt?: string | null;
|
|
11326
|
-
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.
|
|
11326
|
+
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.installationId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
|
|
11327
11327
|
*/
|
|
11328
11328
|
organizationId?: string;
|
|
11329
11329
|
/** Associated environments for this connection */
|
|
@@ -11761,7 +11761,7 @@ type GetConnectionByIdApiResponse = {
|
|
|
11761
11761
|
updatedAt?: string;
|
|
11762
11762
|
/** Timestamp when the connection was soft-deleted, if applicable. */
|
|
11763
11763
|
deletedAt?: string | null;
|
|
11764
|
-
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.
|
|
11764
|
+
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.installationId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
|
|
11765
11765
|
*/
|
|
11766
11766
|
organizationId?: string;
|
|
11767
11767
|
/** Associated environments for this connection */
|
|
@@ -12002,7 +12002,7 @@ type UpdateConnectionApiResponse = {
|
|
|
12002
12002
|
updatedAt?: string;
|
|
12003
12003
|
/** Timestamp when the connection was soft-deleted, if applicable. */
|
|
12004
12004
|
deletedAt?: string | null;
|
|
12005
|
-
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.
|
|
12005
|
+
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.installationId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
|
|
12006
12006
|
*/
|
|
12007
12007
|
organizationId?: string;
|
|
12008
12008
|
/** Associated environments for this connection */
|
|
@@ -12405,7 +12405,7 @@ type PerformConnectionActionApiResponse =
|
|
|
12405
12405
|
updatedAt?: string;
|
|
12406
12406
|
/** Timestamp when the connection was soft-deleted, if applicable. */
|
|
12407
12407
|
deletedAt?: string | null;
|
|
12408
|
-
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.
|
|
12408
|
+
/** Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.installationId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
|
|
12409
12409
|
*/
|
|
12410
12410
|
organizationId?: string;
|
|
12411
12411
|
/** Associated environments for this connection */
|