@meshery/schemas 1.3.124 → 1.3.125
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 +14 -14
- package/dist/cloudApi.d.ts +14 -14
- package/dist/constructs/v1alpha1/core/Core.d.ts +22 -0
- package/dist/constructs/v1alpha1/core/CoreSchema.js +1 -1
- package/dist/constructs/v1alpha1/core/CoreSchema.mjs +1 -1
- package/dist/constructs/v1beta1/feature/Feature.d.ts +3 -3
- package/dist/constructs/v1beta1/feature/FeatureSchema.js +1 -1
- package/dist/constructs/v1beta1/feature/FeatureSchema.mjs +1 -1
- package/dist/constructs/v1beta2/core/Core.d.ts +52 -1
- package/dist/constructs/v1beta2/core/CoreSchema.js +1 -1
- package/dist/constructs/v1beta2/core/CoreSchema.mjs +1 -1
- package/dist/constructs/v1beta2/user/User.d.ts +60 -2
- package/dist/constructs/v1beta2/user/UserSchema.js +1 -1
- package/dist/constructs/v1beta2/user/UserSchema.mjs +1 -1
- package/dist/constructs/v1beta3/connection/Connection.d.ts +92 -5
- package/dist/constructs/v1beta3/connection/ConnectionSchema.js +5 -5
- package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +5 -5
- package/dist/constructs/v1beta3/content_item/ContentItem.d.ts +90 -3
- package/dist/constructs/v1beta3/content_item/ContentItemSchema.js +6 -6
- package/dist/constructs/v1beta3/content_item/ContentItemSchema.mjs +6 -6
- package/dist/constructs/v1beta3/event/Event.d.ts +60 -2
- package/dist/constructs/v1beta3/event/EventSchema.js +3 -3
- package/dist/constructs/v1beta3/event/EventSchema.mjs +3 -3
- package/dist/constructs/v1beta3/request/Request.d.ts +5 -5
- package/dist/constructs/v1beta3/request/RequestSchema.js +5 -5
- package/dist/constructs/v1beta3/request/RequestSchema.mjs +5 -5
- package/dist/constructs/v1beta3/schedule/Schedule.d.ts +90 -3
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.js +5 -5
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.mjs +5 -5
- package/dist/index.d.mts +53 -2
- package/dist/index.d.ts +53 -2
- package/dist/mesheryApi.d.mts +2 -2
- package/dist/mesheryApi.d.ts +2 -2
- package/package.json +1 -1
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
var e={openapi:"3.0.0",info:{title:"Feature",description:"OpenAPI schema for the Features construct - the quantified entitlements granted by Meshery Cloud subscription plans.",version:"v1beta1",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:"Features",description:"Operations related to features and entitlements"}],paths:{"/api/entitlement/features":{get:{"x-internal":["cloud"],tags:["Features"],summary:"Get all features defined across plans",operationId:"getFeatures",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}}],responses:{200:{description:"Features response",content:{"application/json":{schema:{type:"array",description:"List of features.",items:{"x-go-type":"Feature",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:{description:"Unique identifier for the plan.","x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},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 posting profiles the organization may hold; 999999999999 is unlimited.",BlowhornBrowserAutomation:"The client may publish through browser automation; granted when quantity is greater than 0.",BlowhornScheduler:"The client may run scheduled publishes; granted when quantity is greater than 0.",BlowhornDevicesPerSeat:"Maximum number of devices one seat may publish from; 999999999999 is unlimited.",BlowhornPlatformLinkedIn:"The client may publish to LinkedIn; granted when quantity is greater than 0.",BlowhornPlatformX:"The client may publish to X; granted when quantity is greater than 0.",BlowhornPlatformReddit:"The client may publish to Reddit; granted when quantity is greater than 0.",BlowhornPlatformHackerNews:"The client may publish to Hacker News; granted when quantity is greater than 0.",BlowhornPlatformSlack:"The client may publish to Slack; granted when quantity is greater than 0.",BlowhornPlatformBluesky:"The client may publish to Bluesky; granted when quantity is greater than 0.",BlowhornPlatformGitHub:"The client may publish to GitHub; granted when quantity is greater than 0.",BlowhornPlatformBlog:"The client 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-oapi-codegen-extra-tags":{db:"created_at",yaml:"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-go-type-skip-optional-pointer":true},updated_at:{"x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"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-go-type-skip-optional-pointer":true}}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/entitlement/subscriptions/organizations/{orgId}/features":{get:{"x-internal":["cloud"],tags:["Features"],summary:"Get the active features entitled to an organization through its subscriptions",description:"Returns the features the organization's active subscriptions entitle it to. When `X-Current-Orgid` is also sent, it must name the same organization as `orgId`; a mismatch is refused with a 400 (the organization selector in docs/mcp-operation-contract.md). When `X-Current-Orgid` is omitted, `orgId` must name the organization the call acts in (the session's selected organization); a mismatch is refused with a 403.\n",operationId:"getFeaturesByOrganization","x-mcp":{expose:true,title:"Get the features of an organization",scope:"account:read",description:"Read-only. Returns the features the organization's active subscriptions entitle it to. When `X-Current-Orgid` is also sent, it must name the same organization as `orgId`; a mismatch is refused with a 400 (the organization selector in docs/mcp-operation-contract.md). When `X-Current-Orgid` is omitted, `orgId` must name the organization the call acts in (the session's selected organization); a mismatch is refused with a 403."},parameters:[{name:"orgId",in:"path",description:"The ID of the organization",required:true,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:"X-Current-Orgid",in:"header",required:false,description:"Organization the call acts in, by ID (a UUID). When present, the server resolves the session organization from it instead of the caller's selected organization, and runs its membership and permission checks there. A caller who is not a live member of the named organization receives the same 404 as an unknown resource. Omitted, the caller's selected organization applies.",schema:{type:"string",minLength:36,maxLength:36,pattern:"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}}],responses:{200:{description:"Features response",content:{"application/json":{schema:{type:"array",description:"List of features.",items:{"x-go-type":"Feature",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:{description:"Unique identifier for the plan.","x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},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 posting profiles the organization may hold; 999999999999 is unlimited.",BlowhornBrowserAutomation:"The client may publish through browser automation; granted when quantity is greater than 0.",BlowhornScheduler:"The client may run scheduled publishes; granted when quantity is greater than 0.",BlowhornDevicesPerSeat:"Maximum number of devices one seat may publish from; 999999999999 is unlimited.",BlowhornPlatformLinkedIn:"The client may publish to LinkedIn; granted when quantity is greater than 0.",BlowhornPlatformX:"The client may publish to X; granted when quantity is greater than 0.",BlowhornPlatformReddit:"The client may publish to Reddit; granted when quantity is greater than 0.",BlowhornPlatformHackerNews:"The client may publish to Hacker News; granted when quantity is greater than 0.",BlowhornPlatformSlack:"The client may publish to Slack; granted when quantity is greater than 0.",BlowhornPlatformBluesky:"The client may publish to Bluesky; granted when quantity is greater than 0.",BlowhornPlatformGitHub:"The client may publish to GitHub; granted when quantity is greater than 0.",BlowhornPlatformBlog:"The client 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-oapi-codegen-extra-tags":{db:"created_at",yaml:"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-go-type-skip-optional-pointer":true},updated_at:{"x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"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-go-type-skip-optional-pointer":true}}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}}},components:{responses:{400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}},parameters:{currentOrgId:{name:"X-Current-Orgid",in:"header",required:false,description:"Organization the call acts in, by ID (a UUID). When present, the server resolves the session organization from it instead of the caller's selected organization, and runs its membership and permission checks there. A caller who is not a live member of the named organization receives the same 404 as an unknown resource. Omitted, the caller's selected organization applies.",schema:{type:"string",minLength:36,maxLength:36,pattern:"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}},orgId:{name:"orgId",in:"path",description:"The ID of the organization",required:true,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"}}},page:{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},pagesize:{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}}},securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},schemas:{Feature:{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:{description:"Unique identifier for the plan.","x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},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 posting profiles the organization may hold; 999999999999 is unlimited.",BlowhornBrowserAutomation:"The client may publish through browser automation; granted when quantity is greater than 0.",BlowhornScheduler:"The client may run scheduled publishes; granted when quantity is greater than 0.",BlowhornDevicesPerSeat:"Maximum number of devices one seat may publish from; 999999999999 is unlimited.",BlowhornPlatformLinkedIn:"The client may publish to LinkedIn; granted when quantity is greater than 0.",BlowhornPlatformX:"The client may publish to X; granted when quantity is greater than 0.",BlowhornPlatformReddit:"The client may publish to Reddit; granted when quantity is greater than 0.",BlowhornPlatformHackerNews:"The client may publish to Hacker News; granted when quantity is greater than 0.",BlowhornPlatformSlack:"The client may publish to Slack; granted when quantity is greater than 0.",BlowhornPlatformBluesky:"The client may publish to Bluesky; granted when quantity is greater than 0.",BlowhornPlatformGitHub:"The client may publish to GitHub; granted when quantity is greater than 0.",BlowhornPlatformBlog:"The client 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-oapi-codegen-extra-tags":{db:"created_at",yaml:"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-go-type-skip-optional-pointer":true},updated_at:{"x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"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-go-type-skip-optional-pointer":true}}},FeatureName:{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 posting profiles the organization may hold; 999999999999 is unlimited.",BlowhornBrowserAutomation:"The client may publish through browser automation; granted when quantity is greater than 0.",BlowhornScheduler:"The client may run scheduled publishes; granted when quantity is greater than 0.",BlowhornDevicesPerSeat:"Maximum number of devices one seat may publish from; 999999999999 is unlimited.",BlowhornPlatformLinkedIn:"The client may publish to LinkedIn; granted when quantity is greater than 0.",BlowhornPlatformX:"The client may publish to X; granted when quantity is greater than 0.",BlowhornPlatformReddit:"The client may publish to Reddit; granted when quantity is greater than 0.",BlowhornPlatformHackerNews:"The client may publish to Hacker News; granted when quantity is greater than 0.",BlowhornPlatformSlack:"The client may publish to Slack; granted when quantity is greater than 0.",BlowhornPlatformBluesky:"The client may publish to Bluesky; granted when quantity is greater than 0.",BlowhornPlatformGitHub:"The client may publish to GitHub; granted when quantity is greater than 0.",BlowhornPlatformBlog:"The client may publish to a blog; granted when quantity is greater than 0."},description:"Enumeration of feature names that can be granted by a plan. A feature is either a cap, where `quantity` is the maximum and 999999999999 denotes unlimited, or a capability, where any `quantity` greater than 0 grants it. A feature a plan does not list is not granted."},FeaturesPage:{type:"array",description:"List of features.",items:{"x-go-type":"Feature",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:{description:"Unique identifier for the plan.","x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},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 posting profiles the organization may hold; 999999999999 is unlimited.",BlowhornBrowserAutomation:"The client may publish through browser automation; granted when quantity is greater than 0.",BlowhornScheduler:"The client may run scheduled publishes; granted when quantity is greater than 0.",BlowhornDevicesPerSeat:"Maximum number of devices one seat may publish from; 999999999999 is unlimited.",BlowhornPlatformLinkedIn:"The client may publish to LinkedIn; granted when quantity is greater than 0.",BlowhornPlatformX:"The client may publish to X; granted when quantity is greater than 0.",BlowhornPlatformReddit:"The client may publish to Reddit; granted when quantity is greater than 0.",BlowhornPlatformHackerNews:"The client may publish to Hacker News; granted when quantity is greater than 0.",BlowhornPlatformSlack:"The client may publish to Slack; granted when quantity is greater than 0.",BlowhornPlatformBluesky:"The client may publish to Bluesky; granted when quantity is greater than 0.",BlowhornPlatformGitHub:"The client may publish to GitHub; granted when quantity is greater than 0.",BlowhornPlatformBlog:"The client 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-oapi-codegen-extra-tags":{db:"created_at",yaml:"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-go-type-skip-optional-pointer":true},updated_at:{"x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"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-go-type-skip-optional-pointer":true}}}}}}},t=e;
|
|
1
|
+
var e={openapi:"3.0.0",info:{title:"Feature",description:"OpenAPI schema for the Features construct - the quantified entitlements granted by Meshery Cloud subscription plans.",version:"v1beta1",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:"Features",description:"Operations related to features and entitlements"}],paths:{"/api/entitlement/features":{get:{"x-internal":["cloud"],tags:["Features"],summary:"Get all features defined across plans",operationId:"getFeatures",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}}],responses:{200:{description:"Features response",content:{"application/json":{schema:{type:"array",description:"List of features.",items:{"x-go-type":"Feature",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:{description:"Unique identifier for the plan.","x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},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 posting profiles the organization may hold; 999999999999 is unlimited.",BlowhornBrowserAutomation:"The client may publish through browser automation; granted when quantity is greater than 0.",BlowhornScheduler:"The client may run scheduled publishes; granted when quantity is greater than 0.",BlowhornDevicesPerSeat:"Maximum number of devices one seat may publish from; 999999999999 is unlimited.",BlowhornPlatformLinkedIn:"The client may publish to LinkedIn; granted when quantity is greater than 0.",BlowhornPlatformX:"The client may publish to X; granted when quantity is greater than 0.",BlowhornPlatformReddit:"The client may publish to Reddit; granted when quantity is greater than 0.",BlowhornPlatformHackerNews:"The client may publish to Hacker News; granted when quantity is greater than 0.",BlowhornPlatformSlack:"The client may publish to Slack; granted when quantity is greater than 0.",BlowhornPlatformBluesky:"The client may publish to Bluesky; granted when quantity is greater than 0.",BlowhornPlatformGitHub:"The client may publish to GitHub; granted when quantity is greater than 0.",BlowhornPlatformBlog:"The client 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-oapi-codegen-extra-tags":{db:"created_at",yaml:"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-go-type-skip-optional-pointer":true},updated_at:{"x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"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-go-type-skip-optional-pointer":true}}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/entitlement/subscriptions/organizations/{orgId}/features":{get:{"x-internal":["cloud"],tags:["Features"],summary:"Get the active features entitled to an organization through its subscriptions",description:"Returns the features the organization's active subscriptions entitle it to. When `X-Current-Orgid` is also sent, it must name the same organization as `orgId`; a mismatch is refused with a 400 (the organization selector in docs/mcp-operation-contract.md). When `X-Current-Orgid` is omitted, the path `orgId` names the acting organization (subject to the live-membership rule) and does not have to equal a selected organization.\n",operationId:"getFeaturesByOrganization","x-mcp":{expose:true,title:"Get the features of an organization",scope:"account:read",description:"Read-only. Returns the features the organization's active subscriptions entitle it to. When `X-Current-Orgid` is also sent, it must name the same organization as `orgId`; a mismatch is refused with a 400 (the organization selector in docs/mcp-operation-contract.md). When `X-Current-Orgid` is omitted, the path `orgId` names the acting organization (subject to the live-membership rule) and does not have to equal a selected organization."},parameters:[{name:"orgId",in:"path",description:"The ID of the organization",required:true,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:"X-Current-Orgid",in:"header",required:false,description:"Organization the call acts in, by ID (a UUID). When present, the server resolves the session organization from it instead of the caller's selected organization, and runs its membership and permission checks there. A caller who is not a live member of the named organization receives the same 404 as an unknown resource. Omitted, a path or query `orgId` the operation takes names the organization when sent; otherwise the caller's selected organization applies when it is not nil; otherwise the server defaults among the caller's live organizations, using the only one when exactly one qualifies. When the call needs an acting organization and several qualify, an operation that declares the OrganizationSelectionRequired response answers 409 `organization_selection_required`. The resolution order is in docs/mcp-operation-contract.md, the organization selector.",schema:{type:"string",minLength:36,maxLength:36,pattern:"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}}],responses:{200:{description:"Features response",content:{"application/json":{schema:{type:"array",description:"List of features.",items:{"x-go-type":"Feature",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:{description:"Unique identifier for the plan.","x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},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 posting profiles the organization may hold; 999999999999 is unlimited.",BlowhornBrowserAutomation:"The client may publish through browser automation; granted when quantity is greater than 0.",BlowhornScheduler:"The client may run scheduled publishes; granted when quantity is greater than 0.",BlowhornDevicesPerSeat:"Maximum number of devices one seat may publish from; 999999999999 is unlimited.",BlowhornPlatformLinkedIn:"The client may publish to LinkedIn; granted when quantity is greater than 0.",BlowhornPlatformX:"The client may publish to X; granted when quantity is greater than 0.",BlowhornPlatformReddit:"The client may publish to Reddit; granted when quantity is greater than 0.",BlowhornPlatformHackerNews:"The client may publish to Hacker News; granted when quantity is greater than 0.",BlowhornPlatformSlack:"The client may publish to Slack; granted when quantity is greater than 0.",BlowhornPlatformBluesky:"The client may publish to Bluesky; granted when quantity is greater than 0.",BlowhornPlatformGitHub:"The client may publish to GitHub; granted when quantity is greater than 0.",BlowhornPlatformBlog:"The client 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-oapi-codegen-extra-tags":{db:"created_at",yaml:"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-go-type-skip-optional-pointer":true},updated_at:{"x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"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-go-type-skip-optional-pointer":true}}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}}},components:{responses:{400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}},parameters:{currentOrgId:{name:"X-Current-Orgid",in:"header",required:false,description:"Organization the call acts in, by ID (a UUID). When present, the server resolves the session organization from it instead of the caller's selected organization, and runs its membership and permission checks there. A caller who is not a live member of the named organization receives the same 404 as an unknown resource. Omitted, a path or query `orgId` the operation takes names the organization when sent; otherwise the caller's selected organization applies when it is not nil; otherwise the server defaults among the caller's live organizations, using the only one when exactly one qualifies. When the call needs an acting organization and several qualify, an operation that declares the OrganizationSelectionRequired response answers 409 `organization_selection_required`. The resolution order is in docs/mcp-operation-contract.md, the organization selector.",schema:{type:"string",minLength:36,maxLength:36,pattern:"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}},orgId:{name:"orgId",in:"path",description:"The ID of the organization",required:true,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"}}},page:{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},pagesize:{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}}},securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},schemas:{Feature:{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:{description:"Unique identifier for the plan.","x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},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 posting profiles the organization may hold; 999999999999 is unlimited.",BlowhornBrowserAutomation:"The client may publish through browser automation; granted when quantity is greater than 0.",BlowhornScheduler:"The client may run scheduled publishes; granted when quantity is greater than 0.",BlowhornDevicesPerSeat:"Maximum number of devices one seat may publish from; 999999999999 is unlimited.",BlowhornPlatformLinkedIn:"The client may publish to LinkedIn; granted when quantity is greater than 0.",BlowhornPlatformX:"The client may publish to X; granted when quantity is greater than 0.",BlowhornPlatformReddit:"The client may publish to Reddit; granted when quantity is greater than 0.",BlowhornPlatformHackerNews:"The client may publish to Hacker News; granted when quantity is greater than 0.",BlowhornPlatformSlack:"The client may publish to Slack; granted when quantity is greater than 0.",BlowhornPlatformBluesky:"The client may publish to Bluesky; granted when quantity is greater than 0.",BlowhornPlatformGitHub:"The client may publish to GitHub; granted when quantity is greater than 0.",BlowhornPlatformBlog:"The client 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-oapi-codegen-extra-tags":{db:"created_at",yaml:"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-go-type-skip-optional-pointer":true},updated_at:{"x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"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-go-type-skip-optional-pointer":true}}},FeatureName:{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 posting profiles the organization may hold; 999999999999 is unlimited.",BlowhornBrowserAutomation:"The client may publish through browser automation; granted when quantity is greater than 0.",BlowhornScheduler:"The client may run scheduled publishes; granted when quantity is greater than 0.",BlowhornDevicesPerSeat:"Maximum number of devices one seat may publish from; 999999999999 is unlimited.",BlowhornPlatformLinkedIn:"The client may publish to LinkedIn; granted when quantity is greater than 0.",BlowhornPlatformX:"The client may publish to X; granted when quantity is greater than 0.",BlowhornPlatformReddit:"The client may publish to Reddit; granted when quantity is greater than 0.",BlowhornPlatformHackerNews:"The client may publish to Hacker News; granted when quantity is greater than 0.",BlowhornPlatformSlack:"The client may publish to Slack; granted when quantity is greater than 0.",BlowhornPlatformBluesky:"The client may publish to Bluesky; granted when quantity is greater than 0.",BlowhornPlatformGitHub:"The client may publish to GitHub; granted when quantity is greater than 0.",BlowhornPlatformBlog:"The client may publish to a blog; granted when quantity is greater than 0."},description:"Enumeration of feature names that can be granted by a plan. A feature is either a cap, where `quantity` is the maximum and 999999999999 denotes unlimited, or a capability, where any `quantity` greater than 0 grants it. A feature a plan does not list is not granted."},FeaturesPage:{type:"array",description:"List of features.",items:{"x-go-type":"Feature",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:{description:"Unique identifier for the plan.","x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},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 posting profiles the organization may hold; 999999999999 is unlimited.",BlowhornBrowserAutomation:"The client may publish through browser automation; granted when quantity is greater than 0.",BlowhornScheduler:"The client may run scheduled publishes; granted when quantity is greater than 0.",BlowhornDevicesPerSeat:"Maximum number of devices one seat may publish from; 999999999999 is unlimited.",BlowhornPlatformLinkedIn:"The client may publish to LinkedIn; granted when quantity is greater than 0.",BlowhornPlatformX:"The client may publish to X; granted when quantity is greater than 0.",BlowhornPlatformReddit:"The client may publish to Reddit; granted when quantity is greater than 0.",BlowhornPlatformHackerNews:"The client may publish to Hacker News; granted when quantity is greater than 0.",BlowhornPlatformSlack:"The client may publish to Slack; granted when quantity is greater than 0.",BlowhornPlatformBluesky:"The client may publish to Bluesky; granted when quantity is greater than 0.",BlowhornPlatformGitHub:"The client may publish to GitHub; granted when quantity is greater than 0.",BlowhornPlatformBlog:"The client 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-oapi-codegen-extra-tags":{db:"created_at",yaml:"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-go-type-skip-optional-pointer":true},updated_at:{"x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"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-go-type-skip-optional-pointer":true}}}}}}},t=e;
|
|
2
2
|
export{t as default};
|
|
@@ -669,6 +669,28 @@ export interface components {
|
|
|
669
669
|
/** @description The sentence the caller is shown. */
|
|
670
670
|
message: string;
|
|
671
671
|
};
|
|
672
|
+
/** @description The call needs an acting organization, the caller named none, and more than one of the caller's live organizations qualifies. Nothing was done by this request. Repeat it naming one of `choices` as `X-Current-Orgid` (the `organizationId` tool argument). */
|
|
673
|
+
OrganizationSelectionRequiredError: {
|
|
674
|
+
/**
|
|
675
|
+
* @description Machine-readable reason. Always `organization_selection_required` for this body.
|
|
676
|
+
* @enum {string}
|
|
677
|
+
*/
|
|
678
|
+
code: "organization_selection_required";
|
|
679
|
+
/** @description The sentence the caller is shown. */
|
|
680
|
+
message: string;
|
|
681
|
+
/** @description The caller's own live organizations the call could act in. Pass one `id` as `X-Current-Orgid`. */
|
|
682
|
+
choices: {
|
|
683
|
+
/**
|
|
684
|
+
* Format: uuid
|
|
685
|
+
* @description Organization ID.
|
|
686
|
+
*/
|
|
687
|
+
id: string;
|
|
688
|
+
/** @description Name of the organization. */
|
|
689
|
+
name: string;
|
|
690
|
+
/** @description Description of the organization. */
|
|
691
|
+
description: string;
|
|
692
|
+
}[];
|
|
693
|
+
};
|
|
672
694
|
/** @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. */
|
|
673
695
|
MeshkitError: {
|
|
674
696
|
/** @description The sentence the caller is shown. */
|
|
@@ -793,6 +815,35 @@ export interface components {
|
|
|
793
815
|
};
|
|
794
816
|
};
|
|
795
817
|
};
|
|
818
|
+
/** @description Conflict - the call needs an organization, none was named, and more than one of the caller's organizations qualifies. Pass one of `choices[].id` as `X-Current-Orgid` (the `organizationId` tool argument). The body's `code` is `organization_selection_required`. */
|
|
819
|
+
OrganizationSelectionRequired: {
|
|
820
|
+
headers: {
|
|
821
|
+
[name: string]: unknown;
|
|
822
|
+
};
|
|
823
|
+
content: {
|
|
824
|
+
"application/json": {
|
|
825
|
+
/**
|
|
826
|
+
* @description Machine-readable reason. Always `organization_selection_required` for this body.
|
|
827
|
+
* @enum {string}
|
|
828
|
+
*/
|
|
829
|
+
code: "organization_selection_required";
|
|
830
|
+
/** @description The sentence the caller is shown. */
|
|
831
|
+
message: string;
|
|
832
|
+
/** @description The caller's own live organizations the call could act in. Pass one `id` as `X-Current-Orgid`. */
|
|
833
|
+
choices: {
|
|
834
|
+
/**
|
|
835
|
+
* Format: uuid
|
|
836
|
+
* @description Organization ID.
|
|
837
|
+
*/
|
|
838
|
+
id: string;
|
|
839
|
+
/** @description Name of the organization. */
|
|
840
|
+
name: string;
|
|
841
|
+
/** @description Description of the organization. */
|
|
842
|
+
description: string;
|
|
843
|
+
}[];
|
|
844
|
+
};
|
|
845
|
+
};
|
|
846
|
+
};
|
|
796
847
|
/** @description Invalid request body or request param */
|
|
797
848
|
MeshkitError400: {
|
|
798
849
|
headers: {
|
|
@@ -1012,7 +1063,7 @@ export interface components {
|
|
|
1012
1063
|
contentType: string;
|
|
1013
1064
|
/** @description Filter catalog data based on technology(compatibility) of content e.g (kubernetes, istio...) multiple params can be passed */
|
|
1014
1065
|
contentTechnology: string;
|
|
1015
|
-
/** @description Organization the call acts in, by ID (a UUID). When present, the server resolves the session organization from it instead of the caller's selected organization, and runs its membership and permission checks there. A caller who is not a live member of the named organization receives the same 404 as an unknown resource. Omitted, the caller's selected organization applies. */
|
|
1066
|
+
/** @description Organization the call acts in, by ID (a UUID). When present, the server resolves the session organization from it instead of the caller's selected organization, and runs its membership and permission checks there. A caller who is not a live member of the named organization receives the same 404 as an unknown resource. Omitted, a path or query `orgId` the operation takes names the organization when sent; otherwise the caller's selected organization applies when it is not nil; otherwise the server defaults among the caller's live organizations, using the only one when exactly one qualifies. When the call needs an acting organization and several qualify, an operation that declares the OrganizationSelectionRequired response answers 409 `organization_selection_required`. The resolution order is in docs/mcp-operation-contract.md, the organization selector. */
|
|
1016
1067
|
currentOrgId: string;
|
|
1017
1068
|
/** @description Client-chosen key that makes a create safe to retry. The server keeps the organization, the user, the key, a hash of the request and the final response for 24 hours. Only a final response that is not a 5xx is stored. The server answers a 5xx only after it has rolled back the write; a 5xx it answers is not stored and releases the key's claim, so a retry with the same key is processed as new. A response the server has committed is final and is stored, even if a gateway in front of the server later fails the client's connection. A retry with the same key and the same request hash returns the stored response without creating anything again. A retry with the same key and a different request hash answers 422 and creates nothing. A retry with the same key that arrives while the earlier request with that key is still being processed answers 409 with the body `code` `idempotency_key_in_flight` and creates nothing. Once the first request has finished without a 5xx, a retry receives the stored response; after a 5xx, a retry is processed as new. Precedence: while the first request with a key is in flight, every retry with that key answers 409 whatever its body; only once the first request has finished does a retry with a different body answer 422. The in-flight claim of a request that never finished expires 24 hours after it was taken, the same TTL as the stored response; no shorter in-flight lease applies. A retry after that expiry is processed as new. Omitted, the create is not deduplicated. Use a fresh random value (a UUID) per intended create. */
|
|
1018
1069
|
idempotencyKey: string;
|