@meshery/schemas 1.3.101 → 1.3.103
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 +4558 -4098
- package/dist/cloudApi.d.ts +4558 -4098
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1alpha1/core/Core.d.ts +1 -1
- package/dist/constructs/v1alpha1/core/CoreSchema.js +1 -1
- package/dist/constructs/v1alpha1/core/CoreSchema.mjs +1 -1
- package/dist/constructs/v1beta1/diagnostics/Diagnostics.d.ts +536 -0
- package/dist/constructs/v1beta1/diagnostics/Diagnostics.js +1 -0
- package/dist/constructs/v1beta1/diagnostics/Diagnostics.mjs +0 -0
- package/dist/constructs/v1beta1/diagnostics/DiagnosticsSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/diagnostics/DiagnosticsSchema.js +2 -0
- package/dist/constructs/v1beta1/diagnostics/DiagnosticsSchema.mjs +2 -0
- package/dist/constructs/v1beta1/support/Support.d.ts +373 -0
- package/dist/constructs/v1beta1/support/SupportSchema.js +1 -1
- package/dist/constructs/v1beta1/support/SupportSchema.mjs +1 -1
- package/dist/constructs/v1beta2/core/Core.d.ts +26 -1
- package/dist/constructs/v1beta2/core/CoreSchema.js +1 -1
- package/dist/constructs/v1beta2/core/CoreSchema.mjs +1 -1
- package/dist/constructs/v1beta3/blowhorn_health/BlowhornHealth.d.ts +50 -0
- package/dist/constructs/v1beta3/blowhorn_health/BlowhornHealthSchema.js +1 -1
- package/dist/constructs/v1beta3/blowhorn_health/BlowhornHealthSchema.mjs +1 -1
- package/dist/constructs/v1beta3/claim/Claim.d.ts +150 -0
- package/dist/constructs/v1beta3/claim/ClaimSchema.js +2 -2
- package/dist/constructs/v1beta3/claim/ClaimSchema.mjs +2 -2
- package/dist/constructs/v1beta3/connection/Connection.d.ts +100 -0
- package/dist/constructs/v1beta3/connection/ConnectionSchema.js +3 -3
- package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +3 -3
- package/dist/constructs/v1beta3/content_item/ContentItem.d.ts +150 -0
- package/dist/constructs/v1beta3/content_item/ContentItemSchema.js +5 -5
- package/dist/constructs/v1beta3/content_item/ContentItemSchema.mjs +5 -5
- package/dist/constructs/v1beta3/design/DesignSchema.js +5 -5
- package/dist/constructs/v1beta3/design/DesignSchema.mjs +5 -5
- package/dist/constructs/v1beta3/event/Event.d.ts +275 -0
- package/dist/constructs/v1beta3/event/EventSchema.js +3 -3
- package/dist/constructs/v1beta3/event/EventSchema.mjs +3 -3
- package/dist/constructs/v1beta3/github/GithubSchema.js +1 -1
- package/dist/constructs/v1beta3/github/GithubSchema.mjs +1 -1
- package/dist/constructs/v1beta3/invitation/InvitationSchema.js +1 -1
- package/dist/constructs/v1beta3/invitation/InvitationSchema.mjs +1 -1
- package/dist/constructs/v1beta3/ledger/Ledger.d.ts +175 -0
- package/dist/constructs/v1beta3/ledger/LedgerSchema.js +5 -5
- package/dist/constructs/v1beta3/ledger/LedgerSchema.mjs +5 -5
- package/dist/constructs/v1beta3/profile/Profile.d.ts +225 -0
- package/dist/constructs/v1beta3/profile/ProfileSchema.js +1 -1
- package/dist/constructs/v1beta3/profile/ProfileSchema.mjs +1 -1
- package/dist/constructs/v1beta3/provider_capability/ProviderCapability.d.ts +50 -0
- package/dist/constructs/v1beta3/provider_capability/ProviderCapabilitySchema.js +1 -1
- package/dist/constructs/v1beta3/provider_capability/ProviderCapabilitySchema.mjs +1 -1
- package/dist/constructs/v1beta3/risk_profile/RiskProfile.d.ts +35 -0
- package/dist/constructs/v1beta3/risk_profile/RiskProfile.js +1 -0
- package/dist/constructs/v1beta3/risk_profile/RiskProfile.mjs +0 -0
- package/dist/constructs/v1beta3/risk_profile/RiskProfileSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/risk_profile/RiskProfileSchema.js +22 -0
- package/dist/constructs/v1beta3/risk_profile/RiskProfileSchema.mjs +22 -0
- package/dist/constructs/v1beta3/schedule/Schedule.d.ts +343 -0
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.js +68 -5
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.mjs +68 -5
- package/dist/index.d.mts +1 -1
- package/dist/index.d.ts +1 -1
- package/package.json +1 -1
|
@@ -428,6 +428,31 @@ export interface components {
|
|
|
428
428
|
"text/plain": string;
|
|
429
429
|
};
|
|
430
430
|
};
|
|
431
|
+
/** @description Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying. */
|
|
432
|
+
MeshkitError429: {
|
|
433
|
+
headers: {
|
|
434
|
+
/** @description Number of seconds the caller must wait before retrying. */
|
|
435
|
+
"Retry-After": number;
|
|
436
|
+
[name: string]: unknown;
|
|
437
|
+
};
|
|
438
|
+
content: {
|
|
439
|
+
"application/json": {
|
|
440
|
+
/** @description The sentence the caller is shown. */
|
|
441
|
+
error: string;
|
|
442
|
+
/** @description MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error. */
|
|
443
|
+
code?: string;
|
|
444
|
+
/**
|
|
445
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
446
|
+
* @enum {string}
|
|
447
|
+
*/
|
|
448
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
449
|
+
/** @description MeshKit's probable causes of the error. */
|
|
450
|
+
probableCause?: string[];
|
|
451
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
452
|
+
suggestedRemediation?: string[];
|
|
453
|
+
};
|
|
454
|
+
};
|
|
455
|
+
};
|
|
431
456
|
/** @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. */
|
|
432
457
|
ClientUpgradeRequired: {
|
|
433
458
|
headers: {
|
|
@@ -692,6 +717,31 @@ export interface operations {
|
|
|
692
717
|
"text/plain": string;
|
|
693
718
|
};
|
|
694
719
|
};
|
|
720
|
+
/** @description Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying. */
|
|
721
|
+
429: {
|
|
722
|
+
headers: {
|
|
723
|
+
/** @description Number of seconds the caller must wait before retrying. */
|
|
724
|
+
"Retry-After": number;
|
|
725
|
+
[name: string]: unknown;
|
|
726
|
+
};
|
|
727
|
+
content: {
|
|
728
|
+
"application/json": {
|
|
729
|
+
/** @description The sentence the caller is shown. */
|
|
730
|
+
error: string;
|
|
731
|
+
/** @description MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error. */
|
|
732
|
+
code?: string;
|
|
733
|
+
/**
|
|
734
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
735
|
+
* @enum {string}
|
|
736
|
+
*/
|
|
737
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
738
|
+
/** @description MeshKit's probable causes of the error. */
|
|
739
|
+
probableCause?: string[];
|
|
740
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
741
|
+
suggestedRemediation?: string[];
|
|
742
|
+
};
|
|
743
|
+
};
|
|
744
|
+
};
|
|
695
745
|
/** @description Internal server error */
|
|
696
746
|
500: {
|
|
697
747
|
headers: {
|
|
@@ -29,7 +29,7 @@ it, which a client treats as not serving the contract.
|
|
|
29
29
|
named by \`X-Current-Orgid\`. Present only on an authenticated request
|
|
30
30
|
that carried that header.
|
|
31
31
|
`,additionalProperties:false,required:["organizationId","bound"],properties:{organizationId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},bound:{type:"boolean",description:"True when the caller is a live member of the organization."}}},compatibility:{type:"object",description:"Whether a client application's version meets the provider's minimum for that client. A client whose `compatible` is false must update before it registers or keeps a connection alive; the provider answers those calls with 426. A client the provider has no minimum for is compatible and has no `minimumVersion`.\n",additionalProperties:false,required:["clientName","clientVersion","compatible"],properties:{clientName:{type:"string",description:`Identifier of a client application, for example the product name of a desktop app, lowercase. It is a value chosen by the client; the provider keys its minimum client versions by it.
|
|
32
|
-
`,minLength:1,maxLength:64,pattern:"^[a-z0-9][a-z0-9-]*$"},clientVersion:{type:"string",description:"The client's version as it reported it, as `MAJOR.MINOR.PATCH` with an optional leading `v`, for example `v1.25.0`. Versions are ordered by their numeric parts, so `v1.9.0` is older than `v1.25.0`.",maxLength:64},minimumVersion:{type:"string",description:"Oldest client version the provider accepts for this client. Absent when the provider sets no minimum.",maxLength:64},compatible:{type:"boolean",description:"True when `clientVersion` is at or above `minimumVersion`, or when there is no minimum."},upgradeUrl:{type:"string",description:"Where the client can get an update, when the provider knows one.",maxLength:2048}}},session:{type:"object",description:"The authenticated caller's session as the provider sees it: who the caller is, the caller's roles, and, for the organization named by `X-Current-Orgid` when the caller is a live member of it, that organization's roles, plan, entitlements and device usage. Present only on an authenticated request.\n",additionalProperties:false,required:["userId","providerRoles"],properties:{userId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},providerRoles:{type:"array",description:"The caller's provider-wide role names.",items:{type:"string",maxLength:255}},organizationRoles:{type:"array",description:"The caller's role names in the organization.",items:{type:"string",maxLength:255}},plan:{description:"The plan of the organization's active subscription, when it has one.","x-go-type":"planv1beta3.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta3/plan",name:"planv1beta3"},type:"object",additionalProperties:false,required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},entitlements:{type:"array",description:"The features the organization's active subscriptions entitle it to.",items:{"x-go-type":"featurev1beta1.Feature","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/feature",name:"featurev1beta1"},type:"object",additionalProperties:false,description:"A feature is a quantified entitlement granted to an organization through its subscription plan, such as the number of components allowed in a design.",required:["id","plan_id","name","quantity","created_at","updated_at"],properties:{id:{description:"Unique identifier for the feature.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",csv:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan_id:{description:"Identifier of the plan granting this feature.","x-go-name":"PlanId","x-oapi-codegen-extra-tags":{db:"plan_id",csv:"plan_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan:{description:"The plan granting this feature. Populated only when the association is explicitly loaded.","x-go-type":"planv1beta3.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta3/plan",name:"planv1beta3"},"x-oapi-codegen-extra-tags":{belongs_to:"plans",fk_id:"PlanId",json:"plan,omitempty"},"x-order":3,type:"object",additionalProperties:false,required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},name:{description:"Name of the entitled feature.","x-go-type":"FeatureName","x-oapi-codegen-extra-tags":{db:"name",csv:"name"},"x-order":4,type:"string","x-enum-casing-exempt":true,enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign","BlowhornProfiles","BlowhornBrowserAutomation","BlowhornScheduler","BlowhornDevicesPerSeat","BlowhornPlatformLinkedIn","BlowhornPlatformX","BlowhornPlatformReddit","BlowhornPlatformHackerNews","BlowhornPlatformSlack","BlowhornPlatformBluesky","BlowhornPlatformGitHub","BlowhornPlatformBlog"],"x-enumDescriptions":{ComponentsInDesign:"Maximum number of components in a single design; 999999999999 is unlimited.",RelationshipsInDesign:"Maximum number of relationships in a single design; 999999999999 is unlimited.",DesignsInWorkspace:"Maximum number of designs in a single workspace; 999999999999 is unlimited.",WorkspacesInOrganization:"Maximum number of workspaces in an organization; 999999999999 is unlimited.",ImageSizeInDesign:"Maximum size, in bytes, of an image embedded in a design; 999999999999 is unlimited.",SizePerDesign:"Maximum size of a single design; 999999999999 is unlimited.",BlowhornProfiles:"Maximum number of Blowhorn posting profiles the organization may hold; 999999999999 is unlimited.",BlowhornBrowserAutomation:"Blowhorn may publish through browser automation; granted when quantity is greater than 0.",BlowhornScheduler:"Blowhorn may run scheduled publishes; granted when quantity is greater than 0.",BlowhornDevicesPerSeat:"Maximum number of devices one Blowhorn seat may publish from; 999999999999 is unlimited.",BlowhornPlatformLinkedIn:"Blowhorn may publish to LinkedIn; granted when quantity is greater than 0.",BlowhornPlatformX:"Blowhorn may publish to X; granted when quantity is greater than 0.",BlowhornPlatformReddit:"Blowhorn may publish to Reddit; granted when quantity is greater than 0.",BlowhornPlatformHackerNews:"Blowhorn may publish to Hacker News; granted when quantity is greater than 0.",BlowhornPlatformSlack:"Blowhorn may publish to Slack; granted when quantity is greater than 0.",BlowhornPlatformBluesky:"Blowhorn may publish to Bluesky; granted when quantity is greater than 0.",BlowhornPlatformGitHub:"Blowhorn may publish to GitHub; granted when quantity is greater than 0.",BlowhornPlatformBlog:"Blowhorn may publish to a blog; granted when quantity is greater than 0."}},quantity:{type:"number",format:"double",description:"Quantity of the feature granted by the plan. For a cap-style feature this is the maximum, and the sentinel value 999999999999 denotes unlimited. For a capability-style feature any value greater than 0 grants the capability.",minimum:0,"x-oapi-codegen-extra-tags":{db:"quantity",csv:"quantity"},"x-order":5},created_at:{"x-order":6,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":7,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}}},deviceUsage:{type:"object",description:"Registered devices (live `desktop` connections) in the organization against the organization's device limit. Registrations over the limit are accepted; `overLimit` flags the organization instead.\n",additionalProperties:false,required:["registered","overLimit"],properties:{registered:{type:"integer",minimum:0,description:"Live `desktop` connections registered in the organization."},limit:{type:"integer",minimum:0,description:"Devices the organization's subscriptions allow. Absent when unlimited or when no subscription sets a device limit."},overLimit:{type:"boolean",description:"True when `limit` is present and `registered` exceeds it."}}}}},extensions:{type:"object",description:"Extension points; shape owned by the provider.",additionalProperties:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true},capabilities:{type:"array",description:"Features the provider serves and their endpoints. Clients read paths from here instead of hard-coding them. A provider serving desktop connections lists `register-connection`, `connection-heartbeat` and `deregister-desktop-connection`; an endpoint may hold `{connectionId}` or `{installationId}` placeholders.\n",items:{type:"object",description:"One feature the provider serves and the endpoint that serves it.",additionalProperties:false,required:["feature"],properties:{feature:{type:"string",description:"Feature name, for example `persist-connection`.",maxLength:255},endpoint:{type:"string",description:"Path that serves the feature, relative to the provider's base URL.",maxLength:1024}}}},restrictedAccess:{type:"object",description:"Access restrictions applied to this client; shape owned by the provider.",additionalProperties:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}}},components:{securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},responses:{500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}},ClientUpgradeRequired:{description:`The client's version is below the provider's minimum for that client. The client must update before it can register or keep a connection alive; the body names the minimum and where to get an update.
|
|
32
|
+
`,minLength:1,maxLength:64,pattern:"^[a-z0-9][a-z0-9-]*$"},clientVersion:{type:"string",description:"The client's version as it reported it, as `MAJOR.MINOR.PATCH` with an optional leading `v`, for example `v1.25.0`. Versions are ordered by their numeric parts, so `v1.9.0` is older than `v1.25.0`.",maxLength:64},minimumVersion:{type:"string",description:"Oldest client version the provider accepts for this client. Absent when the provider sets no minimum.",maxLength:64},compatible:{type:"boolean",description:"True when `clientVersion` is at or above `minimumVersion`, or when there is no minimum."},upgradeUrl:{type:"string",description:"Where the client can get an update, when the provider knows one.",maxLength:2048}}},session:{type:"object",description:"The authenticated caller's session as the provider sees it: who the caller is, the caller's roles, and, for the organization named by `X-Current-Orgid` when the caller is a live member of it, that organization's roles, plan, entitlements and device usage. Present only on an authenticated request.\n",additionalProperties:false,required:["userId","providerRoles"],properties:{userId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},providerRoles:{type:"array",description:"The caller's provider-wide role names.",items:{type:"string",maxLength:255}},organizationRoles:{type:"array",description:"The caller's role names in the organization.",items:{type:"string",maxLength:255}},plan:{description:"The plan of the organization's active subscription, when it has one.","x-go-type":"planv1beta3.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta3/plan",name:"planv1beta3"},type:"object",additionalProperties:false,required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},entitlements:{type:"array",description:"The features the organization's active subscriptions entitle it to.",items:{"x-go-type":"featurev1beta1.Feature","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/feature",name:"featurev1beta1"},type:"object",additionalProperties:false,description:"A feature is a quantified entitlement granted to an organization through its subscription plan, such as the number of components allowed in a design.",required:["id","plan_id","name","quantity","created_at","updated_at"],properties:{id:{description:"Unique identifier for the feature.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",csv:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan_id:{description:"Identifier of the plan granting this feature.","x-go-name":"PlanId","x-oapi-codegen-extra-tags":{db:"plan_id",csv:"plan_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan:{description:"The plan granting this feature. Populated only when the association is explicitly loaded.","x-go-type":"planv1beta3.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta3/plan",name:"planv1beta3"},"x-oapi-codegen-extra-tags":{belongs_to:"plans",fk_id:"PlanId",json:"plan,omitempty"},"x-order":3,type:"object",additionalProperties:false,required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},name:{description:"Name of the entitled feature.","x-go-type":"FeatureName","x-oapi-codegen-extra-tags":{db:"name",csv:"name"},"x-order":4,type:"string","x-enum-casing-exempt":true,enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign","BlowhornProfiles","BlowhornBrowserAutomation","BlowhornScheduler","BlowhornDevicesPerSeat","BlowhornPlatformLinkedIn","BlowhornPlatformX","BlowhornPlatformReddit","BlowhornPlatformHackerNews","BlowhornPlatformSlack","BlowhornPlatformBluesky","BlowhornPlatformGitHub","BlowhornPlatformBlog"],"x-enumDescriptions":{ComponentsInDesign:"Maximum number of components in a single design; 999999999999 is unlimited.",RelationshipsInDesign:"Maximum number of relationships in a single design; 999999999999 is unlimited.",DesignsInWorkspace:"Maximum number of designs in a single workspace; 999999999999 is unlimited.",WorkspacesInOrganization:"Maximum number of workspaces in an organization; 999999999999 is unlimited.",ImageSizeInDesign:"Maximum size, in bytes, of an image embedded in a design; 999999999999 is unlimited.",SizePerDesign:"Maximum size of a single design; 999999999999 is unlimited.",BlowhornProfiles:"Maximum number of Blowhorn posting profiles the organization may hold; 999999999999 is unlimited.",BlowhornBrowserAutomation:"Blowhorn may publish through browser automation; granted when quantity is greater than 0.",BlowhornScheduler:"Blowhorn may run scheduled publishes; granted when quantity is greater than 0.",BlowhornDevicesPerSeat:"Maximum number of devices one Blowhorn seat may publish from; 999999999999 is unlimited.",BlowhornPlatformLinkedIn:"Blowhorn may publish to LinkedIn; granted when quantity is greater than 0.",BlowhornPlatformX:"Blowhorn may publish to X; granted when quantity is greater than 0.",BlowhornPlatformReddit:"Blowhorn may publish to Reddit; granted when quantity is greater than 0.",BlowhornPlatformHackerNews:"Blowhorn may publish to Hacker News; granted when quantity is greater than 0.",BlowhornPlatformSlack:"Blowhorn may publish to Slack; granted when quantity is greater than 0.",BlowhornPlatformBluesky:"Blowhorn may publish to Bluesky; granted when quantity is greater than 0.",BlowhornPlatformGitHub:"Blowhorn may publish to GitHub; granted when quantity is greater than 0.",BlowhornPlatformBlog:"Blowhorn may publish to a blog; granted when quantity is greater than 0."}},quantity:{type:"number",format:"double",description:"Quantity of the feature granted by the plan. For a cap-style feature this is the maximum, and the sentinel value 999999999999 denotes unlimited. For a capability-style feature any value greater than 0 grants the capability.",minimum:0,"x-oapi-codegen-extra-tags":{db:"quantity",csv:"quantity"},"x-order":5},created_at:{"x-order":6,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":7,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}}},deviceUsage:{type:"object",description:"Registered devices (live `desktop` connections) in the organization against the organization's device limit. Registrations over the limit are accepted; `overLimit` flags the organization instead.\n",additionalProperties:false,required:["registered","overLimit"],properties:{registered:{type:"integer",minimum:0,description:"Live `desktop` connections registered in the organization."},limit:{type:"integer",minimum:0,description:"Devices the organization's subscriptions allow. Absent when unlimited or when no subscription sets a device limit."},overLimit:{type:"boolean",description:"True when `limit` is present and `registered` exceeds it."}}}}},extensions:{type:"object",description:"Extension points; shape owned by the provider.",additionalProperties:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true},capabilities:{type:"array",description:"Features the provider serves and their endpoints. Clients read paths from here instead of hard-coding them. A provider serving desktop connections lists `register-connection`, `connection-heartbeat` and `deregister-desktop-connection`; an endpoint may hold `{connectionId}` or `{installationId}` placeholders.\n",items:{type:"object",description:"One feature the provider serves and the endpoint that serves it.",additionalProperties:false,required:["feature"],properties:{feature:{type:"string",description:"Feature name, for example `persist-connection`.",maxLength:255},endpoint:{type:"string",description:"Path that serves the feature, relative to the provider's base URL.",maxLength:1024}}}},restrictedAccess:{type:"object",description:"Access restrictions applied to this client; shape owned by the provider.",additionalProperties:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},429:{description:"Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying.",headers:{"Retry-After":{description:"Number of seconds the caller must wait before retrying.",required:true,schema:{type:"integer",minimum:1}}},content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{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"}}}},MeshkitError429:{description:"Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying.",headers:{"Retry-After":{description:"Number of seconds the caller must wait before retrying.",required:true,schema:{type:"integer",minimum:1}}},content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},ClientUpgradeRequired:{description:`The client's version is below the provider's minimum for that client. The client must update before it can register or keep a connection alive; the body names the minimum and where to get an update.
|
|
33
33
|
`,content:{"application/json":{schema:{type:"object",description:`Body of a 426 answer: a MeshKit error sentence plus the client's compatibility, so the client can show the minimum and where to update.
|
|
34
34
|
`,additionalProperties:false,required:["error","compatibility"],properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code allocated by the emitting service; not a stable part of this contract."},compatibility:{type:"object",description:"Whether a client application's version meets the provider's minimum for that client. A client whose `compatible` is false must update before it registers or keeps a connection alive; the provider answers those calls with 426. A client the provider has no minimum for is compatible and has no `minimumVersion`.\n",additionalProperties:false,required:["clientName","clientVersion","compatible"],properties:{clientName:{type:"string",description:`Identifier of a client application, for example the product name of a desktop app, lowercase. It is a value chosen by the client; the provider keys its minimum client versions by it.
|
|
35
35
|
`,minLength:1,maxLength:64,pattern:"^[a-z0-9][a-z0-9-]*$"},clientVersion:{type:"string",description:"The client's version as it reported it, as `MAJOR.MINOR.PATCH` with an optional leading `v`, for example `v1.25.0`. Versions are ordered by their numeric parts, so `v1.9.0` is older than `v1.25.0`.",maxLength:64},minimumVersion:{type:"string",description:"Oldest client version the provider accepts for this client. Absent when the provider sets no minimum.",maxLength:64},compatible:{type:"boolean",description:"True when `clientVersion` is at or above `minimumVersion`, or when there is no minimum."},upgradeUrl:{type:"string",description:"Where the client can get an update, when the provider knows one.",maxLength:2048}}}}}}}}},parameters:{version:{name:"version",in:"path",description:"Version of the requesting client, for example `v0.8.0`.",required:true,schema:{type:"string",maxLength:64}},client:{name:"client",in:"query",description:"Identifier of the requesting client application, for example the product name of a desktop app. When present, the document carries `compatibility` for this client at the `{version}` path parameter.\n",required:false,schema:{type:"string",description:`Identifier of a client application, for example the product name of a desktop app, lowercase. It is a value chosen by the client; the provider keys its minimum client versions by it.
|
|
@@ -29,7 +29,7 @@ it, which a client treats as not serving the contract.
|
|
|
29
29
|
named by \`X-Current-Orgid\`. Present only on an authenticated request
|
|
30
30
|
that carried that header.
|
|
31
31
|
`,additionalProperties:false,required:["organizationId","bound"],properties:{organizationId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},bound:{type:"boolean",description:"True when the caller is a live member of the organization."}}},compatibility:{type:"object",description:"Whether a client application's version meets the provider's minimum for that client. A client whose `compatible` is false must update before it registers or keeps a connection alive; the provider answers those calls with 426. A client the provider has no minimum for is compatible and has no `minimumVersion`.\n",additionalProperties:false,required:["clientName","clientVersion","compatible"],properties:{clientName:{type:"string",description:`Identifier of a client application, for example the product name of a desktop app, lowercase. It is a value chosen by the client; the provider keys its minimum client versions by it.
|
|
32
|
-
`,minLength:1,maxLength:64,pattern:"^[a-z0-9][a-z0-9-]*$"},clientVersion:{type:"string",description:"The client's version as it reported it, as `MAJOR.MINOR.PATCH` with an optional leading `v`, for example `v1.25.0`. Versions are ordered by their numeric parts, so `v1.9.0` is older than `v1.25.0`.",maxLength:64},minimumVersion:{type:"string",description:"Oldest client version the provider accepts for this client. Absent when the provider sets no minimum.",maxLength:64},compatible:{type:"boolean",description:"True when `clientVersion` is at or above `minimumVersion`, or when there is no minimum."},upgradeUrl:{type:"string",description:"Where the client can get an update, when the provider knows one.",maxLength:2048}}},session:{type:"object",description:"The authenticated caller's session as the provider sees it: who the caller is, the caller's roles, and, for the organization named by `X-Current-Orgid` when the caller is a live member of it, that organization's roles, plan, entitlements and device usage. Present only on an authenticated request.\n",additionalProperties:false,required:["userId","providerRoles"],properties:{userId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},providerRoles:{type:"array",description:"The caller's provider-wide role names.",items:{type:"string",maxLength:255}},organizationRoles:{type:"array",description:"The caller's role names in the organization.",items:{type:"string",maxLength:255}},plan:{description:"The plan of the organization's active subscription, when it has one.","x-go-type":"planv1beta3.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta3/plan",name:"planv1beta3"},type:"object",additionalProperties:false,required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},entitlements:{type:"array",description:"The features the organization's active subscriptions entitle it to.",items:{"x-go-type":"featurev1beta1.Feature","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/feature",name:"featurev1beta1"},type:"object",additionalProperties:false,description:"A feature is a quantified entitlement granted to an organization through its subscription plan, such as the number of components allowed in a design.",required:["id","plan_id","name","quantity","created_at","updated_at"],properties:{id:{description:"Unique identifier for the feature.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",csv:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan_id:{description:"Identifier of the plan granting this feature.","x-go-name":"PlanId","x-oapi-codegen-extra-tags":{db:"plan_id",csv:"plan_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan:{description:"The plan granting this feature. Populated only when the association is explicitly loaded.","x-go-type":"planv1beta3.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta3/plan",name:"planv1beta3"},"x-oapi-codegen-extra-tags":{belongs_to:"plans",fk_id:"PlanId",json:"plan,omitempty"},"x-order":3,type:"object",additionalProperties:false,required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},name:{description:"Name of the entitled feature.","x-go-type":"FeatureName","x-oapi-codegen-extra-tags":{db:"name",csv:"name"},"x-order":4,type:"string","x-enum-casing-exempt":true,enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign","BlowhornProfiles","BlowhornBrowserAutomation","BlowhornScheduler","BlowhornDevicesPerSeat","BlowhornPlatformLinkedIn","BlowhornPlatformX","BlowhornPlatformReddit","BlowhornPlatformHackerNews","BlowhornPlatformSlack","BlowhornPlatformBluesky","BlowhornPlatformGitHub","BlowhornPlatformBlog"],"x-enumDescriptions":{ComponentsInDesign:"Maximum number of components in a single design; 999999999999 is unlimited.",RelationshipsInDesign:"Maximum number of relationships in a single design; 999999999999 is unlimited.",DesignsInWorkspace:"Maximum number of designs in a single workspace; 999999999999 is unlimited.",WorkspacesInOrganization:"Maximum number of workspaces in an organization; 999999999999 is unlimited.",ImageSizeInDesign:"Maximum size, in bytes, of an image embedded in a design; 999999999999 is unlimited.",SizePerDesign:"Maximum size of a single design; 999999999999 is unlimited.",BlowhornProfiles:"Maximum number of Blowhorn posting profiles the organization may hold; 999999999999 is unlimited.",BlowhornBrowserAutomation:"Blowhorn may publish through browser automation; granted when quantity is greater than 0.",BlowhornScheduler:"Blowhorn may run scheduled publishes; granted when quantity is greater than 0.",BlowhornDevicesPerSeat:"Maximum number of devices one Blowhorn seat may publish from; 999999999999 is unlimited.",BlowhornPlatformLinkedIn:"Blowhorn may publish to LinkedIn; granted when quantity is greater than 0.",BlowhornPlatformX:"Blowhorn may publish to X; granted when quantity is greater than 0.",BlowhornPlatformReddit:"Blowhorn may publish to Reddit; granted when quantity is greater than 0.",BlowhornPlatformHackerNews:"Blowhorn may publish to Hacker News; granted when quantity is greater than 0.",BlowhornPlatformSlack:"Blowhorn may publish to Slack; granted when quantity is greater than 0.",BlowhornPlatformBluesky:"Blowhorn may publish to Bluesky; granted when quantity is greater than 0.",BlowhornPlatformGitHub:"Blowhorn may publish to GitHub; granted when quantity is greater than 0.",BlowhornPlatformBlog:"Blowhorn may publish to a blog; granted when quantity is greater than 0."}},quantity:{type:"number",format:"double",description:"Quantity of the feature granted by the plan. For a cap-style feature this is the maximum, and the sentinel value 999999999999 denotes unlimited. For a capability-style feature any value greater than 0 grants the capability.",minimum:0,"x-oapi-codegen-extra-tags":{db:"quantity",csv:"quantity"},"x-order":5},created_at:{"x-order":6,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":7,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}}},deviceUsage:{type:"object",description:"Registered devices (live `desktop` connections) in the organization against the organization's device limit. Registrations over the limit are accepted; `overLimit` flags the organization instead.\n",additionalProperties:false,required:["registered","overLimit"],properties:{registered:{type:"integer",minimum:0,description:"Live `desktop` connections registered in the organization."},limit:{type:"integer",minimum:0,description:"Devices the organization's subscriptions allow. Absent when unlimited or when no subscription sets a device limit."},overLimit:{type:"boolean",description:"True when `limit` is present and `registered` exceeds it."}}}}},extensions:{type:"object",description:"Extension points; shape owned by the provider.",additionalProperties:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true},capabilities:{type:"array",description:"Features the provider serves and their endpoints. Clients read paths from here instead of hard-coding them. A provider serving desktop connections lists `register-connection`, `connection-heartbeat` and `deregister-desktop-connection`; an endpoint may hold `{connectionId}` or `{installationId}` placeholders.\n",items:{type:"object",description:"One feature the provider serves and the endpoint that serves it.",additionalProperties:false,required:["feature"],properties:{feature:{type:"string",description:"Feature name, for example `persist-connection`.",maxLength:255},endpoint:{type:"string",description:"Path that serves the feature, relative to the provider's base URL.",maxLength:1024}}}},restrictedAccess:{type:"object",description:"Access restrictions applied to this client; shape owned by the provider.",additionalProperties:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}}},components:{securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},responses:{500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}},ClientUpgradeRequired:{description:`The client's version is below the provider's minimum for that client. The client must update before it can register or keep a connection alive; the body names the minimum and where to get an update.
|
|
32
|
+
`,minLength:1,maxLength:64,pattern:"^[a-z0-9][a-z0-9-]*$"},clientVersion:{type:"string",description:"The client's version as it reported it, as `MAJOR.MINOR.PATCH` with an optional leading `v`, for example `v1.25.0`. Versions are ordered by their numeric parts, so `v1.9.0` is older than `v1.25.0`.",maxLength:64},minimumVersion:{type:"string",description:"Oldest client version the provider accepts for this client. Absent when the provider sets no minimum.",maxLength:64},compatible:{type:"boolean",description:"True when `clientVersion` is at or above `minimumVersion`, or when there is no minimum."},upgradeUrl:{type:"string",description:"Where the client can get an update, when the provider knows one.",maxLength:2048}}},session:{type:"object",description:"The authenticated caller's session as the provider sees it: who the caller is, the caller's roles, and, for the organization named by `X-Current-Orgid` when the caller is a live member of it, that organization's roles, plan, entitlements and device usage. Present only on an authenticated request.\n",additionalProperties:false,required:["userId","providerRoles"],properties:{userId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},providerRoles:{type:"array",description:"The caller's provider-wide role names.",items:{type:"string",maxLength:255}},organizationRoles:{type:"array",description:"The caller's role names in the organization.",items:{type:"string",maxLength:255}},plan:{description:"The plan of the organization's active subscription, when it has one.","x-go-type":"planv1beta3.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta3/plan",name:"planv1beta3"},type:"object",additionalProperties:false,required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},entitlements:{type:"array",description:"The features the organization's active subscriptions entitle it to.",items:{"x-go-type":"featurev1beta1.Feature","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/feature",name:"featurev1beta1"},type:"object",additionalProperties:false,description:"A feature is a quantified entitlement granted to an organization through its subscription plan, such as the number of components allowed in a design.",required:["id","plan_id","name","quantity","created_at","updated_at"],properties:{id:{description:"Unique identifier for the feature.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",csv:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan_id:{description:"Identifier of the plan granting this feature.","x-go-name":"PlanId","x-oapi-codegen-extra-tags":{db:"plan_id",csv:"plan_id"},"x-order":2,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},plan:{description:"The plan granting this feature. Populated only when the association is explicitly loaded.","x-go-type":"planv1beta3.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta3/plan",name:"planv1beta3"},"x-oapi-codegen-extra-tags":{belongs_to:"plans",fk_id:"PlanId",json:"plan,omitempty"},"x-order":3,type:"object",additionalProperties:false,required:["id","name","cadence","unit","pricePerUnit","minimumUnits","currency"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"}},name:{description:"Display name of the plan.","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},type:"string","x-enum-casing-exempt":true,enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{description:"Billing cadence for the plan (monthly, annually, or none).","x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["none","monthly","annually"]},unit:{description:"Unit of consumption this plan charges against (e.g. user).","x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimumUnits:{type:"integer",description:"Minimum number of units required for the plan.","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimumUnits",csv:"minimum_units"},minimum:0},pricePerUnit:{type:"number",description:"Price per unit of the plan.","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"pricePerUnit",csv:"price_per_unit"},minimum:0},currency:{description:"Currency in which the plan is priced.","x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}}},name:{description:"Name of the entitled feature.","x-go-type":"FeatureName","x-oapi-codegen-extra-tags":{db:"name",csv:"name"},"x-order":4,type:"string","x-enum-casing-exempt":true,enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign","BlowhornProfiles","BlowhornBrowserAutomation","BlowhornScheduler","BlowhornDevicesPerSeat","BlowhornPlatformLinkedIn","BlowhornPlatformX","BlowhornPlatformReddit","BlowhornPlatformHackerNews","BlowhornPlatformSlack","BlowhornPlatformBluesky","BlowhornPlatformGitHub","BlowhornPlatformBlog"],"x-enumDescriptions":{ComponentsInDesign:"Maximum number of components in a single design; 999999999999 is unlimited.",RelationshipsInDesign:"Maximum number of relationships in a single design; 999999999999 is unlimited.",DesignsInWorkspace:"Maximum number of designs in a single workspace; 999999999999 is unlimited.",WorkspacesInOrganization:"Maximum number of workspaces in an organization; 999999999999 is unlimited.",ImageSizeInDesign:"Maximum size, in bytes, of an image embedded in a design; 999999999999 is unlimited.",SizePerDesign:"Maximum size of a single design; 999999999999 is unlimited.",BlowhornProfiles:"Maximum number of Blowhorn posting profiles the organization may hold; 999999999999 is unlimited.",BlowhornBrowserAutomation:"Blowhorn may publish through browser automation; granted when quantity is greater than 0.",BlowhornScheduler:"Blowhorn may run scheduled publishes; granted when quantity is greater than 0.",BlowhornDevicesPerSeat:"Maximum number of devices one Blowhorn seat may publish from; 999999999999 is unlimited.",BlowhornPlatformLinkedIn:"Blowhorn may publish to LinkedIn; granted when quantity is greater than 0.",BlowhornPlatformX:"Blowhorn may publish to X; granted when quantity is greater than 0.",BlowhornPlatformReddit:"Blowhorn may publish to Reddit; granted when quantity is greater than 0.",BlowhornPlatformHackerNews:"Blowhorn may publish to Hacker News; granted when quantity is greater than 0.",BlowhornPlatformSlack:"Blowhorn may publish to Slack; granted when quantity is greater than 0.",BlowhornPlatformBluesky:"Blowhorn may publish to Bluesky; granted when quantity is greater than 0.",BlowhornPlatformGitHub:"Blowhorn may publish to GitHub; granted when quantity is greater than 0.",BlowhornPlatformBlog:"Blowhorn may publish to a blog; granted when quantity is greater than 0."}},quantity:{type:"number",format:"double",description:"Quantity of the feature granted by the plan. For a cap-style feature this is the maximum, and the sentinel value 999999999999 denotes unlimited. For a capability-style feature any value greater than 0 grants the capability.",minimum:0,"x-oapi-codegen-extra-tags":{db:"quantity",csv:"quantity"},"x-order":5},created_at:{"x-order":6,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":7,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}}},deviceUsage:{type:"object",description:"Registered devices (live `desktop` connections) in the organization against the organization's device limit. Registrations over the limit are accepted; `overLimit` flags the organization instead.\n",additionalProperties:false,required:["registered","overLimit"],properties:{registered:{type:"integer",minimum:0,description:"Live `desktop` connections registered in the organization."},limit:{type:"integer",minimum:0,description:"Devices the organization's subscriptions allow. Absent when unlimited or when no subscription sets a device limit."},overLimit:{type:"boolean",description:"True when `limit` is present and `registered` exceeds it."}}}}},extensions:{type:"object",description:"Extension points; shape owned by the provider.",additionalProperties:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true},capabilities:{type:"array",description:"Features the provider serves and their endpoints. Clients read paths from here instead of hard-coding them. A provider serving desktop connections lists `register-connection`, `connection-heartbeat` and `deregister-desktop-connection`; an endpoint may hold `{connectionId}` or `{installationId}` placeholders.\n",items:{type:"object",description:"One feature the provider serves and the endpoint that serves it.",additionalProperties:false,required:["feature"],properties:{feature:{type:"string",description:"Feature name, for example `persist-connection`.",maxLength:255},endpoint:{type:"string",description:"Path that serves the feature, relative to the provider's base URL.",maxLength:1024}}}},restrictedAccess:{type:"object",description:"Access restrictions applied to this client; shape owned by the provider.",additionalProperties:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},429:{description:"Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying.",headers:{"Retry-After":{description:"Number of seconds the caller must wait before retrying.",required:true,schema:{type:"integer",minimum:1}}},content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{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"}}}},MeshkitError429:{description:"Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying.",headers:{"Retry-After":{description:"Number of seconds the caller must wait before retrying.",required:true,schema:{type:"integer",minimum:1}}},content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError429`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},ClientUpgradeRequired:{description:`The client's version is below the provider's minimum for that client. The client must update before it can register or keep a connection alive; the body names the minimum and where to get an update.
|
|
33
33
|
`,content:{"application/json":{schema:{type:"object",description:`Body of a 426 answer: a MeshKit error sentence plus the client's compatibility, so the client can show the minimum and where to update.
|
|
34
34
|
`,additionalProperties:false,required:["error","compatibility"],properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code allocated by the emitting service; not a stable part of this contract."},compatibility:{type:"object",description:"Whether a client application's version meets the provider's minimum for that client. A client whose `compatible` is false must update before it registers or keeps a connection alive; the provider answers those calls with 426. A client the provider has no minimum for is compatible and has no `minimumVersion`.\n",additionalProperties:false,required:["clientName","clientVersion","compatible"],properties:{clientName:{type:"string",description:`Identifier of a client application, for example the product name of a desktop app, lowercase. It is a value chosen by the client; the provider keys its minimum client versions by it.
|
|
35
35
|
`,minLength:1,maxLength:64,pattern:"^[a-z0-9][a-z0-9-]*$"},clientVersion:{type:"string",description:"The client's version as it reported it, as `MAJOR.MINOR.PATCH` with an optional leading `v`, for example `v1.25.0`. Versions are ordered by their numeric parts, so `v1.9.0` is older than `v1.25.0`.",maxLength:64},minimumVersion:{type:"string",description:"Oldest client version the provider accepts for this client. Absent when the provider sets no minimum.",maxLength:64},compatible:{type:"boolean",description:"True when `clientVersion` is at or above `minimumVersion`, or when there is no minimum."},upgradeUrl:{type:"string",description:"Where the client can get an update, when the provider knows one.",maxLength:2048}}}}}}}}},parameters:{version:{name:"version",in:"path",description:"Version of the requesting client, for example `v0.8.0`.",required:true,schema:{type:"string",maxLength:64}},client:{name:"client",in:"query",description:"Identifier of the requesting client application, for example the product name of a desktop app. When present, the document carries `compatibility` for this client at the `{version}` path parameter.\n",required:false,schema:{type:"string",description:`Identifier of a client application, for example the product name of a desktop app, lowercase. It is a value chosen by the client; the provider keys its minimum client versions by it.
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
export type paths = Record<string, never>;
|
|
7
|
+
export type webhooks = Record<string, never>;
|
|
8
|
+
export interface components {
|
|
9
|
+
schemas: {
|
|
10
|
+
/**
|
|
11
|
+
* Risk Profile Schema
|
|
12
|
+
* @description The Risk Profile preset value. Wherever the value is carried, the
|
|
13
|
+
* workload runs that preset end to end - pace, share of each built-in cap,
|
|
14
|
+
* quiet hours and the pause after a sign-in challenge - instead of the
|
|
15
|
+
* preset the surrounding resolution (profile x platform, configuration,
|
|
16
|
+
* environment, account preference, defaults) would otherwise produce;
|
|
17
|
+
* omitting the value inherits that resolution unchanged. The value is a
|
|
18
|
+
* preset name, never `custom`: custom is a reported state of a profile
|
|
19
|
+
* whose dials sit outside its preset, not a choice anything can make.
|
|
20
|
+
* Referenced by the optional `riskProfile` property on the schedule
|
|
21
|
+
* construct's `Schedule` and `SchedulePayload` components
|
|
22
|
+
* (`v1beta3/schedule`). A new carrier references this component rather
|
|
23
|
+
* than restating the enum.
|
|
24
|
+
* @enum {string}
|
|
25
|
+
*/
|
|
26
|
+
RiskProfile: "cautious" | "standard" | "brisk";
|
|
27
|
+
};
|
|
28
|
+
responses: never;
|
|
29
|
+
parameters: never;
|
|
30
|
+
requestBodies: never;
|
|
31
|
+
headers: never;
|
|
32
|
+
pathItems: never;
|
|
33
|
+
}
|
|
34
|
+
export type $defs = Record<string, never>;
|
|
35
|
+
export type operations = Record<string, never>;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
'use strict';
|
|
File without changes
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
'use strict';var e={openapi:"3.0.0",info:{title:"Risk Profile",description:`OpenAPI schema for Risk Profiles: the named presets that decide how a
|
|
2
|
+
workload runs - its pace, its share of each built-in cap, its quiet
|
|
3
|
+
hours and the pause it takes after a sign-in challenge. A Risk Profile
|
|
4
|
+
is a product-level concept, not a property of any one construct: the
|
|
5
|
+
same preset value is referenced wherever a preset is chosen or
|
|
6
|
+
resolved - a profile's per-platform binding, an account default, and a
|
|
7
|
+
schedule's optional \`riskProfile\` override (Blowhorn #1009). The
|
|
8
|
+
component has no endpoints of its own; referencing constructs declare
|
|
9
|
+
the property, so the paths stay with them.
|
|
10
|
+
`,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"}},paths:{},components:{securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},schemas:{RiskProfile:{$schema:"http://json-schema.org/draft-07/schema#",title:"Risk Profile Schema",description:`The Risk Profile preset value. Wherever the value is carried, the
|
|
11
|
+
workload runs that preset end to end - pace, share of each built-in cap,
|
|
12
|
+
quiet hours and the pause after a sign-in challenge - instead of the
|
|
13
|
+
preset the surrounding resolution (profile x platform, configuration,
|
|
14
|
+
environment, account preference, defaults) would otherwise produce;
|
|
15
|
+
omitting the value inherits that resolution unchanged. The value is a
|
|
16
|
+
preset name, never \`custom\`: custom is a reported state of a profile
|
|
17
|
+
whose dials sit outside its preset, not a choice anything can make.
|
|
18
|
+
Referenced by the optional \`riskProfile\` property on the schedule
|
|
19
|
+
construct's \`Schedule\` and \`SchedulePayload\` components
|
|
20
|
+
(\`v1beta3/schedule\`). A new carrier references this component rather
|
|
21
|
+
than restating the enum.
|
|
22
|
+
`,type:"string",enum:["cautious","standard","brisk"]}}}},t=e;module.exports=t;
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
var e={openapi:"3.0.0",info:{title:"Risk Profile",description:`OpenAPI schema for Risk Profiles: the named presets that decide how a
|
|
2
|
+
workload runs - its pace, its share of each built-in cap, its quiet
|
|
3
|
+
hours and the pause it takes after a sign-in challenge. A Risk Profile
|
|
4
|
+
is a product-level concept, not a property of any one construct: the
|
|
5
|
+
same preset value is referenced wherever a preset is chosen or
|
|
6
|
+
resolved - a profile's per-platform binding, an account default, and a
|
|
7
|
+
schedule's optional \`riskProfile\` override (Blowhorn #1009). The
|
|
8
|
+
component has no endpoints of its own; referencing constructs declare
|
|
9
|
+
the property, so the paths stay with them.
|
|
10
|
+
`,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"}},paths:{},components:{securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},schemas:{RiskProfile:{$schema:"http://json-schema.org/draft-07/schema#",title:"Risk Profile Schema",description:`The Risk Profile preset value. Wherever the value is carried, the
|
|
11
|
+
workload runs that preset end to end - pace, share of each built-in cap,
|
|
12
|
+
quiet hours and the pause after a sign-in challenge - instead of the
|
|
13
|
+
preset the surrounding resolution (profile x platform, configuration,
|
|
14
|
+
environment, account preference, defaults) would otherwise produce;
|
|
15
|
+
omitting the value inherits that resolution unchanged. The value is a
|
|
16
|
+
preset name, never \`custom\`: custom is a reported state of a profile
|
|
17
|
+
whose dials sit outside its preset, not a choice anything can make.
|
|
18
|
+
Referenced by the optional \`riskProfile\` property on the schedule
|
|
19
|
+
construct's \`Schedule\` and \`SchedulePayload\` components
|
|
20
|
+
(\`v1beta3/schedule\`). A new carrier references this component rather
|
|
21
|
+
than restating the enum.
|
|
22
|
+
`,type:"string",enum:["cautious","standard","brisk"]}}}},t=e;export{t as default};
|