@meshery/schemas 1.3.87 → 1.3.89
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 +9634 -6383
- package/dist/cloudApi.d.ts +9634 -6383
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta1/organization_smtp/OrganizationSmtp.d.ts +1 -1
- package/dist/constructs/v1beta1/organization_smtp/OrganizationSmtpSchema.js +1 -1
- package/dist/constructs/v1beta1/organization_smtp/OrganizationSmtpSchema.mjs +1 -1
- package/dist/constructs/v1beta1/registry/Registry.d.ts +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 +83 -16
- package/dist/constructs/v1beta3/connection/ConnectionSchema.js +10 -2
- package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +10 -2
- package/dist/constructs/v1beta3/environment/Environment.d.ts +15 -15
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.js +1 -1
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.mjs +1 -1
- package/dist/constructs/v1beta3/profile/Profile.d.ts +1639 -0
- package/dist/constructs/v1beta3/profile/Profile.js +1 -0
- package/dist/constructs/v1beta3/profile/Profile.mjs +0 -0
- package/dist/constructs/v1beta3/profile/ProfileSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/profile/ProfileSchema.js +22 -0
- package/dist/constructs/v1beta3/profile/ProfileSchema.mjs +22 -0
- package/dist/constructs/v1beta3/provider_capability/ProviderCapability.d.ts +468 -5
- package/dist/constructs/v1beta3/provider_capability/ProviderCapabilitySchema.js +25 -4
- package/dist/constructs/v1beta3/provider_capability/ProviderCapabilitySchema.mjs +25 -4
- package/dist/constructs/v1beta3/token/Token.d.ts +18 -1
- package/dist/constructs/v1beta3/token/TokenSchema.js +3 -1
- package/dist/constructs/v1beta3/token/TokenSchema.mjs +3 -1
- package/dist/constructs/v1beta3/workspace/Workspace.d.ts +421 -1
- package/dist/constructs/v1beta3/workspace/WorkspaceSchema.js +2 -2
- package/dist/constructs/v1beta3/workspace/WorkspaceSchema.mjs +2 -2
- package/dist/mesheryApi.d.mts +17 -17
- package/dist/mesheryApi.d.ts +17 -17
- package/dist/permissions.d.mts +85 -1
- package/dist/permissions.d.ts +85 -1
- package/dist/permissions.js +1 -1
- package/dist/permissions.mjs +1 -1
- package/package.json +1 -1
|
@@ -10,21 +10,42 @@ caller is a live member of that organization. An unauthenticated request
|
|
|
10
10
|
still receives the document, without \`membership\`, so a client can tell
|
|
11
11
|
"not signed in" from "signed in but not a member" from "old provider"
|
|
12
12
|
(no \`contractVersion\`).
|
|
13
|
-
|
|
13
|
+
|
|
14
|
+
A client that names itself with the \`client\` query parameter also
|
|
15
|
+
receives \`compatibility\`: whether its version (the \`{version}\` path
|
|
16
|
+
parameter) meets the provider's minimum for that client. The document is
|
|
17
|
+
always answered with 200 for an outdated client, so the client learns
|
|
18
|
+
from it that it must update. An authenticated request additionally
|
|
19
|
+
receives \`session\`: the caller's roles, the plan and the entitlements of
|
|
20
|
+
the caller's roles and, when the caller is a live member of the
|
|
21
|
+
organization in \`X-Current-Orgid\`, that organization's plan, entitlements
|
|
22
|
+
and registered device usage.
|
|
23
|
+
`,version:"v1beta3",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},security:[{jwt:[]},{}],tags:[{name:"capabilities",description:"Operations related to the provider's capabilities document."}],paths:{"/{version}/capabilities":{get:{"x-internal":["cloud"],tags:["capabilities"],summary:"Get the provider's capabilities",operationId:"getProviderCapabilities",description:"Returns the capabilities document for a client of the given version.\nAuthentication is optional: with a valid token the document reflects\nthe caller's roles, and with a valid token plus `X-Current-Orgid` it\nalso carries `membership`. An invalid or absent token is not an error;\nthe document is returned without `membership`. A malformed\n`X-Current-Orgid` is a client error and returns 400. With `client`,\nthe document carries `compatibility` for that client at `{version}`;\nan outdated client still receives 200 with `compatible` false. With a\nvalid token the document carries `session`; for a live member of the\n`X-Current-Orgid` organization it includes that organization's plan,\nentitlements and device usage.\n",parameters:[{name:"version",in:"path",description:"Version of the requesting client, for example `v0.8.0`.",required:true,schema:{type:"string",maxLength:64}},{name:"X-Current-Orgid",in:"header",description:"Organization whose membership the caller wants reported.",required:false,schema:{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"}}},{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.
|
|
24
|
+
`,minLength:1,maxLength:64,pattern:"^[a-z0-9][a-z0-9-]*$"}},{name:"os",in:"query",description:"Operating system of the client, used to select packages.",schema:{type:"string",maxLength:64}}],responses:{200:{description:"The capabilities document",content:{"application/json":{schema:{$schema:"http://json-schema.org/draft-07/schema#",title:"Provider Capability Schema",description:"The remote provider's capabilities document. Existing fields describe the\nprovider and its extensions; `contractVersion` and `membership` let a\nnative client gate on the provider's contract and on its organization\nmembership after authenticating; `compatibility` tells a client that\nnamed itself whether its version is still accepted, and `session`\ndescribes the authenticated caller's roles, plan and entitlements. New\nfields arrive only with a new `contractVersion` (1.1 added\n`compatibility` and `session`).\n",type:"object",additionalProperties:false,required:["providerType"],properties:{providerType:{type:"string",description:"Provider type, for example `remote`.",maxLength:64},packageVersion:{type:"string",description:"Version of the extension package the provider offers this client.",maxLength:64},packageUrl:{type:"string",description:"Download URL of that package.",maxLength:2048},providerName:{type:"string",description:"Display name of the provider.",maxLength:255},providerDescription:{type:"array",description:"Lines describing the provider.",items:{type:"string"}},providerUrl:{type:"string",description:"Home page URL of the provider.",maxLength:2048},redirects:{type:"object",description:"Redirect targets the provider serves to this client, keyed by name.",additionalProperties:{type:"string"}},contractVersion:{type:"string",description:`Version of the provider's REST contract for native clients, as
|
|
14
25
|
\`MAJOR.MINOR\`. A client refuses a provider whose major differs from the
|
|
15
26
|
one it was built against. A provider that predates this field omits
|
|
16
27
|
it, which a client treats as not serving the contract.
|
|
17
28
|
`,pattern:"^[0-9]+\\.[0-9]+$",maxLength:32},membership:{type:"object",description:`Whether the authenticated caller is a live member of the organization
|
|
18
29
|
named by \`X-Current-Orgid\`. Present only on an authenticated request
|
|
19
30
|
that carried that header.
|
|
20
|
-
`,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."}}},
|
|
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.
|
|
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
|
+
`,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
|
+
`,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.
|
|
36
|
+
`,minLength:1,maxLength:64,pattern:"^[a-z0-9][a-z0-9-]*$"}},currentOrgId:{name:"X-Current-Orgid",in:"header",description:"Organization whose membership the caller wants reported.",required:false,schema:{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"}}}},schemas:{ProviderCapability:{$schema:"http://json-schema.org/draft-07/schema#",title:"Provider Capability Schema",description:"The remote provider's capabilities document. Existing fields describe the\nprovider and its extensions; `contractVersion` and `membership` let a\nnative client gate on the provider's contract and on its organization\nmembership after authenticating; `compatibility` tells a client that\nnamed itself whether its version is still accepted, and `session`\ndescribes the authenticated caller's roles, plan and entitlements. New\nfields arrive only with a new `contractVersion` (1.1 added\n`compatibility` and `session`).\n",type:"object",additionalProperties:false,required:["providerType"],properties:{providerType:{type:"string",description:"Provider type, for example `remote`.",maxLength:64},packageVersion:{type:"string",description:"Version of the extension package the provider offers this client.",maxLength:64},packageUrl:{type:"string",description:"Download URL of that package.",maxLength:2048},providerName:{type:"string",description:"Display name of the provider.",maxLength:255},providerDescription:{type:"array",description:"Lines describing the provider.",items:{type:"string"}},providerUrl:{type:"string",description:"Home page URL of the provider.",maxLength:2048},redirects:{type:"object",description:"Redirect targets the provider serves to this client, keyed by name.",additionalProperties:{type:"string"}},contractVersion:{type:"string",description:`Version of the provider's REST contract for native clients, as
|
|
21
37
|
\`MAJOR.MINOR\`. A client refuses a provider whose major differs from the
|
|
22
38
|
one it was built against. A provider that predates this field omits
|
|
23
39
|
it, which a client treats as not serving the contract.
|
|
24
40
|
`,pattern:"^[0-9]+\\.[0-9]+$",maxLength:32},membership:{type:"object",description:`Whether the authenticated caller is a live member of the organization
|
|
25
41
|
named by \`X-Current-Orgid\`. Present only on an authenticated request
|
|
26
42
|
that carried that header.
|
|
27
|
-
`,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."}}},
|
|
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
|
|
28
45
|
named by \`X-Current-Orgid\`. Present only on an authenticated request
|
|
29
46
|
that carried that header.
|
|
30
|
-
`,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."}}}
|
|
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.
|
|
48
|
+
`,minLength:1,maxLength:64,pattern:"^[a-z0-9][a-z0-9-]*$"},ClientCompatibility:{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.
|
|
49
|
+
`,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}}},ClientUpgradeRequiredError:{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.
|
|
50
|
+
`,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.
|
|
51
|
+
`,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}}}}},ProviderDeviceUsage:{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."}}},ProviderSession:{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."}}}}}}}},t=e;module.exports=t;
|
|
@@ -10,21 +10,42 @@ caller is a live member of that organization. An unauthenticated request
|
|
|
10
10
|
still receives the document, without \`membership\`, so a client can tell
|
|
11
11
|
"not signed in" from "signed in but not a member" from "old provider"
|
|
12
12
|
(no \`contractVersion\`).
|
|
13
|
-
|
|
13
|
+
|
|
14
|
+
A client that names itself with the \`client\` query parameter also
|
|
15
|
+
receives \`compatibility\`: whether its version (the \`{version}\` path
|
|
16
|
+
parameter) meets the provider's minimum for that client. The document is
|
|
17
|
+
always answered with 200 for an outdated client, so the client learns
|
|
18
|
+
from it that it must update. An authenticated request additionally
|
|
19
|
+
receives \`session\`: the caller's roles, the plan and the entitlements of
|
|
20
|
+
the caller's roles and, when the caller is a live member of the
|
|
21
|
+
organization in \`X-Current-Orgid\`, that organization's plan, entitlements
|
|
22
|
+
and registered device usage.
|
|
23
|
+
`,version:"v1beta3",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},security:[{jwt:[]},{}],tags:[{name:"capabilities",description:"Operations related to the provider's capabilities document."}],paths:{"/{version}/capabilities":{get:{"x-internal":["cloud"],tags:["capabilities"],summary:"Get the provider's capabilities",operationId:"getProviderCapabilities",description:"Returns the capabilities document for a client of the given version.\nAuthentication is optional: with a valid token the document reflects\nthe caller's roles, and with a valid token plus `X-Current-Orgid` it\nalso carries `membership`. An invalid or absent token is not an error;\nthe document is returned without `membership`. A malformed\n`X-Current-Orgid` is a client error and returns 400. With `client`,\nthe document carries `compatibility` for that client at `{version}`;\nan outdated client still receives 200 with `compatible` false. With a\nvalid token the document carries `session`; for a live member of the\n`X-Current-Orgid` organization it includes that organization's plan,\nentitlements and device usage.\n",parameters:[{name:"version",in:"path",description:"Version of the requesting client, for example `v0.8.0`.",required:true,schema:{type:"string",maxLength:64}},{name:"X-Current-Orgid",in:"header",description:"Organization whose membership the caller wants reported.",required:false,schema:{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"}}},{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.
|
|
24
|
+
`,minLength:1,maxLength:64,pattern:"^[a-z0-9][a-z0-9-]*$"}},{name:"os",in:"query",description:"Operating system of the client, used to select packages.",schema:{type:"string",maxLength:64}}],responses:{200:{description:"The capabilities document",content:{"application/json":{schema:{$schema:"http://json-schema.org/draft-07/schema#",title:"Provider Capability Schema",description:"The remote provider's capabilities document. Existing fields describe the\nprovider and its extensions; `contractVersion` and `membership` let a\nnative client gate on the provider's contract and on its organization\nmembership after authenticating; `compatibility` tells a client that\nnamed itself whether its version is still accepted, and `session`\ndescribes the authenticated caller's roles, plan and entitlements. New\nfields arrive only with a new `contractVersion` (1.1 added\n`compatibility` and `session`).\n",type:"object",additionalProperties:false,required:["providerType"],properties:{providerType:{type:"string",description:"Provider type, for example `remote`.",maxLength:64},packageVersion:{type:"string",description:"Version of the extension package the provider offers this client.",maxLength:64},packageUrl:{type:"string",description:"Download URL of that package.",maxLength:2048},providerName:{type:"string",description:"Display name of the provider.",maxLength:255},providerDescription:{type:"array",description:"Lines describing the provider.",items:{type:"string"}},providerUrl:{type:"string",description:"Home page URL of the provider.",maxLength:2048},redirects:{type:"object",description:"Redirect targets the provider serves to this client, keyed by name.",additionalProperties:{type:"string"}},contractVersion:{type:"string",description:`Version of the provider's REST contract for native clients, as
|
|
14
25
|
\`MAJOR.MINOR\`. A client refuses a provider whose major differs from the
|
|
15
26
|
one it was built against. A provider that predates this field omits
|
|
16
27
|
it, which a client treats as not serving the contract.
|
|
17
28
|
`,pattern:"^[0-9]+\\.[0-9]+$",maxLength:32},membership:{type:"object",description:`Whether the authenticated caller is a live member of the organization
|
|
18
29
|
named by \`X-Current-Orgid\`. Present only on an authenticated request
|
|
19
30
|
that carried that header.
|
|
20
|
-
`,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."}}},
|
|
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.
|
|
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
|
+
`,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
|
+
`,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.
|
|
36
|
+
`,minLength:1,maxLength:64,pattern:"^[a-z0-9][a-z0-9-]*$"}},currentOrgId:{name:"X-Current-Orgid",in:"header",description:"Organization whose membership the caller wants reported.",required:false,schema:{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"}}}},schemas:{ProviderCapability:{$schema:"http://json-schema.org/draft-07/schema#",title:"Provider Capability Schema",description:"The remote provider's capabilities document. Existing fields describe the\nprovider and its extensions; `contractVersion` and `membership` let a\nnative client gate on the provider's contract and on its organization\nmembership after authenticating; `compatibility` tells a client that\nnamed itself whether its version is still accepted, and `session`\ndescribes the authenticated caller's roles, plan and entitlements. New\nfields arrive only with a new `contractVersion` (1.1 added\n`compatibility` and `session`).\n",type:"object",additionalProperties:false,required:["providerType"],properties:{providerType:{type:"string",description:"Provider type, for example `remote`.",maxLength:64},packageVersion:{type:"string",description:"Version of the extension package the provider offers this client.",maxLength:64},packageUrl:{type:"string",description:"Download URL of that package.",maxLength:2048},providerName:{type:"string",description:"Display name of the provider.",maxLength:255},providerDescription:{type:"array",description:"Lines describing the provider.",items:{type:"string"}},providerUrl:{type:"string",description:"Home page URL of the provider.",maxLength:2048},redirects:{type:"object",description:"Redirect targets the provider serves to this client, keyed by name.",additionalProperties:{type:"string"}},contractVersion:{type:"string",description:`Version of the provider's REST contract for native clients, as
|
|
21
37
|
\`MAJOR.MINOR\`. A client refuses a provider whose major differs from the
|
|
22
38
|
one it was built against. A provider that predates this field omits
|
|
23
39
|
it, which a client treats as not serving the contract.
|
|
24
40
|
`,pattern:"^[0-9]+\\.[0-9]+$",maxLength:32},membership:{type:"object",description:`Whether the authenticated caller is a live member of the organization
|
|
25
41
|
named by \`X-Current-Orgid\`. Present only on an authenticated request
|
|
26
42
|
that carried that header.
|
|
27
|
-
`,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."}}},
|
|
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
|
|
28
45
|
named by \`X-Current-Orgid\`. Present only on an authenticated request
|
|
29
46
|
that carried that header.
|
|
30
|
-
`,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."}}}
|
|
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.
|
|
48
|
+
`,minLength:1,maxLength:64,pattern:"^[a-z0-9][a-z0-9-]*$"},ClientCompatibility:{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.
|
|
49
|
+
`,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}}},ClientUpgradeRequiredError:{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.
|
|
50
|
+
`,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.
|
|
51
|
+
`,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}}}}},ProviderDeviceUsage:{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."}}},ProviderSession:{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."}}}}}}}},t=e;export{t as default};
|
|
@@ -81,7 +81,7 @@ export interface paths {
|
|
|
81
81
|
};
|
|
82
82
|
/**
|
|
83
83
|
* Show native client sign-in consent
|
|
84
|
-
* @description Browser-facing step of the native client sign-in flow (RFC 8252 loopback redirect with RFC 7636 PKCE). Requires the session cookie of a signed-in user, never URL credentials. Validates the request and renders a consent page that asks the user to allow the named local client to act on their behalf. Nothing is issued by this call.
|
|
84
|
+
* @description Browser-facing step of the native client sign-in flow (RFC 8252 loopback redirect with RFC 7636 PKCE). Requires the session cookie of a signed-in user, never URL credentials. Validates the request and renders a consent page that asks the user to allow the named local client to act on their behalf. Nothing is issued by this call. When the request names the client application (`client`) and its version (`clientVersion`) and that version is below the provider's minimum for that client, an update page is rendered with status 426 instead of the consent page.
|
|
85
85
|
*/
|
|
86
86
|
get: operations["getNativeClientAuthorization"];
|
|
87
87
|
put?: never;
|
|
@@ -307,6 +307,10 @@ export interface components {
|
|
|
307
307
|
purpose: string;
|
|
308
308
|
/** @description Display name of the native client asking to sign in. Shown on the consent page and used as the name and purpose of the minted token. */
|
|
309
309
|
nativeClientName: string;
|
|
310
|
+
/** @description Identifier of the client application, as in the capabilities `client` parameter. Selects the minimum version checked against `clientVersion`. */
|
|
311
|
+
nativeClient: string;
|
|
312
|
+
/** @description Version of the client application, for example `v1.25.0`. */
|
|
313
|
+
nativeClientVersion: string;
|
|
310
314
|
/** @description Port on 127.0.0.1 where the native client listens for the callback. */
|
|
311
315
|
nativePort: number;
|
|
312
316
|
/** @description PKCE code challenge, BASE64URL(SHA256(codeVerifier)) without padding. */
|
|
@@ -788,6 +792,10 @@ export interface operations {
|
|
|
788
792
|
query: {
|
|
789
793
|
/** @description Display name of the native client asking to sign in. Shown on the consent page and used as the name and purpose of the minted token. */
|
|
790
794
|
clientName: string;
|
|
795
|
+
/** @description Identifier of the client application, as in the capabilities `client` parameter. Selects the minimum version checked against `clientVersion`. */
|
|
796
|
+
client?: string;
|
|
797
|
+
/** @description Version of the client application, for example `v1.25.0`. */
|
|
798
|
+
clientVersion?: string;
|
|
791
799
|
/** @description Port on 127.0.0.1 where the native client listens for the callback. */
|
|
792
800
|
port: number;
|
|
793
801
|
/** @description PKCE code challenge, BASE64URL(SHA256(codeVerifier)) without padding. */
|
|
@@ -830,6 +838,15 @@ export interface operations {
|
|
|
830
838
|
"text/plain": string;
|
|
831
839
|
};
|
|
832
840
|
};
|
|
841
|
+
/** @description Update page; the client's version is below the provider's minimum for that client. */
|
|
842
|
+
426: {
|
|
843
|
+
headers: {
|
|
844
|
+
[name: string]: unknown;
|
|
845
|
+
};
|
|
846
|
+
content: {
|
|
847
|
+
"text/html": string;
|
|
848
|
+
};
|
|
849
|
+
};
|
|
833
850
|
};
|
|
834
851
|
};
|
|
835
852
|
approveNativeClientAuthorization: {
|