@meshery/schemas 0.8.127 → 0.8.128

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.
Files changed (111) hide show
  1. package/dist/cloudApi.d.mts +631 -631
  2. package/dist/cloudApi.d.ts +631 -631
  3. package/dist/cloudApi.js +1 -1
  4. package/dist/cloudApi.mjs +1 -1
  5. package/dist/constructs/v1alpha1/capability/CapabilitySchema.d.mts +12 -2
  6. package/dist/constructs/v1alpha1/capability/CapabilitySchema.d.ts +12 -2
  7. package/dist/constructs/v1alpha1/capability/CapabilitySchema.js +1 -1
  8. package/dist/constructs/v1alpha1/capability/CapabilitySchema.mjs +1 -1
  9. package/dist/constructs/v1alpha1/core/CoreSchema.d.mts +11 -2
  10. package/dist/constructs/v1alpha1/core/CoreSchema.d.ts +11 -2
  11. package/dist/constructs/v1alpha1/core/CoreSchema.js +1 -1
  12. package/dist/constructs/v1alpha1/core/CoreSchema.mjs +1 -1
  13. package/dist/constructs/v1alpha2/catalog/CatalogSchema.d.mts +12 -2
  14. package/dist/constructs/v1alpha2/catalog/CatalogSchema.d.ts +12 -2
  15. package/dist/constructs/v1alpha2/catalog/CatalogSchema.js +1 -1
  16. package/dist/constructs/v1alpha2/catalog/CatalogSchema.mjs +1 -1
  17. package/dist/constructs/v1alpha3/relationship/RelationshipSchema.d.mts +12 -2
  18. package/dist/constructs/v1alpha3/relationship/RelationshipSchema.d.ts +12 -2
  19. package/dist/constructs/v1alpha3/relationship/RelationshipSchema.js +1 -1
  20. package/dist/constructs/v1alpha3/relationship/RelationshipSchema.mjs +1 -1
  21. package/dist/constructs/v1beta1/academy/AcademySchema.d.mts +11 -1
  22. package/dist/constructs/v1beta1/academy/AcademySchema.d.ts +11 -1
  23. package/dist/constructs/v1beta1/academy/AcademySchema.js +1 -1
  24. package/dist/constructs/v1beta1/academy/AcademySchema.mjs +1 -1
  25. package/dist/constructs/v1beta1/badge/BadgeSchema.d.mts +11 -2
  26. package/dist/constructs/v1beta1/badge/BadgeSchema.d.ts +11 -2
  27. package/dist/constructs/v1beta1/badge/BadgeSchema.js +1 -1
  28. package/dist/constructs/v1beta1/badge/BadgeSchema.mjs +1 -1
  29. package/dist/constructs/v1beta1/category/CategorySchema.d.mts +12 -2
  30. package/dist/constructs/v1beta1/category/CategorySchema.d.ts +12 -2
  31. package/dist/constructs/v1beta1/category/CategorySchema.js +1 -1
  32. package/dist/constructs/v1beta1/category/CategorySchema.mjs +1 -1
  33. package/dist/constructs/v1beta1/component/ComponentSchema.d.mts +12 -2
  34. package/dist/constructs/v1beta1/component/ComponentSchema.d.ts +12 -2
  35. package/dist/constructs/v1beta1/component/ComponentSchema.js +1 -1
  36. package/dist/constructs/v1beta1/component/ComponentSchema.mjs +1 -1
  37. package/dist/constructs/v1beta1/connection/ConnectionSchema.d.mts +10 -10
  38. package/dist/constructs/v1beta1/connection/ConnectionSchema.d.ts +10 -10
  39. package/dist/constructs/v1beta1/connection/ConnectionSchema.js +1 -1
  40. package/dist/constructs/v1beta1/connection/ConnectionSchema.mjs +1 -1
  41. package/dist/constructs/v1beta1/environment/EnvironmentSchema.d.mts +11 -11
  42. package/dist/constructs/v1beta1/environment/EnvironmentSchema.d.ts +11 -11
  43. package/dist/constructs/v1beta1/environment/EnvironmentSchema.js +1 -1
  44. package/dist/constructs/v1beta1/environment/EnvironmentSchema.mjs +1 -1
  45. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.d.mts +12 -3
  46. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.d.ts +12 -3
  47. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.js +1 -1
  48. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.mjs +1 -1
  49. package/dist/constructs/v1beta1/event/EventSchema.d.mts +12 -2
  50. package/dist/constructs/v1beta1/event/EventSchema.d.ts +12 -2
  51. package/dist/constructs/v1beta1/event/EventSchema.js +2 -1
  52. package/dist/constructs/v1beta1/event/EventSchema.mjs +2 -1
  53. package/dist/constructs/v1beta1/feature/FeatureSchema.d.mts +11 -2
  54. package/dist/constructs/v1beta1/feature/FeatureSchema.d.ts +11 -2
  55. package/dist/constructs/v1beta1/feature/FeatureSchema.js +2 -1
  56. package/dist/constructs/v1beta1/feature/FeatureSchema.mjs +2 -1
  57. package/dist/constructs/v1beta1/invitation/InvitationSchema.d.mts +11 -2
  58. package/dist/constructs/v1beta1/invitation/InvitationSchema.d.ts +11 -2
  59. package/dist/constructs/v1beta1/invitation/InvitationSchema.js +2 -1
  60. package/dist/constructs/v1beta1/invitation/InvitationSchema.mjs +2 -1
  61. package/dist/constructs/v1beta1/key/KeySchema.d.mts +12 -2
  62. package/dist/constructs/v1beta1/key/KeySchema.d.ts +12 -2
  63. package/dist/constructs/v1beta1/key/KeySchema.js +2 -1
  64. package/dist/constructs/v1beta1/key/KeySchema.mjs +2 -1
  65. package/dist/constructs/v1beta1/keychain/KeychainSchema.d.mts +12 -2
  66. package/dist/constructs/v1beta1/keychain/KeychainSchema.d.ts +12 -2
  67. package/dist/constructs/v1beta1/keychain/KeychainSchema.js +2 -1
  68. package/dist/constructs/v1beta1/keychain/KeychainSchema.mjs +2 -1
  69. package/dist/constructs/v1beta1/model/ModelSchema.d.mts +12 -2
  70. package/dist/constructs/v1beta1/model/ModelSchema.d.ts +12 -2
  71. package/dist/constructs/v1beta1/model/ModelSchema.js +1 -1
  72. package/dist/constructs/v1beta1/model/ModelSchema.mjs +1 -1
  73. package/dist/constructs/v1beta1/organization/OrganizationSchema.d.mts +11 -1
  74. package/dist/constructs/v1beta1/organization/OrganizationSchema.d.ts +11 -1
  75. package/dist/constructs/v1beta1/organization/OrganizationSchema.js +2 -1
  76. package/dist/constructs/v1beta1/organization/OrganizationSchema.mjs +2 -1
  77. package/dist/constructs/v1beta1/pattern/PatternSchema.d.mts +12 -2
  78. package/dist/constructs/v1beta1/pattern/PatternSchema.d.ts +12 -2
  79. package/dist/constructs/v1beta1/pattern/PatternSchema.js +1 -1
  80. package/dist/constructs/v1beta1/pattern/PatternSchema.mjs +1 -1
  81. package/dist/constructs/v1beta1/plan/PlanSchema.d.mts +12 -2
  82. package/dist/constructs/v1beta1/plan/PlanSchema.d.ts +12 -2
  83. package/dist/constructs/v1beta1/plan/PlanSchema.js +2 -1
  84. package/dist/constructs/v1beta1/plan/PlanSchema.mjs +2 -1
  85. package/dist/constructs/v1beta1/subcategory/SubcategorySchema.d.mts +11 -1
  86. package/dist/constructs/v1beta1/subcategory/SubcategorySchema.d.ts +11 -1
  87. package/dist/constructs/v1beta1/subcategory/SubcategorySchema.js +1 -1
  88. package/dist/constructs/v1beta1/subcategory/SubcategorySchema.mjs +1 -1
  89. package/dist/constructs/v1beta1/subscription/SubscriptionSchema.d.mts +11 -2
  90. package/dist/constructs/v1beta1/subscription/SubscriptionSchema.d.ts +11 -2
  91. package/dist/constructs/v1beta1/subscription/SubscriptionSchema.js +1 -1
  92. package/dist/constructs/v1beta1/subscription/SubscriptionSchema.mjs +1 -1
  93. package/dist/constructs/v1beta1/team/TeamSchema.d.mts +9 -3
  94. package/dist/constructs/v1beta1/team/TeamSchema.d.ts +9 -3
  95. package/dist/constructs/v1beta1/team/TeamSchema.js +1 -1
  96. package/dist/constructs/v1beta1/team/TeamSchema.mjs +1 -1
  97. package/dist/constructs/v1beta1/user/UserSchema.d.mts +12 -2
  98. package/dist/constructs/v1beta1/user/UserSchema.d.ts +12 -2
  99. package/dist/constructs/v1beta1/user/UserSchema.js +2 -1
  100. package/dist/constructs/v1beta1/user/UserSchema.mjs +2 -1
  101. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.d.mts +9 -3
  102. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.d.ts +9 -3
  103. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.js +1 -1
  104. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.mjs +1 -1
  105. package/dist/index.js +5 -5
  106. package/dist/index.mjs +5 -5
  107. package/dist/mesheryApi.d.mts +1988 -170
  108. package/dist/mesheryApi.d.ts +1988 -170
  109. package/dist/mesheryApi.js +1 -1
  110. package/dist/mesheryApi.mjs +1 -1
  111. package/package.json +1 -1
@@ -1,2 +1,2 @@
1
- var e={openapi:"3.0.0",info:{title:"environment",description:"Documentation for meshery Cloud REST APIs",contact:{email:"maintainers@meshery.io"},version:"v0.6.394"},servers:[{url:"https://cloud.meshery.io",description:"Meshery Cloud production server URL"},{url:"https://staging-cloud.meshery.io",description:"Meshery Cloud staging server URL"},{url:"http://localhost:9876",description:"Meshery Cloud development server URL (controlled via PORT environment variable)"}],security:[{jwt:[]}],tags:[{name:"environments",description:"APIs for environments"}],components:{responses:{200:{description:"ok",content:{"text/plain":{schema:{type:"string"}}}},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"}}}}},parameters:{environmentId:{name:"environmentId",in:"path",description:"Environment ID",schema:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},required:true},search:{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},order:{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},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"}},orgIDQuery:{name:"orgID",in:"query",description:"User's organization ID",schema:{type:"string"},required:true}},securitySchemes:{jwt:{type:"http",scheme:"Bearer",bearerFormat:"JWT"}},schemas:{environment:{$id:"https://schemas.meshery.io/environment.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Meshery Environments allow you to logically group related Connections and their associated Credentials.. Learn more at https://docs.meshery.io/concepts/logical/environments",additionalProperties:false,type:"object",required:["id","schemaVersion","name","description","organization_id"],properties:{id:{description:"ID","x-order":1,"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",yaml:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},schemaVersion:{description:"Specifies the version of the schema to which the environment conforms.","x-order":2,"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",db:"-",gorm:"-"},default:"environments.meshery.io/v1beta1",type:"string",minLength:2,maxLength:100,pattern:"^([a-z][a-z0-9.-]*\\/)?v(alpha|beta|[0-9]+)([.-][a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix","models.meshery.io/v1beta1","capability.meshery.io/v1alpha1"]},name:{"x-oapi-codegen-extra-tags":{db:"name",yaml:"name"},"x-order":3,type:"string",description:"Environment name"},description:{"x-oapi-codegen-extra-tags":{db:"description",yaml:"description"},"x-order":4,type:"string",description:"Environment description"},organization_id:{"x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id",yaml:"organization_id"},"x-order":5,description:"Environment organization ID",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},owner:{"x-oapi-codegen-extra-tags":{db:"owner",yaml:"owner"},"x-order":6,description:"Environment owner",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},created_at:{"x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},metadata:{"x-oapi-codegen-extra-tags":{db:"metadata",yaml:"metadata"},"x-order":8,"x-go-type":"core.Map","x-go-type-skip-optional-pointer":true,type:"object"},updated_at:{"x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at",yaml:"deleted_at"},"x-go-type":"core.NullTime","x-go-import":"database/sql","x-order":10,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},environmentConnectionMapping:{properties:{ID:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-go-type-name":"GeneralId","x-go-type-skip-optional-pointer":true},environment_id:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"environment_id",json:"environment_id"},"x-go-type-skip-optional-pointer":true},connection_id:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"connection_id",json:"connection_id"},"x-go-type-skip-optional-pointer":true},created_at:{type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updated_at:{type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deleted_at:{description:"SQL null Timestamp to handle null values of time.","x-go-type":"sql.NullTime",type:"string","x-go-type-skip-optional-pointer":true}}},environmentPayload:{properties:{name:{description:"An environment is a collection of resources. Provide a name that meaningfully represents these resources. You can change the name of the environment even after its creation.",type:"string","x-go-type-skip-optional-pointer":true},description:{description:"An environment is a collection of resources, such as connections & credentail. Provide a detailed description to clarify the purpose of this environment and the types of resources it encompasses. You can modify the description at any Time. Learn more about environments [here](https://docs.meshery.io/concepts/logical/environments).",type:"string","x-go-type-skip-optional-pointer":true},OrganizationID:{type:"string",description:"Select an organization in which you want to create this new environment. Keep in mind that the organization cannot be changed after creation.","x-go-type-skip-optional-pointer":true,"x-go-name":"OrgId","x-oapi-codegen-extra-tags":{json:"organization_id"}}},required:["name","organizationID"]},environmentPage:{properties:{page:{type:"integer","x-go-type-skip-optional-pointer":true},page_size:{type:"integer","x-go-type-skip-optional-pointer":true},total_count:{type:"integer","x-go-type-skip-optional-pointer":true},environments:{type:"array","x-go-type-skip-optional-pointer":true,items:{"x-go-type":"Environment",$id:"https://schemas.meshery.io/environment.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Meshery Environments allow you to logically group related Connections and their associated Credentials.. Learn more at https://docs.meshery.io/concepts/logical/environments",additionalProperties:false,type:"object",required:["id","schemaVersion","name","description","organization_id"],properties:{id:{description:"ID","x-order":1,"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",yaml:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},schemaVersion:{description:"Specifies the version of the schema to which the environment conforms.","x-order":2,"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",db:"-",gorm:"-"},default:"environments.meshery.io/v1beta1",type:"string",minLength:2,maxLength:100,pattern:"^([a-z][a-z0-9.-]*\\/)?v(alpha|beta|[0-9]+)([.-][a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix","models.meshery.io/v1beta1","capability.meshery.io/v1alpha1"]},name:{"x-oapi-codegen-extra-tags":{db:"name",yaml:"name"},"x-order":3,type:"string",description:"Environment name"},description:{"x-oapi-codegen-extra-tags":{db:"description",yaml:"description"},"x-order":4,type:"string",description:"Environment description"},organization_id:{"x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id",yaml:"organization_id"},"x-order":5,description:"Environment organization ID",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},owner:{"x-oapi-codegen-extra-tags":{db:"owner",yaml:"owner"},"x-order":6,description:"Environment owner",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},created_at:{"x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},metadata:{"x-oapi-codegen-extra-tags":{db:"metadata",yaml:"metadata"},"x-order":8,"x-go-type":"core.Map","x-go-type-skip-optional-pointer":true,type:"object"},updated_at:{"x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at",yaml:"deleted_at"},"x-go-type":"core.NullTime","x-go-import":"database/sql","x-order":10,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}}},requestBodies:{environmentPayload:{description:"Body for creating environment",required:true,content:{"application/json":{schema:{properties:{name:{description:"An environment is a collection of resources. Provide a name that meaningfully represents these resources. You can change the name of the environment even after its creation.",type:"string","x-go-type-skip-optional-pointer":true},description:{description:"An environment is a collection of resources, such as connections & credentail. Provide a detailed description to clarify the purpose of this environment and the types of resources it encompasses. You can modify the description at any Time. Learn more about environments [here](https://docs.meshery.io/concepts/logical/environments).",type:"string","x-go-type-skip-optional-pointer":true},OrganizationID:{type:"string",description:"Select an organization in which you want to create this new environment. Keep in mind that the organization cannot be changed after creation.","x-go-type-skip-optional-pointer":true,"x-go-name":"OrgId","x-oapi-codegen-extra-tags":{json:"organization_id"}}},required:["name","organizationID"]}}}}}},paths:{"/api/environments":{post:{tags:["environments"],operationId:"CreateEnvironment",summary:"Create an environment",description:"Creates a new environment",requestBody:{description:"Body for creating environment",required:true,content:{"application/json":{schema:{properties:{name:{description:"An environment is a collection of resources. Provide a name that meaningfully represents these resources. You can change the name of the environment even after its creation.",type:"string","x-go-type-skip-optional-pointer":true},description:{description:"An environment is a collection of resources, such as connections & credentail. Provide a detailed description to clarify the purpose of this environment and the types of resources it encompasses. You can modify the description at any Time. Learn more about environments [here](https://docs.meshery.io/concepts/logical/environments).",type:"string","x-go-type-skip-optional-pointer":true},OrganizationID:{type:"string",description:"Select an organization in which you want to create this new environment. Keep in mind that the organization cannot be changed after creation.","x-go-type-skip-optional-pointer":true,"x-go-name":"OrgId","x-oapi-codegen-extra-tags":{json:"organization_id"}}},required:["name","organizationID"]}}}},responses:{201:{description:"Created environment",content:{"application/json":{schema:{$id:"https://schemas.meshery.io/environment.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Meshery Environments allow you to logically group related Connections and their associated Credentials.. Learn more at https://docs.meshery.io/concepts/logical/environments",additionalProperties:false,type:"object",required:["id","schemaVersion","name","description","organization_id"],properties:{id:{description:"ID","x-order":1,"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",yaml:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},schemaVersion:{description:"Specifies the version of the schema to which the environment conforms.","x-order":2,"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",db:"-",gorm:"-"},default:"environments.meshery.io/v1beta1",type:"string",minLength:2,maxLength:100,pattern:"^([a-z][a-z0-9.-]*\\/)?v(alpha|beta|[0-9]+)([.-][a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix","models.meshery.io/v1beta1","capability.meshery.io/v1alpha1"]},name:{"x-oapi-codegen-extra-tags":{db:"name",yaml:"name"},"x-order":3,type:"string",description:"Environment name"},description:{"x-oapi-codegen-extra-tags":{db:"description",yaml:"description"},"x-order":4,type:"string",description:"Environment description"},organization_id:{"x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id",yaml:"organization_id"},"x-order":5,description:"Environment organization ID",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},owner:{"x-oapi-codegen-extra-tags":{db:"owner",yaml:"owner"},"x-order":6,description:"Environment owner",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},created_at:{"x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},metadata:{"x-oapi-codegen-extra-tags":{db:"metadata",yaml:"metadata"},"x-order":8,"x-go-type":"core.Map","x-go-type-skip-optional-pointer":true,type:"object"},updated_at:{"x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at",yaml:"deleted_at"},"x-go-type":"core.NullTime","x-go-import":"database/sql","x-order":10,type:"string",format:"date-time","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"}}}}}},get:{tags:["environments"],operationId:"GetEnvironments",summary:"Get all environments",description:"Gets all environments",parameters:[{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}},{name:"orgID",in:"query",description:"User's organization ID",schema:{type:"string"},required:true}],responses:{200:{description:"Environments",content:{"application/json":{schema:{properties:{page:{type:"integer","x-go-type-skip-optional-pointer":true},page_size:{type:"integer","x-go-type-skip-optional-pointer":true},total_count:{type:"integer","x-go-type-skip-optional-pointer":true},environments:{type:"array","x-go-type-skip-optional-pointer":true,items:{"x-go-type":"Environment",$id:"https://schemas.meshery.io/environment.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Meshery Environments allow you to logically group related Connections and their associated Credentials.. Learn more at https://docs.meshery.io/concepts/logical/environments",additionalProperties:false,type:"object",required:["id","schemaVersion","name","description","organization_id"],properties:{id:{description:"ID","x-order":1,"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",yaml:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},schemaVersion:{description:"Specifies the version of the schema to which the environment conforms.","x-order":2,"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",db:"-",gorm:"-"},default:"environments.meshery.io/v1beta1",type:"string",minLength:2,maxLength:100,pattern:"^([a-z][a-z0-9.-]*\\/)?v(alpha|beta|[0-9]+)([.-][a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix","models.meshery.io/v1beta1","capability.meshery.io/v1alpha1"]},name:{"x-oapi-codegen-extra-tags":{db:"name",yaml:"name"},"x-order":3,type:"string",description:"Environment name"},description:{"x-oapi-codegen-extra-tags":{db:"description",yaml:"description"},"x-order":4,type:"string",description:"Environment description"},organization_id:{"x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id",yaml:"organization_id"},"x-order":5,description:"Environment organization ID",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},owner:{"x-oapi-codegen-extra-tags":{db:"owner",yaml:"owner"},"x-order":6,description:"Environment owner",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},created_at:{"x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},metadata:{"x-oapi-codegen-extra-tags":{db:"metadata",yaml:"metadata"},"x-order":8,"x-go-type":"core.Map","x-go-type-skip-optional-pointer":true,type:"object"},updated_at:{"x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at",yaml:"deleted_at"},"x-go-type":"core.NullTime","x-go-import":"database/sql","x-order":10,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}}}}},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"}}}}}}}}},t=e;
1
+ var e={openapi:"3.0.0",info:{title:"Environment",description:"OpenAPI schema for environment management in Meshery Cloud.",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"}},servers:[{url:"http://localhost:9081",description:"Meshery Server development server URL (controlled via PORT environment variable)"}],security:[{jwt:[]}],tags:[{name:"environments",description:"APIs for environments"}],components:{responses:{200:{description:"ok",content:{"text/plain":{schema:{type:"string"}}}},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"}}}}},parameters:{environmentId:{name:"environmentId",in:"path",description:"Environment ID",schema:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},required:true},search:{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},order:{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},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"}},orgIDQuery:{name:"orgID",in:"query",description:"User's organization ID",schema:{type:"string"},required:true}},securitySchemes:{jwt:{type:"http",scheme:"Bearer",bearerFormat:"JWT"}},schemas:{environment:{$id:"https://schemas.meshery.io/environment.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Meshery Environments allow you to logically group related Connections and their associated Credentials.. Learn more at https://docs.meshery.io/concepts/logical/environments",additionalProperties:false,type:"object",required:["id","schemaVersion","name","description","organization_id"],properties:{id:{description:"ID","x-order":1,"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",yaml:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},schemaVersion:{description:"Specifies the version of the schema to which the environment conforms.","x-order":2,"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",db:"-",gorm:"-"},default:"environments.meshery.io/v1beta1",type:"string",minLength:2,maxLength:100,pattern:"^([a-z][a-z0-9.-]*\\/)?v(alpha|beta|[0-9]+)([.-][a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix","models.meshery.io/v1beta1","capability.meshery.io/v1alpha1"]},name:{"x-oapi-codegen-extra-tags":{db:"name",yaml:"name"},"x-order":3,type:"string",description:"Environment name"},description:{"x-oapi-codegen-extra-tags":{db:"description",yaml:"description"},"x-order":4,type:"string",description:"Environment description"},organization_id:{"x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id",yaml:"organization_id"},"x-order":5,description:"Environment organization ID",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},owner:{"x-oapi-codegen-extra-tags":{db:"owner",yaml:"owner"},"x-order":6,description:"Environment owner",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},created_at:{"x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},metadata:{"x-oapi-codegen-extra-tags":{db:"metadata",yaml:"metadata"},"x-order":8,"x-go-type":"core.Map","x-go-type-skip-optional-pointer":true,type:"object"},updated_at:{"x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at",yaml:"deleted_at"},"x-go-type":"core.NullTime","x-go-import":"database/sql","x-order":10,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},environmentConnectionMapping:{properties:{ID:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-go-type-name":"GeneralId","x-go-type-skip-optional-pointer":true},environment_id:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"environment_id",json:"environment_id"},"x-go-type-skip-optional-pointer":true},connection_id:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"connection_id",json:"connection_id"},"x-go-type-skip-optional-pointer":true},created_at:{type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updated_at:{type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deleted_at:{description:"SQL null Timestamp to handle null values of time.","x-go-type":"sql.NullTime",type:"string","x-go-type-skip-optional-pointer":true}}},environmentPayload:{properties:{name:{description:"An environment is a collection of resources. Provide a name that meaningfully represents these resources. You can change the name of the environment even after its creation.",type:"string","x-go-type-skip-optional-pointer":true},description:{description:"An environment is a collection of resources, such as connections & credentail. Provide a detailed description to clarify the purpose of this environment and the types of resources it encompasses. You can modify the description at any Time. Learn more about environments [here](https://docs.meshery.io/concepts/logical/environments).",type:"string","x-go-type-skip-optional-pointer":true},OrganizationID:{type:"string",description:"Select an organization in which you want to create this new environment. Keep in mind that the organization cannot be changed after creation.","x-go-type-skip-optional-pointer":true,"x-go-name":"OrgId","x-oapi-codegen-extra-tags":{json:"organization_id"}}},required:["name","organizationID"]},environmentPage:{properties:{page:{type:"integer","x-go-type-skip-optional-pointer":true},page_size:{type:"integer","x-go-type-skip-optional-pointer":true},total_count:{type:"integer","x-go-type-skip-optional-pointer":true},environments:{type:"array","x-go-type-skip-optional-pointer":true,items:{"x-go-type":"Environment",$id:"https://schemas.meshery.io/environment.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Meshery Environments allow you to logically group related Connections and their associated Credentials.. Learn more at https://docs.meshery.io/concepts/logical/environments",additionalProperties:false,type:"object",required:["id","schemaVersion","name","description","organization_id"],properties:{id:{description:"ID","x-order":1,"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",yaml:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},schemaVersion:{description:"Specifies the version of the schema to which the environment conforms.","x-order":2,"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",db:"-",gorm:"-"},default:"environments.meshery.io/v1beta1",type:"string",minLength:2,maxLength:100,pattern:"^([a-z][a-z0-9.-]*\\/)?v(alpha|beta|[0-9]+)([.-][a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix","models.meshery.io/v1beta1","capability.meshery.io/v1alpha1"]},name:{"x-oapi-codegen-extra-tags":{db:"name",yaml:"name"},"x-order":3,type:"string",description:"Environment name"},description:{"x-oapi-codegen-extra-tags":{db:"description",yaml:"description"},"x-order":4,type:"string",description:"Environment description"},organization_id:{"x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id",yaml:"organization_id"},"x-order":5,description:"Environment organization ID",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},owner:{"x-oapi-codegen-extra-tags":{db:"owner",yaml:"owner"},"x-order":6,description:"Environment owner",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},created_at:{"x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},metadata:{"x-oapi-codegen-extra-tags":{db:"metadata",yaml:"metadata"},"x-order":8,"x-go-type":"core.Map","x-go-type-skip-optional-pointer":true,type:"object"},updated_at:{"x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at",yaml:"deleted_at"},"x-go-type":"core.NullTime","x-go-import":"database/sql","x-order":10,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}}},requestBodies:{environmentPayload:{description:"Body for creating environment",required:true,content:{"application/json":{schema:{properties:{name:{description:"An environment is a collection of resources. Provide a name that meaningfully represents these resources. You can change the name of the environment even after its creation.",type:"string","x-go-type-skip-optional-pointer":true},description:{description:"An environment is a collection of resources, such as connections & credentail. Provide a detailed description to clarify the purpose of this environment and the types of resources it encompasses. You can modify the description at any Time. Learn more about environments [here](https://docs.meshery.io/concepts/logical/environments).",type:"string","x-go-type-skip-optional-pointer":true},OrganizationID:{type:"string",description:"Select an organization in which you want to create this new environment. Keep in mind that the organization cannot be changed after creation.","x-go-type-skip-optional-pointer":true,"x-go-name":"OrgId","x-oapi-codegen-extra-tags":{json:"organization_id"}}},required:["name","organizationID"]}}}}}},paths:{"/api/environments":{post:{tags:["environments"],operationId:"CreateEnvironment",summary:"Create an environment",description:"Creates a new environment",requestBody:{description:"Body for creating environment",required:true,content:{"application/json":{schema:{properties:{name:{description:"An environment is a collection of resources. Provide a name that meaningfully represents these resources. You can change the name of the environment even after its creation.",type:"string","x-go-type-skip-optional-pointer":true},description:{description:"An environment is a collection of resources, such as connections & credentail. Provide a detailed description to clarify the purpose of this environment and the types of resources it encompasses. You can modify the description at any Time. Learn more about environments [here](https://docs.meshery.io/concepts/logical/environments).",type:"string","x-go-type-skip-optional-pointer":true},OrganizationID:{type:"string",description:"Select an organization in which you want to create this new environment. Keep in mind that the organization cannot be changed after creation.","x-go-type-skip-optional-pointer":true,"x-go-name":"OrgId","x-oapi-codegen-extra-tags":{json:"organization_id"}}},required:["name","organizationID"]}}}},responses:{201:{description:"Created environment",content:{"application/json":{schema:{$id:"https://schemas.meshery.io/environment.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Meshery Environments allow you to logically group related Connections and their associated Credentials.. Learn more at https://docs.meshery.io/concepts/logical/environments",additionalProperties:false,type:"object",required:["id","schemaVersion","name","description","organization_id"],properties:{id:{description:"ID","x-order":1,"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",yaml:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},schemaVersion:{description:"Specifies the version of the schema to which the environment conforms.","x-order":2,"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",db:"-",gorm:"-"},default:"environments.meshery.io/v1beta1",type:"string",minLength:2,maxLength:100,pattern:"^([a-z][a-z0-9.-]*\\/)?v(alpha|beta|[0-9]+)([.-][a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix","models.meshery.io/v1beta1","capability.meshery.io/v1alpha1"]},name:{"x-oapi-codegen-extra-tags":{db:"name",yaml:"name"},"x-order":3,type:"string",description:"Environment name"},description:{"x-oapi-codegen-extra-tags":{db:"description",yaml:"description"},"x-order":4,type:"string",description:"Environment description"},organization_id:{"x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id",yaml:"organization_id"},"x-order":5,description:"Environment organization ID",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},owner:{"x-oapi-codegen-extra-tags":{db:"owner",yaml:"owner"},"x-order":6,description:"Environment owner",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},created_at:{"x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},metadata:{"x-oapi-codegen-extra-tags":{db:"metadata",yaml:"metadata"},"x-order":8,"x-go-type":"core.Map","x-go-type-skip-optional-pointer":true,type:"object"},updated_at:{"x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at",yaml:"deleted_at"},"x-go-type":"core.NullTime","x-go-import":"database/sql","x-order":10,type:"string",format:"date-time","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"}}}}}},get:{tags:["environments"],operationId:"GetEnvironments",summary:"Get all environments",description:"Gets all environments",parameters:[{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}},{name:"orgID",in:"query",description:"User's organization ID",schema:{type:"string"},required:true}],responses:{200:{description:"Environments",content:{"application/json":{schema:{properties:{page:{type:"integer","x-go-type-skip-optional-pointer":true},page_size:{type:"integer","x-go-type-skip-optional-pointer":true},total_count:{type:"integer","x-go-type-skip-optional-pointer":true},environments:{type:"array","x-go-type-skip-optional-pointer":true,items:{"x-go-type":"Environment",$id:"https://schemas.meshery.io/environment.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Meshery Environments allow you to logically group related Connections and their associated Credentials.. Learn more at https://docs.meshery.io/concepts/logical/environments",additionalProperties:false,type:"object",required:["id","schemaVersion","name","description","organization_id"],properties:{id:{description:"ID","x-order":1,"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",yaml:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},schemaVersion:{description:"Specifies the version of the schema to which the environment conforms.","x-order":2,"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",db:"-",gorm:"-"},default:"environments.meshery.io/v1beta1",type:"string",minLength:2,maxLength:100,pattern:"^([a-z][a-z0-9.-]*\\/)?v(alpha|beta|[0-9]+)([.-][a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix","models.meshery.io/v1beta1","capability.meshery.io/v1alpha1"]},name:{"x-oapi-codegen-extra-tags":{db:"name",yaml:"name"},"x-order":3,type:"string",description:"Environment name"},description:{"x-oapi-codegen-extra-tags":{db:"description",yaml:"description"},"x-order":4,type:"string",description:"Environment description"},organization_id:{"x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id",yaml:"organization_id"},"x-order":5,description:"Environment organization ID",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},owner:{"x-oapi-codegen-extra-tags":{db:"owner",yaml:"owner"},"x-order":6,description:"Environment owner",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},created_at:{"x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-order":7,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},metadata:{"x-oapi-codegen-extra-tags":{db:"metadata",yaml:"metadata"},"x-order":8,"x-go-type":"core.Map","x-go-type-skip-optional-pointer":true,type:"object"},updated_at:{"x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at",yaml:"deleted_at"},"x-go-type":"core.NullTime","x-go-import":"database/sql","x-order":10,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}}}}},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"}}}}}}}}},t=e;
2
2
  export{t as default};
@@ -5,9 +5,18 @@
5
5
  declare const EvaluationSchema: {
6
6
  readonly openapi: "3.0.0";
7
7
  readonly info: {
8
- readonly title: "evaluation";
9
- readonly version: "1.0.0";
10
- readonly description: "API for evaluating relationships in Meshery designs";
8
+ readonly title: "Evaluation";
9
+ readonly description: "API for evaluating relationships in Meshery designs.";
10
+ readonly version: "v1beta1";
11
+ readonly contact: {
12
+ readonly name: "Meshery Maintainers";
13
+ readonly email: "maintainers@meshery.io";
14
+ readonly url: "https://meshery.io";
15
+ };
16
+ readonly license: {
17
+ readonly name: "Apache 2.0";
18
+ readonly url: "https://www.apache.org/licenses/LICENSE-2.0.html";
19
+ };
11
20
  };
12
21
  readonly paths: {
13
22
  readonly "/evaluate": {
@@ -5,9 +5,18 @@
5
5
  declare const EvaluationSchema: {
6
6
  readonly openapi: "3.0.0";
7
7
  readonly info: {
8
- readonly title: "evaluation";
9
- readonly version: "1.0.0";
10
- readonly description: "API for evaluating relationships in Meshery designs";
8
+ readonly title: "Evaluation";
9
+ readonly description: "API for evaluating relationships in Meshery designs.";
10
+ readonly version: "v1beta1";
11
+ readonly contact: {
12
+ readonly name: "Meshery Maintainers";
13
+ readonly email: "maintainers@meshery.io";
14
+ readonly url: "https://meshery.io";
15
+ };
16
+ readonly license: {
17
+ readonly name: "Apache 2.0";
18
+ readonly url: "https://www.apache.org/licenses/LICENSE-2.0.html";
19
+ };
11
20
  };
12
21
  readonly paths: {
13
22
  readonly "/evaluate": {
@@ -1,4 +1,4 @@
1
- 'use strict';var e={openapi:"3.0.0",info:{title:"evaluation",version:"1.0.0",description:"API for evaluating relationships in Meshery designs"},paths:{"/evaluate":{post:{"x-internal":["meshery"],summary:"Evaluate relationships in a design",description:"Performs relationship evaluation on a given design, applying policies and updating components and relationships as needed.",requestBody:{required:true,content:{"application/json":{schema:{type:"object",required:["design"],properties:{design:{"x-go-type":"pattern.PatternFile","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/pattern"},$schema:"http://json-schema.org/draft-07/schema#",title:"Design Schema",description:"Designs are your primary tool for collaborative authorship of your infrastructure, workflow, and processes.",type:"object",properties:{id:{"x-order":1,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:{type:"string",description:"Name of the design; a descriptive, but concise title for the design document.","x-order":2},schemaVersion:{description:"Specifies the version of the schema to which the design conforms.","x-order":3,type:"string",minLength:2,maxLength:100,pattern:"^([a-z][a-z0-9.-]*\\/)?v(alpha|beta|[0-9]+)([.-][a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix","models.meshery.io/v1beta1","capability.meshery.io/v1alpha1"]},version:{default:"v0.0.1","x-order":4,description:"Revision of the design as expressed by an auto-incremented, SemVer-compliant version number. May be manually set by a user or third-party system, but will always be required to be of version number higher than the previously defined version number.",minLength:1,maxLength:50,type:"string",pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},metadata:{type:"object","x-order":5,additionalProperties:true,properties:{resolvedAliases:{description:"Map of resolved aliases present in the design",type:"object","x-go-type":"map[string]corev1alpha1.ResolvedAlias","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha1/core",name:"corev1alpha1"},additionalProperties:{description:"An resolved alias is an component that acts as an ref/pointer to a field in another component, resolvedAlias are aware of there immediate parents and completely resolved parents also",allOf:[{description:"An alias is an component that acts as an ref/pointer to a field in another component, nonResolvedAlias are not aware of there immediate parents",type:"object",properties:{relationship_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"}},alias_component_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"}},immediate_parent_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"}},immediate_ref_field_path:{type:"array",items:{type:"string"}}},required:["relationship_id","alias_component_id","immediate_parent_id","immediate_ref_field_path"]},{type:"object",properties:{resolved_parent_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"}},resolved_ref_field_path:{type:"array",items:{type:"string"}}},required:["resolved_parent_id","resolved_ref_field_path"]}]}}}},components:{description:"A list of one or more component declarations.",minItems:0,"x-order":6,type:"array",items:{"x-go-type":"*component.ComponentDefinition","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/component"},$id:"https://schemas.meshery.io/component.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Components are reusable building blocks for depicting capabilities defined within models. Learn more at https://docs.meshery.io/concepts/components",additionalProperties:false,type:"object",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-order":1,"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},schemaVersion:{"x-order":2,description:"Specifies the version of the schema to which the component definition conforms.","x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"},default:"components.meshery.io/v1beta1",type:"string",minLength:2,maxLength:100,pattern:"^([a-z][a-z0-9.-]*\\/)?v(alpha|beta|[0-9]+)([.-][a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix","models.meshery.io/v1beta1","capability.meshery.io/v1alpha1"]},version:{"x-order":3,description:"Version of the component definition.",minLength:1,maxLength:50,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},type:"string",pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{"x-order":4,description:"Name of the component in human-readible format.","x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},description:{"x-order":5,type:"string",description:"A written representation of the purpose and characteristics of the component.","x-oapi-codegen-extra-tags":{yaml:"description",json:"description"}},format:{"x-order":6,type:"string",enum:["JSON","CUE"],default:"JSON",description:"Format specifies the format used in the `component.schema` field. JSON is the default.","x-oapi-codegen-extra-tags":{yaml:"format",json:"format"}},model:{"x-go-type":"model.ModelDefinition","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":7,description:"Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models","x-oapi-codegen-extra-tags":{gorm:"foreignKey:ModelId;references:Id",json:"model,omitempty",yaml:"model,omitempty"},$id:"https://schemas.meshery.io/model.yaml",$schema:"http://json-schema.org/draft-07/schema#",additionalProperties:false,type:"object",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-order":1,"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},schemaVersion:{description:"Specifies the version of the schema used for the definition.","x-order":2,"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"},default:"models.meshery.io/v1beta1",type:"string",minLength:2,maxLength:100,pattern:"^([a-z][a-z0-9.-]*\\/)?v(alpha|beta|[0-9]+)([.-][a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix","models.meshery.io/v1beta1","capability.meshery.io/v1alpha1"]},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},description:{type:"string",default:"A new Meshery model.",description:"Description of the model.",minLength:1,maxLength:1e3,"x-order":6,"x-oapi-codegen-extra-tags":{yaml:"description,omitempty",json:"description,omitempty"}},status:{type:"string",description:`Status of model, including:
1
+ 'use strict';var e={openapi:"3.0.0",info:{title:"Evaluation",description:"API for evaluating relationships in Meshery designs.",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"}},paths:{"/evaluate":{post:{"x-internal":["meshery"],summary:"Evaluate relationships in a design",description:"Performs relationship evaluation on a given design, applying policies and updating components and relationships as needed.",requestBody:{required:true,content:{"application/json":{schema:{type:"object",required:["design"],properties:{design:{"x-go-type":"pattern.PatternFile","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/pattern"},$schema:"http://json-schema.org/draft-07/schema#",title:"Design Schema",description:"Designs are your primary tool for collaborative authorship of your infrastructure, workflow, and processes.",type:"object",properties:{id:{"x-order":1,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:{type:"string",description:"Name of the design; a descriptive, but concise title for the design document.","x-order":2},schemaVersion:{description:"Specifies the version of the schema to which the design conforms.","x-order":3,type:"string",minLength:2,maxLength:100,pattern:"^([a-z][a-z0-9.-]*\\/)?v(alpha|beta|[0-9]+)([.-][a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix","models.meshery.io/v1beta1","capability.meshery.io/v1alpha1"]},version:{default:"v0.0.1","x-order":4,description:"Revision of the design as expressed by an auto-incremented, SemVer-compliant version number. May be manually set by a user or third-party system, but will always be required to be of version number higher than the previously defined version number.",minLength:1,maxLength:50,type:"string",pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},metadata:{type:"object","x-order":5,additionalProperties:true,properties:{resolvedAliases:{description:"Map of resolved aliases present in the design",type:"object","x-go-type":"map[string]corev1alpha1.ResolvedAlias","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha1/core",name:"corev1alpha1"},additionalProperties:{description:"An resolved alias is an component that acts as an ref/pointer to a field in another component, resolvedAlias are aware of there immediate parents and completely resolved parents also",allOf:[{description:"An alias is an component that acts as an ref/pointer to a field in another component, nonResolvedAlias are not aware of there immediate parents",type:"object",properties:{relationship_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"}},alias_component_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"}},immediate_parent_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"}},immediate_ref_field_path:{type:"array",items:{type:"string"}}},required:["relationship_id","alias_component_id","immediate_parent_id","immediate_ref_field_path"]},{type:"object",properties:{resolved_parent_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"}},resolved_ref_field_path:{type:"array",items:{type:"string"}}},required:["resolved_parent_id","resolved_ref_field_path"]}]}}}},components:{description:"A list of one or more component declarations.",minItems:0,"x-order":6,type:"array",items:{"x-go-type":"*component.ComponentDefinition","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/component"},$id:"https://schemas.meshery.io/component.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Components are reusable building blocks for depicting capabilities defined within models. Learn more at https://docs.meshery.io/concepts/components",additionalProperties:false,type:"object",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-order":1,"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},schemaVersion:{"x-order":2,description:"Specifies the version of the schema to which the component definition conforms.","x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"},default:"components.meshery.io/v1beta1",type:"string",minLength:2,maxLength:100,pattern:"^([a-z][a-z0-9.-]*\\/)?v(alpha|beta|[0-9]+)([.-][a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix","models.meshery.io/v1beta1","capability.meshery.io/v1alpha1"]},version:{"x-order":3,description:"Version of the component definition.",minLength:1,maxLength:50,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},type:"string",pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{"x-order":4,description:"Name of the component in human-readible format.","x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},description:{"x-order":5,type:"string",description:"A written representation of the purpose and characteristics of the component.","x-oapi-codegen-extra-tags":{yaml:"description",json:"description"}},format:{"x-order":6,type:"string",enum:["JSON","CUE"],default:"JSON",description:"Format specifies the format used in the `component.schema` field. JSON is the default.","x-oapi-codegen-extra-tags":{yaml:"format",json:"format"}},model:{"x-go-type":"model.ModelDefinition","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":7,description:"Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models","x-oapi-codegen-extra-tags":{gorm:"foreignKey:ModelId;references:Id",json:"model,omitempty",yaml:"model,omitempty"},$id:"https://schemas.meshery.io/model.yaml",$schema:"http://json-schema.org/draft-07/schema#",additionalProperties:false,type:"object",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-order":1,"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},schemaVersion:{description:"Specifies the version of the schema used for the definition.","x-order":2,"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"},default:"models.meshery.io/v1beta1",type:"string",minLength:2,maxLength:100,pattern:"^([a-z][a-z0-9.-]*\\/)?v(alpha|beta|[0-9]+)([.-][a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix","models.meshery.io/v1beta1","capability.meshery.io/v1alpha1"]},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},description:{type:"string",default:"A new Meshery model.",description:"Description of the model.",minLength:1,maxLength:1e3,"x-order":6,"x-oapi-codegen-extra-tags":{yaml:"description,omitempty",json:"description,omitempty"}},status:{type:"string",description:`Status of model, including:
2
2
  - duplicate: this component is a duplicate of another. The component that is to be the canonical reference and that is duplicated by other components should not be assigned the 'duplicate' status.
3
3
  - maintenance: model is unavailable for a period of time.
4
4
  - enabled: model is available for use for all users of this Meshery Server.
@@ -1,4 +1,4 @@
1
- var e={openapi:"3.0.0",info:{title:"evaluation",version:"1.0.0",description:"API for evaluating relationships in Meshery designs"},paths:{"/evaluate":{post:{"x-internal":["meshery"],summary:"Evaluate relationships in a design",description:"Performs relationship evaluation on a given design, applying policies and updating components and relationships as needed.",requestBody:{required:true,content:{"application/json":{schema:{type:"object",required:["design"],properties:{design:{"x-go-type":"pattern.PatternFile","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/pattern"},$schema:"http://json-schema.org/draft-07/schema#",title:"Design Schema",description:"Designs are your primary tool for collaborative authorship of your infrastructure, workflow, and processes.",type:"object",properties:{id:{"x-order":1,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:{type:"string",description:"Name of the design; a descriptive, but concise title for the design document.","x-order":2},schemaVersion:{description:"Specifies the version of the schema to which the design conforms.","x-order":3,type:"string",minLength:2,maxLength:100,pattern:"^([a-z][a-z0-9.-]*\\/)?v(alpha|beta|[0-9]+)([.-][a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix","models.meshery.io/v1beta1","capability.meshery.io/v1alpha1"]},version:{default:"v0.0.1","x-order":4,description:"Revision of the design as expressed by an auto-incremented, SemVer-compliant version number. May be manually set by a user or third-party system, but will always be required to be of version number higher than the previously defined version number.",minLength:1,maxLength:50,type:"string",pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},metadata:{type:"object","x-order":5,additionalProperties:true,properties:{resolvedAliases:{description:"Map of resolved aliases present in the design",type:"object","x-go-type":"map[string]corev1alpha1.ResolvedAlias","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha1/core",name:"corev1alpha1"},additionalProperties:{description:"An resolved alias is an component that acts as an ref/pointer to a field in another component, resolvedAlias are aware of there immediate parents and completely resolved parents also",allOf:[{description:"An alias is an component that acts as an ref/pointer to a field in another component, nonResolvedAlias are not aware of there immediate parents",type:"object",properties:{relationship_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"}},alias_component_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"}},immediate_parent_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"}},immediate_ref_field_path:{type:"array",items:{type:"string"}}},required:["relationship_id","alias_component_id","immediate_parent_id","immediate_ref_field_path"]},{type:"object",properties:{resolved_parent_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"}},resolved_ref_field_path:{type:"array",items:{type:"string"}}},required:["resolved_parent_id","resolved_ref_field_path"]}]}}}},components:{description:"A list of one or more component declarations.",minItems:0,"x-order":6,type:"array",items:{"x-go-type":"*component.ComponentDefinition","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/component"},$id:"https://schemas.meshery.io/component.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Components are reusable building blocks for depicting capabilities defined within models. Learn more at https://docs.meshery.io/concepts/components",additionalProperties:false,type:"object",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-order":1,"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},schemaVersion:{"x-order":2,description:"Specifies the version of the schema to which the component definition conforms.","x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"},default:"components.meshery.io/v1beta1",type:"string",minLength:2,maxLength:100,pattern:"^([a-z][a-z0-9.-]*\\/)?v(alpha|beta|[0-9]+)([.-][a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix","models.meshery.io/v1beta1","capability.meshery.io/v1alpha1"]},version:{"x-order":3,description:"Version of the component definition.",minLength:1,maxLength:50,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},type:"string",pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{"x-order":4,description:"Name of the component in human-readible format.","x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},description:{"x-order":5,type:"string",description:"A written representation of the purpose and characteristics of the component.","x-oapi-codegen-extra-tags":{yaml:"description",json:"description"}},format:{"x-order":6,type:"string",enum:["JSON","CUE"],default:"JSON",description:"Format specifies the format used in the `component.schema` field. JSON is the default.","x-oapi-codegen-extra-tags":{yaml:"format",json:"format"}},model:{"x-go-type":"model.ModelDefinition","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":7,description:"Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models","x-oapi-codegen-extra-tags":{gorm:"foreignKey:ModelId;references:Id",json:"model,omitempty",yaml:"model,omitempty"},$id:"https://schemas.meshery.io/model.yaml",$schema:"http://json-schema.org/draft-07/schema#",additionalProperties:false,type:"object",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-order":1,"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},schemaVersion:{description:"Specifies the version of the schema used for the definition.","x-order":2,"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"},default:"models.meshery.io/v1beta1",type:"string",minLength:2,maxLength:100,pattern:"^([a-z][a-z0-9.-]*\\/)?v(alpha|beta|[0-9]+)([.-][a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix","models.meshery.io/v1beta1","capability.meshery.io/v1alpha1"]},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},description:{type:"string",default:"A new Meshery model.",description:"Description of the model.",minLength:1,maxLength:1e3,"x-order":6,"x-oapi-codegen-extra-tags":{yaml:"description,omitempty",json:"description,omitempty"}},status:{type:"string",description:`Status of model, including:
1
+ var e={openapi:"3.0.0",info:{title:"Evaluation",description:"API for evaluating relationships in Meshery designs.",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"}},paths:{"/evaluate":{post:{"x-internal":["meshery"],summary:"Evaluate relationships in a design",description:"Performs relationship evaluation on a given design, applying policies and updating components and relationships as needed.",requestBody:{required:true,content:{"application/json":{schema:{type:"object",required:["design"],properties:{design:{"x-go-type":"pattern.PatternFile","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/pattern"},$schema:"http://json-schema.org/draft-07/schema#",title:"Design Schema",description:"Designs are your primary tool for collaborative authorship of your infrastructure, workflow, and processes.",type:"object",properties:{id:{"x-order":1,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:{type:"string",description:"Name of the design; a descriptive, but concise title for the design document.","x-order":2},schemaVersion:{description:"Specifies the version of the schema to which the design conforms.","x-order":3,type:"string",minLength:2,maxLength:100,pattern:"^([a-z][a-z0-9.-]*\\/)?v(alpha|beta|[0-9]+)([.-][a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix","models.meshery.io/v1beta1","capability.meshery.io/v1alpha1"]},version:{default:"v0.0.1","x-order":4,description:"Revision of the design as expressed by an auto-incremented, SemVer-compliant version number. May be manually set by a user or third-party system, but will always be required to be of version number higher than the previously defined version number.",minLength:1,maxLength:50,type:"string",pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},metadata:{type:"object","x-order":5,additionalProperties:true,properties:{resolvedAliases:{description:"Map of resolved aliases present in the design",type:"object","x-go-type":"map[string]corev1alpha1.ResolvedAlias","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha1/core",name:"corev1alpha1"},additionalProperties:{description:"An resolved alias is an component that acts as an ref/pointer to a field in another component, resolvedAlias are aware of there immediate parents and completely resolved parents also",allOf:[{description:"An alias is an component that acts as an ref/pointer to a field in another component, nonResolvedAlias are not aware of there immediate parents",type:"object",properties:{relationship_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"}},alias_component_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"}},immediate_parent_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"}},immediate_ref_field_path:{type:"array",items:{type:"string"}}},required:["relationship_id","alias_component_id","immediate_parent_id","immediate_ref_field_path"]},{type:"object",properties:{resolved_parent_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"}},resolved_ref_field_path:{type:"array",items:{type:"string"}}},required:["resolved_parent_id","resolved_ref_field_path"]}]}}}},components:{description:"A list of one or more component declarations.",minItems:0,"x-order":6,type:"array",items:{"x-go-type":"*component.ComponentDefinition","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/component"},$id:"https://schemas.meshery.io/component.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Components are reusable building blocks for depicting capabilities defined within models. Learn more at https://docs.meshery.io/concepts/components",additionalProperties:false,type:"object",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-order":1,"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},schemaVersion:{"x-order":2,description:"Specifies the version of the schema to which the component definition conforms.","x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"},default:"components.meshery.io/v1beta1",type:"string",minLength:2,maxLength:100,pattern:"^([a-z][a-z0-9.-]*\\/)?v(alpha|beta|[0-9]+)([.-][a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix","models.meshery.io/v1beta1","capability.meshery.io/v1alpha1"]},version:{"x-order":3,description:"Version of the component definition.",minLength:1,maxLength:50,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},type:"string",pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{"x-order":4,description:"Name of the component in human-readible format.","x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},description:{"x-order":5,type:"string",description:"A written representation of the purpose and characteristics of the component.","x-oapi-codegen-extra-tags":{yaml:"description",json:"description"}},format:{"x-order":6,type:"string",enum:["JSON","CUE"],default:"JSON",description:"Format specifies the format used in the `component.schema` field. JSON is the default.","x-oapi-codegen-extra-tags":{yaml:"format",json:"format"}},model:{"x-go-type":"model.ModelDefinition","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":7,description:"Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models","x-oapi-codegen-extra-tags":{gorm:"foreignKey:ModelId;references:Id",json:"model,omitempty",yaml:"model,omitempty"},$id:"https://schemas.meshery.io/model.yaml",$schema:"http://json-schema.org/draft-07/schema#",additionalProperties:false,type:"object",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-order":1,"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},schemaVersion:{description:"Specifies the version of the schema used for the definition.","x-order":2,"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"},default:"models.meshery.io/v1beta1",type:"string",minLength:2,maxLength:100,pattern:"^([a-z][a-z0-9.-]*\\/)?v(alpha|beta|[0-9]+)([.-][a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix","models.meshery.io/v1beta1","capability.meshery.io/v1alpha1"]},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},description:{type:"string",default:"A new Meshery model.",description:"Description of the model.",minLength:1,maxLength:1e3,"x-order":6,"x-oapi-codegen-extra-tags":{yaml:"description,omitempty",json:"description,omitempty"}},status:{type:"string",description:`Status of model, including:
2
2
  - duplicate: this component is a duplicate of another. The component that is to be the canonical reference and that is duplicated by other components should not be assigned the 'duplicate' status.
3
3
  - maintenance: model is unavailable for a period of time.
4
4
  - enabled: model is available for use for all users of this Meshery Server.
@@ -5,8 +5,18 @@
5
5
  declare const EventSchema: {
6
6
  readonly openapi: "3.0.0";
7
7
  readonly info: {
8
- readonly title: "events";
9
- readonly version: "1.0.0";
8
+ readonly title: "Events";
9
+ readonly description: "OpenAPI schema for Meshery events and system notifications.";
10
+ readonly version: "v1beta1";
11
+ readonly contact: {
12
+ readonly name: "Meshery Maintainers";
13
+ readonly email: "maintainers@meshery.io";
14
+ readonly url: "https://meshery.io";
15
+ };
16
+ readonly license: {
17
+ readonly name: "Apache 2.0";
18
+ readonly url: "https://www.apache.org/licenses/LICENSE-2.0.html";
19
+ };
10
20
  };
11
21
  readonly paths: {
12
22
  readonly "/events/{id}": {
@@ -5,8 +5,18 @@
5
5
  declare const EventSchema: {
6
6
  readonly openapi: "3.0.0";
7
7
  readonly info: {
8
- readonly title: "events";
9
- readonly version: "1.0.0";
8
+ readonly title: "Events";
9
+ readonly description: "OpenAPI schema for Meshery events and system notifications.";
10
+ readonly version: "v1beta1";
11
+ readonly contact: {
12
+ readonly name: "Meshery Maintainers";
13
+ readonly email: "maintainers@meshery.io";
14
+ readonly url: "https://meshery.io";
15
+ };
16
+ readonly license: {
17
+ readonly name: "Apache 2.0";
18
+ readonly url: "https://www.apache.org/licenses/LICENSE-2.0.html";
19
+ };
10
20
  };
11
21
  readonly paths: {
12
22
  readonly "/events/{id}": {
@@ -1 +1,2 @@
1
- 'use strict';var e={openapi:"3.0.0",info:{title:"events",version:"1.0.0"},paths:{"/events/{id}":{delete:{summary:"Delete a single event",parameters:[{in:"path",name:"id",required:true,schema:{type:"string",format:"uuid"},description:"ID of the event to delete"}],responses:{200:{description:"Event deleted successfully",content:{"application/json":{schema:{type:"object",properties:{message:{type:"string"},event_id:{type:"string",format:"uuid"}}}}}},400:{description:"Invalid event ID",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string"}}}}}},500:{description:"Server error"}}}},"/events":{post:{summary:"Create a new event",requestBody:{required:true,content:{"application/json":{schema:{type:"object"}}}}},delete:{summary:"Bulk delete events",requestBody:{required:true,content:{"application/json":{schema:{type:"object",required:["ids"],properties:{ids:{type:"array",items:{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"}}}}}}}},responses:{200:{description:"event deleted",content:{"application/json":{schema:{type:"object",properties:{deleted:{type:"array",items:{type:"string",format:"uuid"}}}}}}},400:{description:"Invalid request",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string"}}}}}},500:{description:"Server error"}}}},"/events/status":{put:{summary:"Bulk update event status",requestBody:{required:true,content:{"application/json":{schema:{type:"object",required:["ids","status"],properties:{ids:{type:"array",items:{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"}}},status:{type:"string",example:"failed"}}}}}},responses:{200:{description:"Events updated successfully",content:{"application/json":{schema:{type:"object",properties:{updated:{type:"array",items:{type:"string",format:"uuid"}}}}}}},400:{description:"Invalid request",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string"}}}}}},500:{description:"Server error"}}}},"/events/{id}/status":{put:{summary:"Update status of a single event",parameters:[{in:"path",name:"id",required:true,schema:{type:"string",format:"uuid"},description:"ID of the event"}],requestBody:{required:true,content:{"application/json":{schema:{type:"object",required:["status"],properties:{status:{type:"string",example:"completed"}}}}}},responses:{200:{description:"Event status updated successfully",content:{"application/json":{schema:{type:"object",properties:{message:{type:"string"},event_id:{type:"string",format:"uuid"},status:{type:"string"}}}}}},400:{description:"Invalid request or status",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string"}}}}}},500:{description:"Server error"}}}}},components:{schemas:{UpdateEventStatusRequest:{type:"object",required:["status"],properties:{status:{type:"string",example:"completed"}}},BulkDeleteRequest:{type:"object",required:["ids"],properties:{ids:{type:"array",items:{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"}}}}},BulkUpdateStatusRequest:{type:"object",required:["ids","status"],properties:{ids:{type:"array",items:{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"}}},status:{type:"string",example:"failed"}}},ErrorResponse:{type:"object",properties:{error:{type:"string"}}}}}},t=e;module.exports=t;
1
+ 'use strict';var e={openapi:"3.0.0",info:{title:"Events",description:"OpenAPI schema for Meshery events and system notifications.",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"}},paths:{"/events/{id}":{delete:{summary:"Delete a single event",parameters:[{in:"path",name:"id",required:true,schema:{type:"string",format:"uuid"},description:"ID of the event to delete"}],responses:{200:{description:"Event deleted successfully",content:{"application/json":{schema:{type:"object",properties:{message:{type:"string"},event_id:{type:"string",format:"uuid"}}}}}},400:{description:"Invalid event ID",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string"}}}}}},500:{description:"Server error"}}}},"/events":{post:{summary:"Create a new event",requestBody:{required:true,content:{"application/json":{schema:{type:"object"}}}}},delete:{summary:"Bulk delete events",requestBody:{required:true,content:{"application/json":{schema:{type:"object",required:["ids"],properties:{ids:{type:"array",items:{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"}}}}}}}},responses:{200:{description:"event deleted",content:{"application/json":{schema:{type:"object",properties:{deleted:{type:"array",items:{type:"string",format:"uuid"}}}}}}},400:{description:"Invalid request",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string"}}}}}},500:{description:"Server error"}}}},"/events/status":{put:{summary:"Bulk update event status",requestBody:{required:true,content:{"application/json":{schema:{type:"object",required:["ids","status"],properties:{ids:{type:"array",items:{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"}}},status:{type:"string",example:"failed"}}}}}},responses:{200:{description:"Events updated successfully",content:{"application/json":{schema:{type:"object",properties:{updated:{type:"array",items:{type:"string",format:"uuid"}}}}}}},400:{description:"Invalid request",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string"}}}}}},500:{description:"Server error"}}}},"/events/{id}/status":{put:{summary:"Update status of a single event",parameters:[{in:"path",name:"id",required:true,schema:{type:"string",format:"uuid"},description:"ID of the event"}],requestBody:{required:true,content:{"application/json":{schema:{type:"object",required:["status"],properties:{status:{type:"string",example:"completed"}}}}}},responses:{200:{description:"Event status updated successfully",content:{"application/json":{schema:{type:"object",properties:{message:{type:"string"},event_id:{type:"string",format:"uuid"},status:{type:"string"}}}}}},400:{description:"Invalid request or status",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string"}}}}}},500:{description:"Server error"}}}}},components:{schemas:{UpdateEventStatusRequest:{type:"object",required:["status"],properties:{status:{type:"string",example:"completed"}}},BulkDeleteRequest:{type:"object",required:["ids"],properties:{ids:{type:"array",items:{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"}}}}},BulkUpdateStatusRequest:{type:"object",required:["ids","status"],properties:{ids:{type:"array",items:{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"}}},status:{type:"string",example:"failed"}}},ErrorResponse:{type:"object",properties:{error:{type:"string"}}}}}},t=e;
2
+ module.exports=t;
@@ -1 +1,2 @@
1
- var e={openapi:"3.0.0",info:{title:"events",version:"1.0.0"},paths:{"/events/{id}":{delete:{summary:"Delete a single event",parameters:[{in:"path",name:"id",required:true,schema:{type:"string",format:"uuid"},description:"ID of the event to delete"}],responses:{200:{description:"Event deleted successfully",content:{"application/json":{schema:{type:"object",properties:{message:{type:"string"},event_id:{type:"string",format:"uuid"}}}}}},400:{description:"Invalid event ID",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string"}}}}}},500:{description:"Server error"}}}},"/events":{post:{summary:"Create a new event",requestBody:{required:true,content:{"application/json":{schema:{type:"object"}}}}},delete:{summary:"Bulk delete events",requestBody:{required:true,content:{"application/json":{schema:{type:"object",required:["ids"],properties:{ids:{type:"array",items:{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"}}}}}}}},responses:{200:{description:"event deleted",content:{"application/json":{schema:{type:"object",properties:{deleted:{type:"array",items:{type:"string",format:"uuid"}}}}}}},400:{description:"Invalid request",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string"}}}}}},500:{description:"Server error"}}}},"/events/status":{put:{summary:"Bulk update event status",requestBody:{required:true,content:{"application/json":{schema:{type:"object",required:["ids","status"],properties:{ids:{type:"array",items:{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"}}},status:{type:"string",example:"failed"}}}}}},responses:{200:{description:"Events updated successfully",content:{"application/json":{schema:{type:"object",properties:{updated:{type:"array",items:{type:"string",format:"uuid"}}}}}}},400:{description:"Invalid request",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string"}}}}}},500:{description:"Server error"}}}},"/events/{id}/status":{put:{summary:"Update status of a single event",parameters:[{in:"path",name:"id",required:true,schema:{type:"string",format:"uuid"},description:"ID of the event"}],requestBody:{required:true,content:{"application/json":{schema:{type:"object",required:["status"],properties:{status:{type:"string",example:"completed"}}}}}},responses:{200:{description:"Event status updated successfully",content:{"application/json":{schema:{type:"object",properties:{message:{type:"string"},event_id:{type:"string",format:"uuid"},status:{type:"string"}}}}}},400:{description:"Invalid request or status",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string"}}}}}},500:{description:"Server error"}}}}},components:{schemas:{UpdateEventStatusRequest:{type:"object",required:["status"],properties:{status:{type:"string",example:"completed"}}},BulkDeleteRequest:{type:"object",required:["ids"],properties:{ids:{type:"array",items:{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"}}}}},BulkUpdateStatusRequest:{type:"object",required:["ids","status"],properties:{ids:{type:"array",items:{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"}}},status:{type:"string",example:"failed"}}},ErrorResponse:{type:"object",properties:{error:{type:"string"}}}}}},t=e;export{t as default};
1
+ var e={openapi:"3.0.0",info:{title:"Events",description:"OpenAPI schema for Meshery events and system notifications.",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"}},paths:{"/events/{id}":{delete:{summary:"Delete a single event",parameters:[{in:"path",name:"id",required:true,schema:{type:"string",format:"uuid"},description:"ID of the event to delete"}],responses:{200:{description:"Event deleted successfully",content:{"application/json":{schema:{type:"object",properties:{message:{type:"string"},event_id:{type:"string",format:"uuid"}}}}}},400:{description:"Invalid event ID",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string"}}}}}},500:{description:"Server error"}}}},"/events":{post:{summary:"Create a new event",requestBody:{required:true,content:{"application/json":{schema:{type:"object"}}}}},delete:{summary:"Bulk delete events",requestBody:{required:true,content:{"application/json":{schema:{type:"object",required:["ids"],properties:{ids:{type:"array",items:{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"}}}}}}}},responses:{200:{description:"event deleted",content:{"application/json":{schema:{type:"object",properties:{deleted:{type:"array",items:{type:"string",format:"uuid"}}}}}}},400:{description:"Invalid request",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string"}}}}}},500:{description:"Server error"}}}},"/events/status":{put:{summary:"Bulk update event status",requestBody:{required:true,content:{"application/json":{schema:{type:"object",required:["ids","status"],properties:{ids:{type:"array",items:{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"}}},status:{type:"string",example:"failed"}}}}}},responses:{200:{description:"Events updated successfully",content:{"application/json":{schema:{type:"object",properties:{updated:{type:"array",items:{type:"string",format:"uuid"}}}}}}},400:{description:"Invalid request",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string"}}}}}},500:{description:"Server error"}}}},"/events/{id}/status":{put:{summary:"Update status of a single event",parameters:[{in:"path",name:"id",required:true,schema:{type:"string",format:"uuid"},description:"ID of the event"}],requestBody:{required:true,content:{"application/json":{schema:{type:"object",required:["status"],properties:{status:{type:"string",example:"completed"}}}}}},responses:{200:{description:"Event status updated successfully",content:{"application/json":{schema:{type:"object",properties:{message:{type:"string"},event_id:{type:"string",format:"uuid"},status:{type:"string"}}}}}},400:{description:"Invalid request or status",content:{"application/json":{schema:{type:"object",properties:{error:{type:"string"}}}}}},500:{description:"Server error"}}}}},components:{schemas:{UpdateEventStatusRequest:{type:"object",required:["status"],properties:{status:{type:"string",example:"completed"}}},BulkDeleteRequest:{type:"object",required:["ids"],properties:{ids:{type:"array",items:{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"}}}}},BulkUpdateStatusRequest:{type:"object",required:["ids","status"],properties:{ids:{type:"array",items:{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"}}},status:{type:"string",example:"failed"}}},ErrorResponse:{type:"object",properties:{error:{type:"string"}}}}}},t=e;
2
+ export{t as default};
@@ -5,9 +5,18 @@
5
5
  declare const FeatureSchema: {
6
6
  readonly openapi: "3.0.0";
7
7
  readonly info: {
8
- readonly title: "feature";
9
- readonly description: "OpenAPI schema for the Features construct with entitlement-related properties";
8
+ readonly title: "Feature";
9
+ readonly description: "OpenAPI schema for the Features construct with entitlement-related properties.";
10
10
  readonly version: "v1beta1";
11
+ readonly contact: {
12
+ readonly name: "Meshery Maintainers";
13
+ readonly email: "maintainers@meshery.io";
14
+ readonly url: "https://meshery.io";
15
+ };
16
+ readonly license: {
17
+ readonly name: "Apache 2.0";
18
+ readonly url: "https://www.apache.org/licenses/LICENSE-2.0.html";
19
+ };
11
20
  };
12
21
  readonly tags: readonly [{
13
22
  readonly name: "Features";
@@ -5,9 +5,18 @@
5
5
  declare const FeatureSchema: {
6
6
  readonly openapi: "3.0.0";
7
7
  readonly info: {
8
- readonly title: "feature";
9
- readonly description: "OpenAPI schema for the Features construct with entitlement-related properties";
8
+ readonly title: "Feature";
9
+ readonly description: "OpenAPI schema for the Features construct with entitlement-related properties.";
10
10
  readonly version: "v1beta1";
11
+ readonly contact: {
12
+ readonly name: "Meshery Maintainers";
13
+ readonly email: "maintainers@meshery.io";
14
+ readonly url: "https://meshery.io";
15
+ };
16
+ readonly license: {
17
+ readonly name: "Apache 2.0";
18
+ readonly url: "https://www.apache.org/licenses/LICENSE-2.0.html";
19
+ };
11
20
  };
12
21
  readonly tags: readonly [{
13
22
  readonly name: "Features";
@@ -1 +1,2 @@
1
- 'use strict';var e={openapi:"3.0.0",info:{title:"feature",description:"OpenAPI schema for the Features construct with entitlement-related properties",version:"v1beta1"},tags:[{name:"Features",description:"Operations related to features and entitlements"}],paths:{"/api/entitlement/features":{get:{"x-internal":["cloud"],operationId:"getFeatures",tags:["Features"],summary:"Get all features associated with plans",responses:{200:{description:"Features fetched successfully",content:{"application/json":{schema:{type:"array",items:{"x-go-type":"Feature",type:"object",required:["id","plan_id","quantity","feature"],properties:{id:{"x-oapi-codegen-extra-tags":{db:"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"}},plan_id:{"x-oapi-codegen-extra-tags":{db:"plan_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"}},plan:{"x-go-type":"plan.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/plan"},"x-oapi-codegen-extra-tags":{belongs_to:"plans",fk_id:"PlanId",yaml:"plan,omitempty",json:"plan,omitempty"},type:"object",properties:{id:{"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"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"}},name:{type:"string","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},description:"Name of the plan",enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{"x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["monthly","yearly"]},unit:{"x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimum_units:{type:"integer",description:"Minimum number of units required for the plan","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimum_units",csv:"minimum_units"}},price_per_unit:{type:"number",description:"Price per unit of the plan","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"price_per_unit",csv:"price_per_unit"}},currency:{"x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}},required:["id","name","cadence","unit","price_per_unit","minimum_units","price_id","currency"]},name:{"x-go-type":"FeatureName","x-oapi-codegen-extra-tags":{db:"name"},type:"string",enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign"],description:"Enumeration of possible feature types"},quantity:{type:"number",description:"Quantity of the feature allowed, use 9999999999 for unlimited","x-oapi-codegen-extra-tags":{db:"quantity"}},created_at:{"x-oapi-codegen-extra-tags":{db:"created_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updated_at:{"x-oapi-codegen-extra-tags":{db:"updated_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}},additionalProperties:false}}}}},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/{organizationId}/features":{get:{"x-internal":["cloud"],operationId:"getFeaturesByOrganization",tags:["Features"],summary:"Get all features associated with plans",parameters:[{name:"organizationId",in:"path",description:"The ID of the organization",required:true,schema:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{200:{description:"Features fetched successfully",content:{"application/json":{schema:{type:"array",items:{"x-go-type":"Feature",type:"object",required:["id","plan_id","quantity","feature"],properties:{id:{"x-oapi-codegen-extra-tags":{db:"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"}},plan_id:{"x-oapi-codegen-extra-tags":{db:"plan_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"}},plan:{"x-go-type":"plan.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/plan"},"x-oapi-codegen-extra-tags":{belongs_to:"plans",fk_id:"PlanId",yaml:"plan,omitempty",json:"plan,omitempty"},type:"object",properties:{id:{"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"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"}},name:{type:"string","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},description:"Name of the plan",enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{"x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["monthly","yearly"]},unit:{"x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimum_units:{type:"integer",description:"Minimum number of units required for the plan","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimum_units",csv:"minimum_units"}},price_per_unit:{type:"number",description:"Price per unit of the plan","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"price_per_unit",csv:"price_per_unit"}},currency:{"x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}},required:["id","name","cadence","unit","price_per_unit","minimum_units","price_id","currency"]},name:{"x-go-type":"FeatureName","x-oapi-codegen-extra-tags":{db:"name"},type:"string",enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign"],description:"Enumeration of possible feature types"},quantity:{type:"number",description:"Quantity of the feature allowed, use 9999999999 for unlimited","x-oapi-codegen-extra-tags":{db:"quantity"}},created_at:{"x-oapi-codegen-extra-tags":{db:"created_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updated_at:{"x-oapi-codegen-extra-tags":{db:"updated_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}},additionalProperties:false}}}}},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"}}}}}}}},components:{parameters:{organization_id:{name:"organizationId",in:"path",description:"The ID of the organization",required:true,schema:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}},schemas:{FeaturesPage:{type:"array",items:{"x-go-type":"Feature",type:"object",required:["id","plan_id","quantity","feature"],properties:{id:{"x-oapi-codegen-extra-tags":{db:"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"}},plan_id:{"x-oapi-codegen-extra-tags":{db:"plan_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"}},plan:{"x-go-type":"plan.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/plan"},"x-oapi-codegen-extra-tags":{belongs_to:"plans",fk_id:"PlanId",yaml:"plan,omitempty",json:"plan,omitempty"},type:"object",properties:{id:{"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"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"}},name:{type:"string","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},description:"Name of the plan",enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{"x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["monthly","yearly"]},unit:{"x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimum_units:{type:"integer",description:"Minimum number of units required for the plan","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimum_units",csv:"minimum_units"}},price_per_unit:{type:"number",description:"Price per unit of the plan","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"price_per_unit",csv:"price_per_unit"}},currency:{"x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}},required:["id","name","cadence","unit","price_per_unit","minimum_units","price_id","currency"]},name:{"x-go-type":"FeatureName","x-oapi-codegen-extra-tags":{db:"name"},type:"string",enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign"],description:"Enumeration of possible feature types"},quantity:{type:"number",description:"Quantity of the feature allowed, use 9999999999 for unlimited","x-oapi-codegen-extra-tags":{db:"quantity"}},created_at:{"x-oapi-codegen-extra-tags":{db:"created_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updated_at:{"x-oapi-codegen-extra-tags":{db:"updated_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}},additionalProperties:false}},FeatureName:{type:"string",enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign"],description:"Enumeration of possible feature types"},Feature:{type:"object",required:["id","plan_id","quantity","feature"],properties:{id:{"x-oapi-codegen-extra-tags":{db:"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"}},plan_id:{"x-oapi-codegen-extra-tags":{db:"plan_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"}},plan:{"x-go-type":"plan.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/plan"},"x-oapi-codegen-extra-tags":{belongs_to:"plans",fk_id:"PlanId",yaml:"plan,omitempty",json:"plan,omitempty"},type:"object",properties:{id:{"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"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"}},name:{type:"string","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},description:"Name of the plan",enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{"x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["monthly","yearly"]},unit:{"x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimum_units:{type:"integer",description:"Minimum number of units required for the plan","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimum_units",csv:"minimum_units"}},price_per_unit:{type:"number",description:"Price per unit of the plan","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"price_per_unit",csv:"price_per_unit"}},currency:{"x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}},required:["id","name","cadence","unit","price_per_unit","minimum_units","price_id","currency"]},name:{"x-go-type":"FeatureName","x-oapi-codegen-extra-tags":{db:"name"},type:"string",enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign"],description:"Enumeration of possible feature types"},quantity:{type:"number",description:"Quantity of the feature allowed, use 9999999999 for unlimited","x-oapi-codegen-extra-tags":{db:"quantity"}},created_at:{"x-oapi-codegen-extra-tags":{db:"created_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updated_at:{"x-oapi-codegen-extra-tags":{db:"updated_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}},additionalProperties:false}}}},t=e;module.exports=t;
1
+ 'use strict';var e={openapi:"3.0.0",info:{title:"Feature",description:"OpenAPI schema for the Features construct with entitlement-related properties.",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"}},tags:[{name:"Features",description:"Operations related to features and entitlements"}],paths:{"/api/entitlement/features":{get:{"x-internal":["cloud"],operationId:"getFeatures",tags:["Features"],summary:"Get all features associated with plans",responses:{200:{description:"Features fetched successfully",content:{"application/json":{schema:{type:"array",items:{"x-go-type":"Feature",type:"object",required:["id","plan_id","quantity","feature"],properties:{id:{"x-oapi-codegen-extra-tags":{db:"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"}},plan_id:{"x-oapi-codegen-extra-tags":{db:"plan_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"}},plan:{"x-go-type":"plan.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/plan"},"x-oapi-codegen-extra-tags":{belongs_to:"plans",fk_id:"PlanId",yaml:"plan,omitempty",json:"plan,omitempty"},type:"object",properties:{id:{"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"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"}},name:{type:"string","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},description:"Name of the plan",enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{"x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["monthly","yearly"]},unit:{"x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimum_units:{type:"integer",description:"Minimum number of units required for the plan","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimum_units",csv:"minimum_units"}},price_per_unit:{type:"number",description:"Price per unit of the plan","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"price_per_unit",csv:"price_per_unit"}},currency:{"x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}},required:["id","name","cadence","unit","price_per_unit","minimum_units","price_id","currency"]},name:{"x-go-type":"FeatureName","x-oapi-codegen-extra-tags":{db:"name"},type:"string",enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign"],description:"Enumeration of possible feature types"},quantity:{type:"number",description:"Quantity of the feature allowed, use 9999999999 for unlimited","x-oapi-codegen-extra-tags":{db:"quantity"}},created_at:{"x-oapi-codegen-extra-tags":{db:"created_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updated_at:{"x-oapi-codegen-extra-tags":{db:"updated_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}},additionalProperties:false}}}}},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/{organizationId}/features":{get:{"x-internal":["cloud"],operationId:"getFeaturesByOrganization",tags:["Features"],summary:"Get all features associated with plans",parameters:[{name:"organizationId",in:"path",description:"The ID of the organization",required:true,schema:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{200:{description:"Features fetched successfully",content:{"application/json":{schema:{type:"array",items:{"x-go-type":"Feature",type:"object",required:["id","plan_id","quantity","feature"],properties:{id:{"x-oapi-codegen-extra-tags":{db:"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"}},plan_id:{"x-oapi-codegen-extra-tags":{db:"plan_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"}},plan:{"x-go-type":"plan.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/plan"},"x-oapi-codegen-extra-tags":{belongs_to:"plans",fk_id:"PlanId",yaml:"plan,omitempty",json:"plan,omitempty"},type:"object",properties:{id:{"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"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"}},name:{type:"string","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},description:"Name of the plan",enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{"x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["monthly","yearly"]},unit:{"x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimum_units:{type:"integer",description:"Minimum number of units required for the plan","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimum_units",csv:"minimum_units"}},price_per_unit:{type:"number",description:"Price per unit of the plan","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"price_per_unit",csv:"price_per_unit"}},currency:{"x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}},required:["id","name","cadence","unit","price_per_unit","minimum_units","price_id","currency"]},name:{"x-go-type":"FeatureName","x-oapi-codegen-extra-tags":{db:"name"},type:"string",enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign"],description:"Enumeration of possible feature types"},quantity:{type:"number",description:"Quantity of the feature allowed, use 9999999999 for unlimited","x-oapi-codegen-extra-tags":{db:"quantity"}},created_at:{"x-oapi-codegen-extra-tags":{db:"created_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updated_at:{"x-oapi-codegen-extra-tags":{db:"updated_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}},additionalProperties:false}}}}},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"}}}}}}}},components:{parameters:{organization_id:{name:"organizationId",in:"path",description:"The ID of the organization",required:true,schema:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}},schemas:{FeaturesPage:{type:"array",items:{"x-go-type":"Feature",type:"object",required:["id","plan_id","quantity","feature"],properties:{id:{"x-oapi-codegen-extra-tags":{db:"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"}},plan_id:{"x-oapi-codegen-extra-tags":{db:"plan_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"}},plan:{"x-go-type":"plan.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/plan"},"x-oapi-codegen-extra-tags":{belongs_to:"plans",fk_id:"PlanId",yaml:"plan,omitempty",json:"plan,omitempty"},type:"object",properties:{id:{"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"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"}},name:{type:"string","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},description:"Name of the plan",enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{"x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["monthly","yearly"]},unit:{"x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimum_units:{type:"integer",description:"Minimum number of units required for the plan","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimum_units",csv:"minimum_units"}},price_per_unit:{type:"number",description:"Price per unit of the plan","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"price_per_unit",csv:"price_per_unit"}},currency:{"x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}},required:["id","name","cadence","unit","price_per_unit","minimum_units","price_id","currency"]},name:{"x-go-type":"FeatureName","x-oapi-codegen-extra-tags":{db:"name"},type:"string",enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign"],description:"Enumeration of possible feature types"},quantity:{type:"number",description:"Quantity of the feature allowed, use 9999999999 for unlimited","x-oapi-codegen-extra-tags":{db:"quantity"}},created_at:{"x-oapi-codegen-extra-tags":{db:"created_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updated_at:{"x-oapi-codegen-extra-tags":{db:"updated_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}},additionalProperties:false}},FeatureName:{type:"string",enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign"],description:"Enumeration of possible feature types"},Feature:{type:"object",required:["id","plan_id","quantity","feature"],properties:{id:{"x-oapi-codegen-extra-tags":{db:"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"}},plan_id:{"x-oapi-codegen-extra-tags":{db:"plan_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"}},plan:{"x-go-type":"plan.Plan","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/plan"},"x-oapi-codegen-extra-tags":{belongs_to:"plans",fk_id:"PlanId",yaml:"plan,omitempty",json:"plan,omitempty"},type:"object",properties:{id:{"x-oapi-codegen-extra-tags":{db:"id",json:"id",csv:"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"}},name:{type:"string","x-go-type":"PlanName","x-oapi-codegen-extra-tags":{db:"name",json:"name",csv:"name"},description:"Name of the plan",enum:["Free","Team Designer","Team Operator","Enterprise"]},cadence:{"x-go-type":"PlanCadence","x-oapi-codegen-extra-tags":{db:"cadence",json:"cadence",csv:"cadence"},type:"string",enum:["monthly","yearly"]},unit:{"x-go-type":"PlanUnit","x-oapi-codegen-extra-tags":{db:"unit",json:"unit",csv:"unit"},type:"string",enum:["user","free"]},minimum_units:{type:"integer",description:"Minimum number of units required for the plan","x-oapi-codegen-extra-tags":{db:"minimum_units",json:"minimum_units",csv:"minimum_units"}},price_per_unit:{type:"number",description:"Price per unit of the plan","x-oapi-codegen-extra-tags":{db:"price_per_unit",json:"price_per_unit",csv:"price_per_unit"}},currency:{"x-go-type":"Currency","x-oapi-codegen-extra-tags":{db:"currency",json:"currency",csv:"currency"},type:"string",enum:["usd"]}},required:["id","name","cadence","unit","price_per_unit","minimum_units","price_id","currency"]},name:{"x-go-type":"FeatureName","x-oapi-codegen-extra-tags":{db:"name"},type:"string",enum:["ComponentsInDesign","RelationshipsInDesign","DesignsInWorkspace","WorkspacesInOrganization","ImageSizeInDesign","SizePerDesign"],description:"Enumeration of possible feature types"},quantity:{type:"number",description:"Quantity of the feature allowed, use 9999999999 for unlimited","x-oapi-codegen-extra-tags":{db:"quantity"}},created_at:{"x-oapi-codegen-extra-tags":{db:"created_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updated_at:{"x-oapi-codegen-extra-tags":{db:"updated_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}},additionalProperties:false}}}},t=e;
2
+ module.exports=t;