@meshery/schemas 1.3.20 → 1.3.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cloudApi.d.mts +431 -17
- package/dist/cloudApi.d.ts +431 -17
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta2/key/Key.d.ts +18 -3
- package/dist/constructs/v1beta2/key/KeySchema.js +1 -1
- package/dist/constructs/v1beta2/key/KeySchema.mjs +1 -1
- package/dist/constructs/v1beta2/keychain/Keychain.d.ts +18 -3
- package/dist/constructs/v1beta2/keychain/KeychainSchema.js +1 -1
- package/dist/constructs/v1beta2/keychain/KeychainSchema.mjs +1 -1
- package/dist/constructs/v1beta2/view/View.d.ts +12 -2
- package/dist/constructs/v1beta2/view/ViewSchema.js +2 -2
- package/dist/constructs/v1beta2/view/ViewSchema.mjs +2 -2
- package/dist/constructs/v1beta3/academy/Academy.d.ts +10 -0
- package/dist/constructs/v1beta3/academy/AcademySchema.js +1 -1
- package/dist/constructs/v1beta3/academy/AcademySchema.mjs +1 -1
- package/dist/constructs/v1beta3/connection/Connection.d.ts +793 -11
- package/dist/constructs/v1beta3/connection/ConnectionSchema.js +1 -1
- package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +1 -1
- package/dist/constructs/v1beta3/environment/Environment.d.ts +18 -3
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.js +1 -1
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.mjs +1 -1
- package/dist/constructs/v1beta3/event/Event.d.ts +19 -2
- package/dist/constructs/v1beta3/event/EventSchema.js +1 -1
- package/dist/constructs/v1beta3/event/EventSchema.mjs +1 -1
- package/dist/constructs/v1beta3/token/Token.d.ts +12 -2
- package/dist/constructs/v1beta3/token/TokenSchema.js +1 -1
- package/dist/constructs/v1beta3/token/TokenSchema.mjs +1 -1
- package/dist/constructs/v1beta3/workspace/Workspace.d.ts +36 -6
- package/dist/constructs/v1beta3/workspace/WorkspaceSchema.js +2 -2
- package/dist/constructs/v1beta3/workspace/WorkspaceSchema.mjs +2 -2
- package/dist/mesheryApi.d.mts +406 -10
- package/dist/mesheryApi.d.ts +406 -10
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/package.json +1 -1
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
var e={openapi:"3.0.0",info:{title:"Keychain",description:"OpenAPI schema for keychain management in Meshery.",version:"v1beta2",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},security:[{jwt:[]}],tags:[{name:"Keychain",description:"Operations related to keychains"}],paths:{"/api/auth/keychains":{get:{"x-internal":["cloud"],tags:["Keychain"],summary:"List keychains",operationId:"getKeychains",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}},{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"}}],responses:{200:{description:"Keychain(s) fetched",content:{"application/json":{schema:{type:"object",description:"A paginated list of keychains.",required:["page","pageSize","totalCount","keychains"],properties:{page:{type:"integer",description:"Zero-based page index returned in this response.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-order":1},pageSize:{type:"integer",description:"Maximum number of items returned on each page.",minimum:1,"x-go-type-skip-optional-pointer":true,"x-order":2,"x-oapi-codegen-extra-tags":{json:"pageSize"}},totalCount:{type:"integer",description:"Total number of items across all pages.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-order":3,"x-oapi-codegen-extra-tags":{json:"totalCount"}},keychains:{type:"array",items:{type:"object",additionalProperties:false,description:"Represents a collection of keys.",required:["id","name","owner","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the keychain.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the keychain.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"name",json:"name"},"x-order":2},owner:{description:"Owner of the keychain.","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":3,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":4},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":5},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":6}}},"x-order":4,description:"Keychains returned on the current page."}}}}}},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"}}}}}},post:{"x-internal":["cloud"],tags:["Keychain"],summary:"Create a keychain",operationId:"createKeychain",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for creating or updating a keychain.",required:["name"],properties:{name:{type:"string",description:"Name of the keychain.","x-order":1,minLength:1,maxLength:255},owner:{description:"Owner of the keychain.","x-order":2,"x-oapi-codegen-extra-tags":{json:"owner,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}}}}},responses:{201:{description:"Keychain created",content:{"application/json":{schema:{type:"object",additionalProperties:false,description:"Represents a collection of keys.",required:["id","name","owner","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the keychain.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the keychain.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"name",json:"name"},"x-order":2},owner:{description:"Owner of the keychain.","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":3,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":4},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":5},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":6}}}}}},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/auth/keychains/{keychainId}":{get:{"x-internal":["cloud"],tags:["Keychain"],summary:"Get keychain by ID",operationId:"getKeychainById",parameters:[{name:"keychainId",in:"path",description:"Keychain ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{200:{description:"Keychain fetched",content:{"application/json":{schema:{type:"object",additionalProperties:false,description:"Represents a collection of keys.",required:["id","name","owner","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the keychain.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the keychain.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"name",json:"name"},"x-order":2},owner:{description:"Owner of the keychain.","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":3,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":4},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":5},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":6}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},put:{"x-internal":["cloud"],tags:["Keychain"],summary:"Update keychain",operationId:"updateKeychain",parameters:[{name:"keychainId",in:"path",description:"Keychain ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for creating or updating a keychain.",required:["name"],properties:{name:{type:"string",description:"Name of the keychain.","x-order":1,minLength:1,maxLength:255},owner:{description:"Owner of the keychain.","x-order":2,"x-oapi-codegen-extra-tags":{json:"owner,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}}}}},responses:{200:{description:"Keychain updated",content:{"application/json":{schema:{type:"object",additionalProperties:false,description:"Represents a collection of keys.",required:["id","name","owner","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the keychain.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the keychain.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"name",json:"name"},"x-order":2},owner:{description:"Owner of the keychain.","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":3,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":4},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":5},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":6}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},delete:{"x-internal":["cloud"],tags:["Keychain"],summary:"Delete keychain",operationId:"deleteKeychain",parameters:[{name:"keychainId",in:"path",description:"Keychain ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{204:{description:"Keychain deleted"},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/auth/keychains/{keychainId}/{keyId}":{post:{"x-internal":["cloud"],tags:["Keychain"],summary:"Add key to keychain",operationId:"addKeyToKeychain",parameters:[{name:"keychainId",in:"path",description:"Keychain ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"keyId",in:"path",description:"Key ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{204:{description:"Key added to keychain"},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},delete:{"x-internal":["cloud"],tags:["Keychain"],summary:"Remove key from keychain",operationId:"removeKeyFromKeychain",parameters:[{name:"keychainId",in:"path",description:"Keychain ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"keyId",in:"path",description:"Key ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{204:{description:"Key removed from keychain"},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/auth/keychains/{keychainId}/keys":{get:{"x-internal":["cloud"],tags:["Keychain"],summary:"List keys in a keychain",operationId:"getKeysOfKeychain",parameters:[{name:"keychainId",in:"path",description:"Keychain ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}},{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"}}],responses:{200:{description:"Keys response",content:{"application/json":{schema:{type:"object",description:"A paginated list of authorization keys.",required:["page","pageSize","totalCount","keys"],properties:{page:{type:"integer",description:"Zero-based page index returned in this response.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-order":1},pageSize:{type:"integer",description:"Maximum number of items returned on each page.",minimum:1,"x-go-type-skip-optional-pointer":true,"x-order":2,"x-oapi-codegen-extra-tags":{json:"pageSize"}},totalCount:{type:"integer",description:"Total number of items across all pages.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-order":3,"x-oapi-codegen-extra-tags":{json:"totalCount"}},keys:{type:"array",items:{type:"object",additionalProperties:false,description:"Represents an authorization key used for access control.",required:["id","owner","function","category","subcategory","description","createdAt","updatedAt"],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-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-order":1},owner:{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-go-name":"Owner","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function",json:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category",json:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory",json:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description",json:"description"},"x-order":6,maxLength:5e3},createdAt:{type:"string",format:"date-time",description:"Timestamp when the key was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":7},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the key was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":8},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the key was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9}}},"x-order":4,description:"Keys returned on the current page."}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}}},components:{responses:{400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}},parameters:{keyId:{name:"keyId",in:"path",description:"Key ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},keychainId:{name:"keychainId",in:"path",description:"Keychain ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},page:{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},pagesize:{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"string"}},order:{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},search:{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}}},securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},schemas:{Keychain:{type:"object",additionalProperties:false,description:"Represents a collection of keys.",required:["id","name","owner","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the keychain.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the keychain.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"name",json:"name"},"x-order":2},owner:{description:"Owner of the keychain.","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":3,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":4},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":5},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":6}}},KeychainPayload:{type:"object",description:"Payload for creating or updating a keychain.",required:["name"],properties:{name:{type:"string",description:"Name of the keychain.","x-order":1,minLength:1,maxLength:255},owner:{description:"Owner of the keychain.","x-order":2,"x-oapi-codegen-extra-tags":{json:"owner,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}},KeychainPage:{type:"object",description:"A paginated list of keychains.",required:["page","pageSize","totalCount","keychains"],properties:{page:{type:"integer",description:"Zero-based page index returned in this response.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-order":1},pageSize:{type:"integer",description:"Maximum number of items returned on each page.",minimum:1,"x-go-type-skip-optional-pointer":true,"x-order":2,"x-oapi-codegen-extra-tags":{json:"pageSize"}},totalCount:{type:"integer",description:"Total number of items across all pages.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-order":3,"x-oapi-codegen-extra-tags":{json:"totalCount"}},keychains:{type:"array",items:{type:"object",additionalProperties:false,description:"Represents a collection of keys.",required:["id","name","owner","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the keychain.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the keychain.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"name",json:"name"},"x-order":2},owner:{description:"Owner of the keychain.","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":3,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":4},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":5},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":6}}},"x-order":4,description:"Keychains returned on the current page."}}}}}},t=e;
|
|
1
|
+
var e={openapi:"3.0.0",info:{title:"Keychain",description:"OpenAPI schema for keychain management in Meshery.",version:"v1beta2",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},security:[{jwt:[]}],tags:[{name:"Keychain",description:"Operations related to keychains"}],paths:{"/api/auth/keychains":{get:{"x-internal":["cloud"],tags:["Keychain"],summary:"List keychains",operationId:"getKeychains",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},{name:"pageSize",in:"query",description:"Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`.",schema:{type:"integer",minimum:1}},{name:"pagesize",in:"query",description:"Get responses by pagesize. Deprecated alias of pageSize.",deprecated:true,schema:{type:"string"}},{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"}}],responses:{200:{description:"Keychain(s) fetched",content:{"application/json":{schema:{type:"object",description:"A paginated list of keychains.",required:["page","pageSize","totalCount","keychains"],properties:{page:{type:"integer",description:"Zero-based page index returned in this response.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-order":1},pageSize:{type:"integer",description:"Maximum number of items returned on each page.",minimum:1,"x-go-type-skip-optional-pointer":true,"x-order":2,"x-oapi-codegen-extra-tags":{json:"pageSize"}},totalCount:{type:"integer",description:"Total number of items across all pages.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-order":3,"x-oapi-codegen-extra-tags":{json:"totalCount"}},keychains:{type:"array",items:{type:"object",additionalProperties:false,description:"Represents a collection of keys.",required:["id","name","owner","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the keychain.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the keychain.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"name",json:"name"},"x-order":2},owner:{description:"Owner of the keychain.","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":3,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":4},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":5},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":6}}},"x-order":4,description:"Keychains returned on the current page."}}}}}},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"}}}}}},post:{"x-internal":["cloud"],tags:["Keychain"],summary:"Create a keychain",operationId:"createKeychain",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for creating or updating a keychain.",required:["name"],properties:{name:{type:"string",description:"Name of the keychain.","x-order":1,minLength:1,maxLength:255},owner:{description:"Owner of the keychain.","x-order":2,"x-oapi-codegen-extra-tags":{json:"owner,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}}}}},responses:{201:{description:"Keychain created",content:{"application/json":{schema:{type:"object",additionalProperties:false,description:"Represents a collection of keys.",required:["id","name","owner","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the keychain.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the keychain.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"name",json:"name"},"x-order":2},owner:{description:"Owner of the keychain.","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":3,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":4},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":5},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":6}}}}}},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/auth/keychains/{keychainId}":{get:{"x-internal":["cloud"],tags:["Keychain"],summary:"Get keychain by ID",operationId:"getKeychainById",parameters:[{name:"keychainId",in:"path",description:"Keychain ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{200:{description:"Keychain fetched",content:{"application/json":{schema:{type:"object",additionalProperties:false,description:"Represents a collection of keys.",required:["id","name","owner","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the keychain.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the keychain.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"name",json:"name"},"x-order":2},owner:{description:"Owner of the keychain.","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":3,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":4},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":5},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":6}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},put:{"x-internal":["cloud"],tags:["Keychain"],summary:"Update keychain",operationId:"updateKeychain",parameters:[{name:"keychainId",in:"path",description:"Keychain ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for creating or updating a keychain.",required:["name"],properties:{name:{type:"string",description:"Name of the keychain.","x-order":1,minLength:1,maxLength:255},owner:{description:"Owner of the keychain.","x-order":2,"x-oapi-codegen-extra-tags":{json:"owner,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}}}}},responses:{200:{description:"Keychain updated",content:{"application/json":{schema:{type:"object",additionalProperties:false,description:"Represents a collection of keys.",required:["id","name","owner","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the keychain.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the keychain.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"name",json:"name"},"x-order":2},owner:{description:"Owner of the keychain.","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":3,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":4},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":5},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":6}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},delete:{"x-internal":["cloud"],tags:["Keychain"],summary:"Delete keychain",operationId:"deleteKeychain",parameters:[{name:"keychainId",in:"path",description:"Keychain ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{204:{description:"Keychain deleted"},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/auth/keychains/{keychainId}/{keyId}":{post:{"x-internal":["cloud"],tags:["Keychain"],summary:"Add key to keychain",operationId:"addKeyToKeychain",parameters:[{name:"keychainId",in:"path",description:"Keychain ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"keyId",in:"path",description:"Key ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{204:{description:"Key added to keychain"},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},delete:{"x-internal":["cloud"],tags:["Keychain"],summary:"Remove key from keychain",operationId:"removeKeyFromKeychain",parameters:[{name:"keychainId",in:"path",description:"Keychain ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"keyId",in:"path",description:"Key ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}],responses:{204:{description:"Key removed from keychain"},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/auth/keychains/{keychainId}/keys":{get:{"x-internal":["cloud"],tags:["Keychain"],summary:"List keys in a keychain",operationId:"getKeysOfKeychain",parameters:[{name:"keychainId",in:"path",description:"Keychain ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},{name:"pageSize",in:"query",description:"Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`.",schema:{type:"integer",minimum:1}},{name:"pagesize",in:"query",description:"Get responses by pagesize. Deprecated alias of pageSize.",deprecated:true,schema:{type:"string"}},{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"}}],responses:{200:{description:"Keys response",content:{"application/json":{schema:{type:"object",description:"A paginated list of authorization keys.",required:["page","pageSize","totalCount","keys"],properties:{page:{type:"integer",description:"Zero-based page index returned in this response.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-order":1},pageSize:{type:"integer",description:"Maximum number of items returned on each page.",minimum:1,"x-go-type-skip-optional-pointer":true,"x-order":2,"x-oapi-codegen-extra-tags":{json:"pageSize"}},totalCount:{type:"integer",description:"Total number of items across all pages.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-order":3,"x-oapi-codegen-extra-tags":{json:"totalCount"}},keys:{type:"array",items:{type:"object",additionalProperties:false,description:"Represents an authorization key used for access control.",required:["id","owner","function","category","subcategory","description","createdAt","updatedAt"],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-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-order":1},owner:{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-go-name":"Owner","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":2},function:{type:"string",description:"Operation permitted by the key.","x-oapi-codegen-extra-tags":{db:"function",json:"function"},"x-order":3,maxLength:500},category:{type:"string",description:"Category for the key.","x-oapi-codegen-extra-tags":{db:"category",json:"category"},"x-order":4,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-oapi-codegen-extra-tags":{db:"subcategory",json:"subcategory"},"x-order":5,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-oapi-codegen-extra-tags":{db:"description",json:"description"},"x-order":6,maxLength:5e3},createdAt:{type:"string",format:"date-time",description:"Timestamp when the key was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":7},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the key was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":8},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the key was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9}}},"x-order":4,description:"Keys returned on the current page."}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}}},components:{responses:{400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}},parameters:{keyId:{name:"keyId",in:"path",description:"Key ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},keychainId:{name:"keychainId",in:"path",description:"Keychain ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},page:{name:"page",in:"query",description:"Get responses by page",schema:{type:"string"}},pageSize:{name:"pageSize",in:"query",description:"Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`.",schema:{type:"integer",minimum:1}},pagesize:{name:"pagesize",in:"query",description:"Get responses by pagesize. Deprecated alias of pageSize.",deprecated:true,schema:{type:"string"}},order:{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},search:{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}}},securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},schemas:{Keychain:{type:"object",additionalProperties:false,description:"Represents a collection of keys.",required:["id","name","owner","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the keychain.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the keychain.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"name",json:"name"},"x-order":2},owner:{description:"Owner of the keychain.","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":3,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":4},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":5},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":6}}},KeychainPayload:{type:"object",description:"Payload for creating or updating a keychain.",required:["name"],properties:{name:{type:"string",description:"Name of the keychain.","x-order":1,minLength:1,maxLength:255},owner:{description:"Owner of the keychain.","x-order":2,"x-oapi-codegen-extra-tags":{json:"owner,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}}},KeychainPage:{type:"object",description:"A paginated list of keychains.",required:["page","pageSize","totalCount","keychains"],properties:{page:{type:"integer",description:"Zero-based page index returned in this response.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-order":1},pageSize:{type:"integer",description:"Maximum number of items returned on each page.",minimum:1,"x-go-type-skip-optional-pointer":true,"x-order":2,"x-oapi-codegen-extra-tags":{json:"pageSize"}},totalCount:{type:"integer",description:"Total number of items across all pages.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-order":3,"x-oapi-codegen-extra-tags":{json:"totalCount"}},keychains:{type:"array",items:{type:"object",additionalProperties:false,description:"Represents a collection of keys.",required:["id","name","owner","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the keychain.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},"x-order":1,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the keychain.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"name",json:"name"},"x-order":2},owner:{description:"Owner of the keychain.","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":3,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":4},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":5},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the keychain was soft-deleted.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":6}}},"x-order":4,description:"Keychains returned on the current page."}}}}}},t=e;
|
|
2
2
|
export{t as default};
|
|
@@ -331,7 +331,12 @@ export interface components {
|
|
|
331
331
|
order: string;
|
|
332
332
|
/** @description Get responses by page */
|
|
333
333
|
page: string;
|
|
334
|
-
/** @description
|
|
334
|
+
/** @description Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
|
|
335
|
+
pageSize: number;
|
|
336
|
+
/**
|
|
337
|
+
* @deprecated
|
|
338
|
+
* @description Get responses by pagesize. Deprecated alias of pageSize.
|
|
339
|
+
*/
|
|
335
340
|
pagesize: string;
|
|
336
341
|
/** @description Organization ID to scope the request. */
|
|
337
342
|
orgIdQuery: string;
|
|
@@ -394,7 +399,12 @@ export interface operations {
|
|
|
394
399
|
order?: string;
|
|
395
400
|
/** @description Get responses by page */
|
|
396
401
|
page?: string;
|
|
397
|
-
/** @description
|
|
402
|
+
/** @description Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
|
|
403
|
+
pageSize?: number;
|
|
404
|
+
/**
|
|
405
|
+
* @deprecated
|
|
406
|
+
* @description Get responses by pagesize. Deprecated alias of pageSize.
|
|
407
|
+
*/
|
|
398
408
|
pagesize?: string;
|
|
399
409
|
/** @description JSON-encoded filter string for assignment and soft-delete filters. */
|
|
400
410
|
filter?: string;
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
'use strict';var e={openapi:"3.0.0",info:{title:"View",description:"OpenAPI schema for managing Meshery views \u2014 saved perspectives with filters and metadata.",version:"v1beta2",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:"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:"views",description:"APIs for managing Meshery views."}],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"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}},parameters:{viewId:{name:"viewId",in:"path",description:"View ID",schema:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"view_id",json:"view_id"},"x-go-type-name":"ViewId","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:"Organization ID to scope the request.",schema:{type:"string"},required:false},userIdQuery:{name:"userId",in:"query",description:"UUID of the user whose views to retrieve.",schema:{type:"string"},required:false}},securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},schemas:{MesheryView:{$id:"https://schemas.meshery.io/view.yaml",$schema:"http://json-schema.org/draft-07/schema#",title:"MesheryView",description:"A saved view with filters and metadata that defines a customized perspective of Meshery resources. Learn more at https://docs.meshery.io/concepts/logical/views",additionalProperties:false,type:"object",example:{id:"00000000-0000-0000-0000-000000000000",name:"My Kubernetes View",visibility:"private",filters:{},metadata:{},userId:"00000000-0000-0000-0000-000000000000",createdAt:"0001-01-01T00:00:00Z",updatedAt:"0001-01-01T00:00:00Z",deletedAt:null},required:["id","name","visibility","userId","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the view.","x-order":1,"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Display name of the view.",maxLength:255,minLength:1,"x-order":2,"x-oapi-codegen-extra-tags":{db:"name",json:"name"}},visibility:{type:"string",description:"Visibility level of the view.",maxLength:255,"x-order":3,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"visibility",json:"visibility"}},filters:{type:"object",description:"Filter configuration that defines which resources this view displays.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-order":4,"x-oapi-codegen-extra-tags":{db:"filters",json:"filters"}},metadata:{type:"object",description:"Additional metadata associated with the view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-order":5,"x-oapi-codegen-extra-tags":{db:"metadata",json:"metadata"}},userId:{description:"ID of the user who created the view.","x-go-name":"UserID","x-go-type-skip-optional-pointer":true,"x-order":6,"x-oapi-codegen-extra-tags":{db:"user_id",json:"userId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the view was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":7},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the view was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":8},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the view was soft deleted. Null while the view remains active.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9}}},MesheryViewWithLocation:{type:"object",description:"A view enriched with the workspace and organization it belongs to.",required:["workspaceId","organizationId"],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},name:{type:"string",description:"Display name of the view.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"name",json:"name,omitempty"}},visibility:{type:"string",description:"Visibility level of the view.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"visibility",json:"visibility,omitempty"}},filters:{type:"object",description:"Filter configuration for this view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"filters",json:"filters,omitempty"}},metadata:{type:"object",description:"Metadata associated with the view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"metadata",json:"metadata,omitempty"}},userId:{description:"ID of the user who created the view.","x-go-name":"UserID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"user_id",json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},workspaceName:{type:"string",description:"Name of the workspace this view belongs to.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"workspace_name",json:"workspaceName,omitempty"}},workspaceId:{description:"ID of the workspace this view belongs to.","x-go-name":"WorkspaceID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"workspace_id",json:"workspaceId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"ID of the organization this view belongs to.","x-go-name":"OrganizationID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"organization_id",json:"organizationId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationName:{type:"string",description:"Name of the organization this view belongs to.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"organization_name",json:"organizationName,omitempty"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the view was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"}},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the view was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"}},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the view was soft deleted. Null while the view remains active.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"}}}},ViewPayload:{type:"object",description:"Payload for creating or updating a view.",required:["name"],properties:{name:{type:"string",description:"Display name of the view.",maxLength:255,minLength:1,"x-oapi-codegen-extra-tags":{json:"name,omitempty"}},filters:{type:"object",description:"Filter configuration for this view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"filters,omitempty"}},visibility:{type:"string",description:"Visibility level of the view.",maxLength:255,"x-oapi-codegen-extra-tags":{json:"visibility,omitempty"}},metadata:{type:"object",description:"Metadata associated with the view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"metadata,omitempty"}}}},ContentSharePayload:{type:"object",description:"Payload for sharing a view with one or more recipients by email. The\nwire format matches the canonical design share payload\n(`design.ContentSharePayload` in `v1beta2/design`), restricted to the\n`view` content type since that is all this endpoint accepts.\n",required:["contentId","contentType","emails","share"],properties:{contentId:{description:"Identifier of the view being shared.","x-oapi-codegen-extra-tags":{json:"contentId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},contentType:{type:"string",description:"The kind of content being shared. Only `view` is accepted on this\nendpoint.\n",enum:["view"],"x-oapi-codegen-extra-tags":{json:"contentType"}},emails:{type:"array",description:"Email addresses of the recipients to share this view with.",items:{type:"string",format:"email"}},share:{type:"boolean",description:`When true, flip the view's visibility to public and send invitation
|
|
1
|
+
'use strict';var e={openapi:"3.0.0",info:{title:"View",description:"OpenAPI schema for managing Meshery views \u2014 saved perspectives with filters and metadata.",version:"v1beta2",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:"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:"views",description:"APIs for managing Meshery views."}],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"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}},parameters:{viewId:{name:"viewId",in:"path",description:"View ID",schema:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"view_id",json:"view_id"},"x-go-type-name":"ViewId","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:"Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`.",schema:{type:"integer",minimum:1}},pagesize:{name:"pagesize",in:"query",description:"Get responses by pagesize. Deprecated alias of pageSize.",deprecated:true,schema:{type:"string"}},orgIdQuery:{name:"orgId",in:"query",description:"Organization ID to scope the request.",schema:{type:"string"},required:false},userIdQuery:{name:"userId",in:"query",description:"UUID of the user whose views to retrieve.",schema:{type:"string"},required:false}},securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},schemas:{MesheryView:{$id:"https://schemas.meshery.io/view.yaml",$schema:"http://json-schema.org/draft-07/schema#",title:"MesheryView",description:"A saved view with filters and metadata that defines a customized perspective of Meshery resources. Learn more at https://docs.meshery.io/concepts/logical/views",additionalProperties:false,type:"object",example:{id:"00000000-0000-0000-0000-000000000000",name:"My Kubernetes View",visibility:"private",filters:{},metadata:{},userId:"00000000-0000-0000-0000-000000000000",createdAt:"0001-01-01T00:00:00Z",updatedAt:"0001-01-01T00:00:00Z",deletedAt:null},required:["id","name","visibility","userId","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the view.","x-order":1,"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Display name of the view.",maxLength:255,minLength:1,"x-order":2,"x-oapi-codegen-extra-tags":{db:"name",json:"name"}},visibility:{type:"string",description:"Visibility level of the view.",maxLength:255,"x-order":3,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"visibility",json:"visibility"}},filters:{type:"object",description:"Filter configuration that defines which resources this view displays.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-order":4,"x-oapi-codegen-extra-tags":{db:"filters",json:"filters"}},metadata:{type:"object",description:"Additional metadata associated with the view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-order":5,"x-oapi-codegen-extra-tags":{db:"metadata",json:"metadata"}},userId:{description:"ID of the user who created the view.","x-go-name":"UserID","x-go-type-skip-optional-pointer":true,"x-order":6,"x-oapi-codegen-extra-tags":{db:"user_id",json:"userId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the view was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":7},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the view was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":8},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the view was soft deleted. Null while the view remains active.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9}}},MesheryViewWithLocation:{type:"object",description:"A view enriched with the workspace and organization it belongs to.",required:["workspaceId","organizationId"],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},name:{type:"string",description:"Display name of the view.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"name",json:"name,omitempty"}},visibility:{type:"string",description:"Visibility level of the view.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"visibility",json:"visibility,omitempty"}},filters:{type:"object",description:"Filter configuration for this view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"filters",json:"filters,omitempty"}},metadata:{type:"object",description:"Metadata associated with the view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"metadata",json:"metadata,omitempty"}},userId:{description:"ID of the user who created the view.","x-go-name":"UserID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"user_id",json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},workspaceName:{type:"string",description:"Name of the workspace this view belongs to.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"workspace_name",json:"workspaceName,omitempty"}},workspaceId:{description:"ID of the workspace this view belongs to.","x-go-name":"WorkspaceID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"workspace_id",json:"workspaceId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"ID of the organization this view belongs to.","x-go-name":"OrganizationID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"organization_id",json:"organizationId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationName:{type:"string",description:"Name of the organization this view belongs to.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"organization_name",json:"organizationName,omitempty"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the view was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"}},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the view was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"}},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the view was soft deleted. Null while the view remains active.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"}}}},ViewPayload:{type:"object",description:"Payload for creating or updating a view.",required:["name"],properties:{name:{type:"string",description:"Display name of the view.",maxLength:255,minLength:1,"x-oapi-codegen-extra-tags":{json:"name,omitempty"}},filters:{type:"object",description:"Filter configuration for this view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"filters,omitempty"}},visibility:{type:"string",description:"Visibility level of the view.",maxLength:255,"x-oapi-codegen-extra-tags":{json:"visibility,omitempty"}},metadata:{type:"object",description:"Metadata associated with the view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"metadata,omitempty"}}}},ContentSharePayload:{type:"object",description:"Payload for sharing a view with one or more recipients by email. The\nwire format matches the canonical design share payload\n(`design.ContentSharePayload` in `v1beta2/design`), restricted to the\n`view` content type since that is all this endpoint accepts.\n",required:["contentId","contentType","emails","share"],properties:{contentId:{description:"Identifier of the view being shared.","x-oapi-codegen-extra-tags":{json:"contentId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},contentType:{type:"string",description:"The kind of content being shared. Only `view` is accepted on this\nendpoint.\n",enum:["view"],"x-oapi-codegen-extra-tags":{json:"contentType"}},emails:{type:"array",description:"Email addresses of the recipients to share this view with.",items:{type:"string",format:"email"}},share:{type:"boolean",description:`When true, flip the view's visibility to public and send invitation
|
|
2
2
|
emails to the recipients. When false, revert visibility to private.
|
|
3
3
|
`}}},MesheryViewPage:{type:"object",description:"Paginated list of views with location enrichment.",properties:{page:{type:"integer",description:"Zero-based page index returned in this response.",minimum:0,"x-go-type-skip-optional-pointer":true},pageSize:{type:"integer",description:"Maximum number of items returned on each page.",minimum:1,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"pageSize,omitempty"}},totalCount:{type:"integer",description:"Total number of items across all pages.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"totalCount,omitempty"}},views:{type:"array","x-go-type-skip-optional-pointer":true,items:{"x-go-type":"MesheryViewWithLocation",type:"object",description:"A view enriched with the workspace and organization it belongs to.",required:["workspaceId","organizationId"],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},name:{type:"string",description:"Display name of the view.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"name",json:"name,omitempty"}},visibility:{type:"string",description:"Visibility level of the view.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"visibility",json:"visibility,omitempty"}},filters:{type:"object",description:"Filter configuration for this view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"filters",json:"filters,omitempty"}},metadata:{type:"object",description:"Metadata associated with the view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"metadata",json:"metadata,omitempty"}},userId:{description:"ID of the user who created the view.","x-go-name":"UserID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"user_id",json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},workspaceName:{type:"string",description:"Name of the workspace this view belongs to.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"workspace_name",json:"workspaceName,omitempty"}},workspaceId:{description:"ID of the workspace this view belongs to.","x-go-name":"WorkspaceID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"workspace_id",json:"workspaceId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"ID of the organization this view belongs to.","x-go-name":"OrganizationID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"organization_id",json:"organizationId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationName:{type:"string",description:"Name of the organization this view belongs to.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"organization_name",json:"organizationName,omitempty"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the view was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"}},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the view was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"}},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the view was soft deleted. Null while the view remains active.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"}}}},description:"Views in this page, enriched with workspace and organization context."}}}},requestBodies:{viewPayload:{description:"Body for creating or updating a view",required:true,content:{"application/json":{schema:{type:"object",description:"Payload for creating or updating a view.",required:["name"],properties:{name:{type:"string",description:"Display name of the view.",maxLength:255,minLength:1,"x-oapi-codegen-extra-tags":{json:"name,omitempty"}},filters:{type:"object",description:"Filter configuration for this view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"filters,omitempty"}},visibility:{type:"string",description:"Visibility level of the view.",maxLength:255,"x-oapi-codegen-extra-tags":{json:"visibility,omitempty"}},metadata:{type:"object",description:"Metadata associated with the view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"metadata,omitempty"}}}}}}},contentSharePayload:{description:"Body for sharing a view with recipients by email.",required:true,content:{"application/json":{schema:{type:"object",description:"Payload for sharing a view with one or more recipients by email. The\nwire format matches the canonical design share payload\n(`design.ContentSharePayload` in `v1beta2/design`), restricted to the\n`view` content type since that is all this endpoint accepts.\n",required:["contentId","contentType","emails","share"],properties:{contentId:{description:"Identifier of the view being shared.","x-oapi-codegen-extra-tags":{json:"contentId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},contentType:{type:"string",description:"The kind of content being shared. Only `view` is accepted on this\nendpoint.\n",enum:["view"],"x-oapi-codegen-extra-tags":{json:"contentType"}},emails:{type:"array",description:"Email addresses of the recipients to share this view with.",items:{type:"string",format:"email"}},share:{type:"boolean",description:`When true, flip the view's visibility to public and send invitation
|
|
4
4
|
emails to the recipients. When false, revert visibility to private.
|
|
5
|
-
`}}}}}}}},paths:{"/api/content/views":{post:{"x-internal":["cloud"],tags:["views"],operationId:"createView",summary:"Create a view",description:"Creates a new view with the given filters and metadata.",requestBody:{description:"Body for creating or updating a view",required:true,content:{"application/json":{schema:{type:"object",description:"Payload for creating or updating a view.",required:["name"],properties:{name:{type:"string",description:"Display name of the view.",maxLength:255,minLength:1,"x-oapi-codegen-extra-tags":{json:"name,omitempty"}},filters:{type:"object",description:"Filter configuration for this view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"filters,omitempty"}},visibility:{type:"string",description:"Visibility level of the view.",maxLength:255,"x-oapi-codegen-extra-tags":{json:"visibility,omitempty"}},metadata:{type:"object",description:"Metadata associated with the view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"metadata,omitempty"}}}}}}},responses:{201:{description:"Created view",content:{"application/json":{schema:{$id:"https://schemas.meshery.io/view.yaml",$schema:"http://json-schema.org/draft-07/schema#",title:"MesheryView",description:"A saved view with filters and metadata that defines a customized perspective of Meshery resources. Learn more at https://docs.meshery.io/concepts/logical/views",additionalProperties:false,type:"object",example:{id:"00000000-0000-0000-0000-000000000000",name:"My Kubernetes View",visibility:"private",filters:{},metadata:{},userId:"00000000-0000-0000-0000-000000000000",createdAt:"0001-01-01T00:00:00Z",updatedAt:"0001-01-01T00:00:00Z",deletedAt:null},required:["id","name","visibility","userId","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the view.","x-order":1,"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Display name of the view.",maxLength:255,minLength:1,"x-order":2,"x-oapi-codegen-extra-tags":{db:"name",json:"name"}},visibility:{type:"string",description:"Visibility level of the view.",maxLength:255,"x-order":3,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"visibility",json:"visibility"}},filters:{type:"object",description:"Filter configuration that defines which resources this view displays.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-order":4,"x-oapi-codegen-extra-tags":{db:"filters",json:"filters"}},metadata:{type:"object",description:"Additional metadata associated with the view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-order":5,"x-oapi-codegen-extra-tags":{db:"metadata",json:"metadata"}},userId:{description:"ID of the user who created the view.","x-go-name":"UserID","x-go-type-skip-optional-pointer":true,"x-order":6,"x-oapi-codegen-extra-tags":{db:"user_id",json:"userId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the view was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":7},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the view was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":8},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the view was soft deleted. Null while the view remains active.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9}}}}}},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"}}}}}},get:{"x-internal":["cloud"],tags:["views"],operationId:"getViews",summary:"Get views",description:"Returns a paginated list of views accessible to the user.",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:"filter",in:"query",description:"JSON-encoded filter string for assignment and soft-delete filters.",required:false,schema:{type:"string"}},{name:"shared",in:"query",description:"When true, include views shared with the user.",required:false,schema:{type:"boolean"}},{name:"visibility",in:"query",description:"Filter by visibility level (public, private).",required:false,schema:{type:"string"}},{name:"orgId",in:"query",description:"Organization ID to scope the request.",schema:{type:"string"},required:false},{name:"userId",in:"query",description:"UUID of the user whose views to retrieve.",schema:{type:"string"},required:false}],responses:{200:{description:"Views page",content:{"application/json":{schema:{type:"object",description:"Paginated list of views with location enrichment.",properties:{page:{type:"integer",description:"Zero-based page index returned in this response.",minimum:0,"x-go-type-skip-optional-pointer":true},pageSize:{type:"integer",description:"Maximum number of items returned on each page.",minimum:1,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"pageSize,omitempty"}},totalCount:{type:"integer",description:"Total number of items across all pages.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"totalCount,omitempty"}},views:{type:"array","x-go-type-skip-optional-pointer":true,items:{"x-go-type":"MesheryViewWithLocation",type:"object",description:"A view enriched with the workspace and organization it belongs to.",required:["workspaceId","organizationId"],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},name:{type:"string",description:"Display name of the view.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"name",json:"name,omitempty"}},visibility:{type:"string",description:"Visibility level of the view.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"visibility",json:"visibility,omitempty"}},filters:{type:"object",description:"Filter configuration for this view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"filters",json:"filters,omitempty"}},metadata:{type:"object",description:"Metadata associated with the view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"metadata",json:"metadata,omitempty"}},userId:{description:"ID of the user who created the view.","x-go-name":"UserID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"user_id",json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},workspaceName:{type:"string",description:"Name of the workspace this view belongs to.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"workspace_name",json:"workspaceName,omitempty"}},workspaceId:{description:"ID of the workspace this view belongs to.","x-go-name":"WorkspaceID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"workspace_id",json:"workspaceId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"ID of the organization this view belongs to.","x-go-name":"OrganizationID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"organization_id",json:"organizationId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationName:{type:"string",description:"Name of the organization this view belongs to.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"organization_name",json:"organizationName,omitempty"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the view was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"}},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the view was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"}},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the view was soft deleted. Null while the view remains active.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"}}}},description:"Views in this page, enriched with workspace and organization context."}}}}}},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/content/view/share":{post:{"x-internal":["cloud"],tags:["views"],operationId:"shareView",summary:"Share a view by email",description:`Shares a view with a list of email addresses. When \`share\` is true, the
|
|
5
|
+
`}}}}}}}},paths:{"/api/content/views":{post:{"x-internal":["cloud"],tags:["views"],operationId:"createView",summary:"Create a view",description:"Creates a new view with the given filters and metadata.",requestBody:{description:"Body for creating or updating a view",required:true,content:{"application/json":{schema:{type:"object",description:"Payload for creating or updating a view.",required:["name"],properties:{name:{type:"string",description:"Display name of the view.",maxLength:255,minLength:1,"x-oapi-codegen-extra-tags":{json:"name,omitempty"}},filters:{type:"object",description:"Filter configuration for this view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"filters,omitempty"}},visibility:{type:"string",description:"Visibility level of the view.",maxLength:255,"x-oapi-codegen-extra-tags":{json:"visibility,omitempty"}},metadata:{type:"object",description:"Metadata associated with the view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"metadata,omitempty"}}}}}}},responses:{201:{description:"Created view",content:{"application/json":{schema:{$id:"https://schemas.meshery.io/view.yaml",$schema:"http://json-schema.org/draft-07/schema#",title:"MesheryView",description:"A saved view with filters and metadata that defines a customized perspective of Meshery resources. Learn more at https://docs.meshery.io/concepts/logical/views",additionalProperties:false,type:"object",example:{id:"00000000-0000-0000-0000-000000000000",name:"My Kubernetes View",visibility:"private",filters:{},metadata:{},userId:"00000000-0000-0000-0000-000000000000",createdAt:"0001-01-01T00:00:00Z",updatedAt:"0001-01-01T00:00:00Z",deletedAt:null},required:["id","name","visibility","userId","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the view.","x-order":1,"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Display name of the view.",maxLength:255,minLength:1,"x-order":2,"x-oapi-codegen-extra-tags":{db:"name",json:"name"}},visibility:{type:"string",description:"Visibility level of the view.",maxLength:255,"x-order":3,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"visibility",json:"visibility"}},filters:{type:"object",description:"Filter configuration that defines which resources this view displays.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-order":4,"x-oapi-codegen-extra-tags":{db:"filters",json:"filters"}},metadata:{type:"object",description:"Additional metadata associated with the view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-order":5,"x-oapi-codegen-extra-tags":{db:"metadata",json:"metadata"}},userId:{description:"ID of the user who created the view.","x-go-name":"UserID","x-go-type-skip-optional-pointer":true,"x-order":6,"x-oapi-codegen-extra-tags":{db:"user_id",json:"userId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the view was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":7},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the view was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":8},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the view was soft deleted. Null while the view remains active.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9}}}}}},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"}}}}}},get:{"x-internal":["cloud"],tags:["views"],operationId:"getViews",summary:"Get views",description:"Returns a paginated list of views accessible to the user.",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:"Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`.",schema:{type:"integer",minimum:1}},{name:"pagesize",in:"query",description:"Get responses by pagesize. Deprecated alias of pageSize.",deprecated:true,schema:{type:"string"}},{name:"filter",in:"query",description:"JSON-encoded filter string for assignment and soft-delete filters.",required:false,schema:{type:"string"}},{name:"shared",in:"query",description:"When true, include views shared with the user.",required:false,schema:{type:"boolean"}},{name:"visibility",in:"query",description:"Filter by visibility level (public, private).",required:false,schema:{type:"string"}},{name:"orgId",in:"query",description:"Organization ID to scope the request.",schema:{type:"string"},required:false},{name:"userId",in:"query",description:"UUID of the user whose views to retrieve.",schema:{type:"string"},required:false}],responses:{200:{description:"Views page",content:{"application/json":{schema:{type:"object",description:"Paginated list of views with location enrichment.",properties:{page:{type:"integer",description:"Zero-based page index returned in this response.",minimum:0,"x-go-type-skip-optional-pointer":true},pageSize:{type:"integer",description:"Maximum number of items returned on each page.",minimum:1,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"pageSize,omitempty"}},totalCount:{type:"integer",description:"Total number of items across all pages.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"totalCount,omitempty"}},views:{type:"array","x-go-type-skip-optional-pointer":true,items:{"x-go-type":"MesheryViewWithLocation",type:"object",description:"A view enriched with the workspace and organization it belongs to.",required:["workspaceId","organizationId"],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},name:{type:"string",description:"Display name of the view.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"name",json:"name,omitempty"}},visibility:{type:"string",description:"Visibility level of the view.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"visibility",json:"visibility,omitempty"}},filters:{type:"object",description:"Filter configuration for this view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"filters",json:"filters,omitempty"}},metadata:{type:"object",description:"Metadata associated with the view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"metadata",json:"metadata,omitempty"}},userId:{description:"ID of the user who created the view.","x-go-name":"UserID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"user_id",json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},workspaceName:{type:"string",description:"Name of the workspace this view belongs to.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"workspace_name",json:"workspaceName,omitempty"}},workspaceId:{description:"ID of the workspace this view belongs to.","x-go-name":"WorkspaceID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"workspace_id",json:"workspaceId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"ID of the organization this view belongs to.","x-go-name":"OrganizationID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"organization_id",json:"organizationId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationName:{type:"string",description:"Name of the organization this view belongs to.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"organization_name",json:"organizationName,omitempty"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the view was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"}},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the view was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"}},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the view was soft deleted. Null while the view remains active.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"}}}},description:"Views in this page, enriched with workspace and organization context."}}}}}},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/content/view/share":{post:{"x-internal":["cloud"],tags:["views"],operationId:"shareView",summary:"Share a view by email",description:`Shares a view with a list of email addresses. When \`share\` is true, the
|
|
6
6
|
view's visibility is flipped to public and an invitation email is sent
|
|
7
7
|
to each recipient. When \`share\` is false, visibility is reverted to
|
|
8
8
|
private. Only the owner of the view (or a provider admin) may change
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
var e={openapi:"3.0.0",info:{title:"View",description:"OpenAPI schema for managing Meshery views \u2014 saved perspectives with filters and metadata.",version:"v1beta2",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:"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:"views",description:"APIs for managing Meshery views."}],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"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}},parameters:{viewId:{name:"viewId",in:"path",description:"View ID",schema:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"view_id",json:"view_id"},"x-go-type-name":"ViewId","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:"Organization ID to scope the request.",schema:{type:"string"},required:false},userIdQuery:{name:"userId",in:"query",description:"UUID of the user whose views to retrieve.",schema:{type:"string"},required:false}},securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},schemas:{MesheryView:{$id:"https://schemas.meshery.io/view.yaml",$schema:"http://json-schema.org/draft-07/schema#",title:"MesheryView",description:"A saved view with filters and metadata that defines a customized perspective of Meshery resources. Learn more at https://docs.meshery.io/concepts/logical/views",additionalProperties:false,type:"object",example:{id:"00000000-0000-0000-0000-000000000000",name:"My Kubernetes View",visibility:"private",filters:{},metadata:{},userId:"00000000-0000-0000-0000-000000000000",createdAt:"0001-01-01T00:00:00Z",updatedAt:"0001-01-01T00:00:00Z",deletedAt:null},required:["id","name","visibility","userId","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the view.","x-order":1,"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Display name of the view.",maxLength:255,minLength:1,"x-order":2,"x-oapi-codegen-extra-tags":{db:"name",json:"name"}},visibility:{type:"string",description:"Visibility level of the view.",maxLength:255,"x-order":3,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"visibility",json:"visibility"}},filters:{type:"object",description:"Filter configuration that defines which resources this view displays.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-order":4,"x-oapi-codegen-extra-tags":{db:"filters",json:"filters"}},metadata:{type:"object",description:"Additional metadata associated with the view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-order":5,"x-oapi-codegen-extra-tags":{db:"metadata",json:"metadata"}},userId:{description:"ID of the user who created the view.","x-go-name":"UserID","x-go-type-skip-optional-pointer":true,"x-order":6,"x-oapi-codegen-extra-tags":{db:"user_id",json:"userId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the view was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":7},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the view was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":8},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the view was soft deleted. Null while the view remains active.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9}}},MesheryViewWithLocation:{type:"object",description:"A view enriched with the workspace and organization it belongs to.",required:["workspaceId","organizationId"],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},name:{type:"string",description:"Display name of the view.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"name",json:"name,omitempty"}},visibility:{type:"string",description:"Visibility level of the view.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"visibility",json:"visibility,omitempty"}},filters:{type:"object",description:"Filter configuration for this view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"filters",json:"filters,omitempty"}},metadata:{type:"object",description:"Metadata associated with the view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"metadata",json:"metadata,omitempty"}},userId:{description:"ID of the user who created the view.","x-go-name":"UserID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"user_id",json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},workspaceName:{type:"string",description:"Name of the workspace this view belongs to.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"workspace_name",json:"workspaceName,omitempty"}},workspaceId:{description:"ID of the workspace this view belongs to.","x-go-name":"WorkspaceID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"workspace_id",json:"workspaceId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"ID of the organization this view belongs to.","x-go-name":"OrganizationID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"organization_id",json:"organizationId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationName:{type:"string",description:"Name of the organization this view belongs to.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"organization_name",json:"organizationName,omitempty"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the view was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"}},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the view was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"}},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the view was soft deleted. Null while the view remains active.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"}}}},ViewPayload:{type:"object",description:"Payload for creating or updating a view.",required:["name"],properties:{name:{type:"string",description:"Display name of the view.",maxLength:255,minLength:1,"x-oapi-codegen-extra-tags":{json:"name,omitempty"}},filters:{type:"object",description:"Filter configuration for this view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"filters,omitempty"}},visibility:{type:"string",description:"Visibility level of the view.",maxLength:255,"x-oapi-codegen-extra-tags":{json:"visibility,omitempty"}},metadata:{type:"object",description:"Metadata associated with the view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"metadata,omitempty"}}}},ContentSharePayload:{type:"object",description:"Payload for sharing a view with one or more recipients by email. The\nwire format matches the canonical design share payload\n(`design.ContentSharePayload` in `v1beta2/design`), restricted to the\n`view` content type since that is all this endpoint accepts.\n",required:["contentId","contentType","emails","share"],properties:{contentId:{description:"Identifier of the view being shared.","x-oapi-codegen-extra-tags":{json:"contentId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},contentType:{type:"string",description:"The kind of content being shared. Only `view` is accepted on this\nendpoint.\n",enum:["view"],"x-oapi-codegen-extra-tags":{json:"contentType"}},emails:{type:"array",description:"Email addresses of the recipients to share this view with.",items:{type:"string",format:"email"}},share:{type:"boolean",description:`When true, flip the view's visibility to public and send invitation
|
|
1
|
+
var e={openapi:"3.0.0",info:{title:"View",description:"OpenAPI schema for managing Meshery views \u2014 saved perspectives with filters and metadata.",version:"v1beta2",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:"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:"views",description:"APIs for managing Meshery views."}],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"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}},parameters:{viewId:{name:"viewId",in:"path",description:"View ID",schema:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"view_id",json:"view_id"},"x-go-type-name":"ViewId","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:"Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`.",schema:{type:"integer",minimum:1}},pagesize:{name:"pagesize",in:"query",description:"Get responses by pagesize. Deprecated alias of pageSize.",deprecated:true,schema:{type:"string"}},orgIdQuery:{name:"orgId",in:"query",description:"Organization ID to scope the request.",schema:{type:"string"},required:false},userIdQuery:{name:"userId",in:"query",description:"UUID of the user whose views to retrieve.",schema:{type:"string"},required:false}},securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},schemas:{MesheryView:{$id:"https://schemas.meshery.io/view.yaml",$schema:"http://json-schema.org/draft-07/schema#",title:"MesheryView",description:"A saved view with filters and metadata that defines a customized perspective of Meshery resources. Learn more at https://docs.meshery.io/concepts/logical/views",additionalProperties:false,type:"object",example:{id:"00000000-0000-0000-0000-000000000000",name:"My Kubernetes View",visibility:"private",filters:{},metadata:{},userId:"00000000-0000-0000-0000-000000000000",createdAt:"0001-01-01T00:00:00Z",updatedAt:"0001-01-01T00:00:00Z",deletedAt:null},required:["id","name","visibility","userId","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the view.","x-order":1,"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Display name of the view.",maxLength:255,minLength:1,"x-order":2,"x-oapi-codegen-extra-tags":{db:"name",json:"name"}},visibility:{type:"string",description:"Visibility level of the view.",maxLength:255,"x-order":3,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"visibility",json:"visibility"}},filters:{type:"object",description:"Filter configuration that defines which resources this view displays.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-order":4,"x-oapi-codegen-extra-tags":{db:"filters",json:"filters"}},metadata:{type:"object",description:"Additional metadata associated with the view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-order":5,"x-oapi-codegen-extra-tags":{db:"metadata",json:"metadata"}},userId:{description:"ID of the user who created the view.","x-go-name":"UserID","x-go-type-skip-optional-pointer":true,"x-order":6,"x-oapi-codegen-extra-tags":{db:"user_id",json:"userId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the view was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":7},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the view was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":8},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the view was soft deleted. Null while the view remains active.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9}}},MesheryViewWithLocation:{type:"object",description:"A view enriched with the workspace and organization it belongs to.",required:["workspaceId","organizationId"],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},name:{type:"string",description:"Display name of the view.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"name",json:"name,omitempty"}},visibility:{type:"string",description:"Visibility level of the view.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"visibility",json:"visibility,omitempty"}},filters:{type:"object",description:"Filter configuration for this view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"filters",json:"filters,omitempty"}},metadata:{type:"object",description:"Metadata associated with the view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"metadata",json:"metadata,omitempty"}},userId:{description:"ID of the user who created the view.","x-go-name":"UserID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"user_id",json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},workspaceName:{type:"string",description:"Name of the workspace this view belongs to.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"workspace_name",json:"workspaceName,omitempty"}},workspaceId:{description:"ID of the workspace this view belongs to.","x-go-name":"WorkspaceID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"workspace_id",json:"workspaceId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"ID of the organization this view belongs to.","x-go-name":"OrganizationID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"organization_id",json:"organizationId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationName:{type:"string",description:"Name of the organization this view belongs to.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"organization_name",json:"organizationName,omitempty"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the view was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"}},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the view was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"}},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the view was soft deleted. Null while the view remains active.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"}}}},ViewPayload:{type:"object",description:"Payload for creating or updating a view.",required:["name"],properties:{name:{type:"string",description:"Display name of the view.",maxLength:255,minLength:1,"x-oapi-codegen-extra-tags":{json:"name,omitempty"}},filters:{type:"object",description:"Filter configuration for this view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"filters,omitempty"}},visibility:{type:"string",description:"Visibility level of the view.",maxLength:255,"x-oapi-codegen-extra-tags":{json:"visibility,omitempty"}},metadata:{type:"object",description:"Metadata associated with the view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"metadata,omitempty"}}}},ContentSharePayload:{type:"object",description:"Payload for sharing a view with one or more recipients by email. The\nwire format matches the canonical design share payload\n(`design.ContentSharePayload` in `v1beta2/design`), restricted to the\n`view` content type since that is all this endpoint accepts.\n",required:["contentId","contentType","emails","share"],properties:{contentId:{description:"Identifier of the view being shared.","x-oapi-codegen-extra-tags":{json:"contentId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},contentType:{type:"string",description:"The kind of content being shared. Only `view` is accepted on this\nendpoint.\n",enum:["view"],"x-oapi-codegen-extra-tags":{json:"contentType"}},emails:{type:"array",description:"Email addresses of the recipients to share this view with.",items:{type:"string",format:"email"}},share:{type:"boolean",description:`When true, flip the view's visibility to public and send invitation
|
|
2
2
|
emails to the recipients. When false, revert visibility to private.
|
|
3
3
|
`}}},MesheryViewPage:{type:"object",description:"Paginated list of views with location enrichment.",properties:{page:{type:"integer",description:"Zero-based page index returned in this response.",minimum:0,"x-go-type-skip-optional-pointer":true},pageSize:{type:"integer",description:"Maximum number of items returned on each page.",minimum:1,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"pageSize,omitempty"}},totalCount:{type:"integer",description:"Total number of items across all pages.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"totalCount,omitempty"}},views:{type:"array","x-go-type-skip-optional-pointer":true,items:{"x-go-type":"MesheryViewWithLocation",type:"object",description:"A view enriched with the workspace and organization it belongs to.",required:["workspaceId","organizationId"],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},name:{type:"string",description:"Display name of the view.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"name",json:"name,omitempty"}},visibility:{type:"string",description:"Visibility level of the view.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"visibility",json:"visibility,omitempty"}},filters:{type:"object",description:"Filter configuration for this view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"filters",json:"filters,omitempty"}},metadata:{type:"object",description:"Metadata associated with the view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"metadata",json:"metadata,omitempty"}},userId:{description:"ID of the user who created the view.","x-go-name":"UserID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"user_id",json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},workspaceName:{type:"string",description:"Name of the workspace this view belongs to.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"workspace_name",json:"workspaceName,omitempty"}},workspaceId:{description:"ID of the workspace this view belongs to.","x-go-name":"WorkspaceID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"workspace_id",json:"workspaceId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"ID of the organization this view belongs to.","x-go-name":"OrganizationID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"organization_id",json:"organizationId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationName:{type:"string",description:"Name of the organization this view belongs to.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"organization_name",json:"organizationName,omitempty"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the view was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"}},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the view was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"}},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the view was soft deleted. Null while the view remains active.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"}}}},description:"Views in this page, enriched with workspace and organization context."}}}},requestBodies:{viewPayload:{description:"Body for creating or updating a view",required:true,content:{"application/json":{schema:{type:"object",description:"Payload for creating or updating a view.",required:["name"],properties:{name:{type:"string",description:"Display name of the view.",maxLength:255,minLength:1,"x-oapi-codegen-extra-tags":{json:"name,omitempty"}},filters:{type:"object",description:"Filter configuration for this view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"filters,omitempty"}},visibility:{type:"string",description:"Visibility level of the view.",maxLength:255,"x-oapi-codegen-extra-tags":{json:"visibility,omitempty"}},metadata:{type:"object",description:"Metadata associated with the view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"metadata,omitempty"}}}}}}},contentSharePayload:{description:"Body for sharing a view with recipients by email.",required:true,content:{"application/json":{schema:{type:"object",description:"Payload for sharing a view with one or more recipients by email. The\nwire format matches the canonical design share payload\n(`design.ContentSharePayload` in `v1beta2/design`), restricted to the\n`view` content type since that is all this endpoint accepts.\n",required:["contentId","contentType","emails","share"],properties:{contentId:{description:"Identifier of the view being shared.","x-oapi-codegen-extra-tags":{json:"contentId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},contentType:{type:"string",description:"The kind of content being shared. Only `view` is accepted on this\nendpoint.\n",enum:["view"],"x-oapi-codegen-extra-tags":{json:"contentType"}},emails:{type:"array",description:"Email addresses of the recipients to share this view with.",items:{type:"string",format:"email"}},share:{type:"boolean",description:`When true, flip the view's visibility to public and send invitation
|
|
4
4
|
emails to the recipients. When false, revert visibility to private.
|
|
5
|
-
`}}}}}}}},paths:{"/api/content/views":{post:{"x-internal":["cloud"],tags:["views"],operationId:"createView",summary:"Create a view",description:"Creates a new view with the given filters and metadata.",requestBody:{description:"Body for creating or updating a view",required:true,content:{"application/json":{schema:{type:"object",description:"Payload for creating or updating a view.",required:["name"],properties:{name:{type:"string",description:"Display name of the view.",maxLength:255,minLength:1,"x-oapi-codegen-extra-tags":{json:"name,omitempty"}},filters:{type:"object",description:"Filter configuration for this view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"filters,omitempty"}},visibility:{type:"string",description:"Visibility level of the view.",maxLength:255,"x-oapi-codegen-extra-tags":{json:"visibility,omitempty"}},metadata:{type:"object",description:"Metadata associated with the view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"metadata,omitempty"}}}}}}},responses:{201:{description:"Created view",content:{"application/json":{schema:{$id:"https://schemas.meshery.io/view.yaml",$schema:"http://json-schema.org/draft-07/schema#",title:"MesheryView",description:"A saved view with filters and metadata that defines a customized perspective of Meshery resources. Learn more at https://docs.meshery.io/concepts/logical/views",additionalProperties:false,type:"object",example:{id:"00000000-0000-0000-0000-000000000000",name:"My Kubernetes View",visibility:"private",filters:{},metadata:{},userId:"00000000-0000-0000-0000-000000000000",createdAt:"0001-01-01T00:00:00Z",updatedAt:"0001-01-01T00:00:00Z",deletedAt:null},required:["id","name","visibility","userId","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the view.","x-order":1,"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Display name of the view.",maxLength:255,minLength:1,"x-order":2,"x-oapi-codegen-extra-tags":{db:"name",json:"name"}},visibility:{type:"string",description:"Visibility level of the view.",maxLength:255,"x-order":3,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"visibility",json:"visibility"}},filters:{type:"object",description:"Filter configuration that defines which resources this view displays.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-order":4,"x-oapi-codegen-extra-tags":{db:"filters",json:"filters"}},metadata:{type:"object",description:"Additional metadata associated with the view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-order":5,"x-oapi-codegen-extra-tags":{db:"metadata",json:"metadata"}},userId:{description:"ID of the user who created the view.","x-go-name":"UserID","x-go-type-skip-optional-pointer":true,"x-order":6,"x-oapi-codegen-extra-tags":{db:"user_id",json:"userId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the view was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":7},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the view was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":8},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the view was soft deleted. Null while the view remains active.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9}}}}}},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"}}}}}},get:{"x-internal":["cloud"],tags:["views"],operationId:"getViews",summary:"Get views",description:"Returns a paginated list of views accessible to the user.",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:"filter",in:"query",description:"JSON-encoded filter string for assignment and soft-delete filters.",required:false,schema:{type:"string"}},{name:"shared",in:"query",description:"When true, include views shared with the user.",required:false,schema:{type:"boolean"}},{name:"visibility",in:"query",description:"Filter by visibility level (public, private).",required:false,schema:{type:"string"}},{name:"orgId",in:"query",description:"Organization ID to scope the request.",schema:{type:"string"},required:false},{name:"userId",in:"query",description:"UUID of the user whose views to retrieve.",schema:{type:"string"},required:false}],responses:{200:{description:"Views page",content:{"application/json":{schema:{type:"object",description:"Paginated list of views with location enrichment.",properties:{page:{type:"integer",description:"Zero-based page index returned in this response.",minimum:0,"x-go-type-skip-optional-pointer":true},pageSize:{type:"integer",description:"Maximum number of items returned on each page.",minimum:1,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"pageSize,omitempty"}},totalCount:{type:"integer",description:"Total number of items across all pages.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"totalCount,omitempty"}},views:{type:"array","x-go-type-skip-optional-pointer":true,items:{"x-go-type":"MesheryViewWithLocation",type:"object",description:"A view enriched with the workspace and organization it belongs to.",required:["workspaceId","organizationId"],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},name:{type:"string",description:"Display name of the view.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"name",json:"name,omitempty"}},visibility:{type:"string",description:"Visibility level of the view.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"visibility",json:"visibility,omitempty"}},filters:{type:"object",description:"Filter configuration for this view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"filters",json:"filters,omitempty"}},metadata:{type:"object",description:"Metadata associated with the view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"metadata",json:"metadata,omitempty"}},userId:{description:"ID of the user who created the view.","x-go-name":"UserID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"user_id",json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},workspaceName:{type:"string",description:"Name of the workspace this view belongs to.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"workspace_name",json:"workspaceName,omitempty"}},workspaceId:{description:"ID of the workspace this view belongs to.","x-go-name":"WorkspaceID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"workspace_id",json:"workspaceId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"ID of the organization this view belongs to.","x-go-name":"OrganizationID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"organization_id",json:"organizationId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationName:{type:"string",description:"Name of the organization this view belongs to.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"organization_name",json:"organizationName,omitempty"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the view was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"}},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the view was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"}},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the view was soft deleted. Null while the view remains active.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"}}}},description:"Views in this page, enriched with workspace and organization context."}}}}}},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/content/view/share":{post:{"x-internal":["cloud"],tags:["views"],operationId:"shareView",summary:"Share a view by email",description:`Shares a view with a list of email addresses. When \`share\` is true, the
|
|
5
|
+
`}}}}}}}},paths:{"/api/content/views":{post:{"x-internal":["cloud"],tags:["views"],operationId:"createView",summary:"Create a view",description:"Creates a new view with the given filters and metadata.",requestBody:{description:"Body for creating or updating a view",required:true,content:{"application/json":{schema:{type:"object",description:"Payload for creating or updating a view.",required:["name"],properties:{name:{type:"string",description:"Display name of the view.",maxLength:255,minLength:1,"x-oapi-codegen-extra-tags":{json:"name,omitempty"}},filters:{type:"object",description:"Filter configuration for this view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"filters,omitempty"}},visibility:{type:"string",description:"Visibility level of the view.",maxLength:255,"x-oapi-codegen-extra-tags":{json:"visibility,omitempty"}},metadata:{type:"object",description:"Metadata associated with the view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"metadata,omitempty"}}}}}}},responses:{201:{description:"Created view",content:{"application/json":{schema:{$id:"https://schemas.meshery.io/view.yaml",$schema:"http://json-schema.org/draft-07/schema#",title:"MesheryView",description:"A saved view with filters and metadata that defines a customized perspective of Meshery resources. Learn more at https://docs.meshery.io/concepts/logical/views",additionalProperties:false,type:"object",example:{id:"00000000-0000-0000-0000-000000000000",name:"My Kubernetes View",visibility:"private",filters:{},metadata:{},userId:"00000000-0000-0000-0000-000000000000",createdAt:"0001-01-01T00:00:00Z",updatedAt:"0001-01-01T00:00:00Z",deletedAt:null},required:["id","name","visibility","userId","createdAt","updatedAt"],properties:{id:{description:"Unique identifier for the view.","x-order":1,"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Display name of the view.",maxLength:255,minLength:1,"x-order":2,"x-oapi-codegen-extra-tags":{db:"name",json:"name"}},visibility:{type:"string",description:"Visibility level of the view.",maxLength:255,"x-order":3,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"visibility",json:"visibility"}},filters:{type:"object",description:"Filter configuration that defines which resources this view displays.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-order":4,"x-oapi-codegen-extra-tags":{db:"filters",json:"filters"}},metadata:{type:"object",description:"Additional metadata associated with the view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-order":5,"x-oapi-codegen-extra-tags":{db:"metadata",json:"metadata"}},userId:{description:"ID of the user who created the view.","x-go-name":"UserID","x-go-type-skip-optional-pointer":true,"x-order":6,"x-oapi-codegen-extra-tags":{db:"user_id",json:"userId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the view was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},"x-order":7},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the view was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},"x-order":8},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the view was soft deleted. Null while the view remains active.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"},"x-order":9}}}}}},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"}}}}}},get:{"x-internal":["cloud"],tags:["views"],operationId:"getViews",summary:"Get views",description:"Returns a paginated list of views accessible to the user.",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:"Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`.",schema:{type:"integer",minimum:1}},{name:"pagesize",in:"query",description:"Get responses by pagesize. Deprecated alias of pageSize.",deprecated:true,schema:{type:"string"}},{name:"filter",in:"query",description:"JSON-encoded filter string for assignment and soft-delete filters.",required:false,schema:{type:"string"}},{name:"shared",in:"query",description:"When true, include views shared with the user.",required:false,schema:{type:"boolean"}},{name:"visibility",in:"query",description:"Filter by visibility level (public, private).",required:false,schema:{type:"string"}},{name:"orgId",in:"query",description:"Organization ID to scope the request.",schema:{type:"string"},required:false},{name:"userId",in:"query",description:"UUID of the user whose views to retrieve.",schema:{type:"string"},required:false}],responses:{200:{description:"Views page",content:{"application/json":{schema:{type:"object",description:"Paginated list of views with location enrichment.",properties:{page:{type:"integer",description:"Zero-based page index returned in this response.",minimum:0,"x-go-type-skip-optional-pointer":true},pageSize:{type:"integer",description:"Maximum number of items returned on each page.",minimum:1,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"pageSize,omitempty"}},totalCount:{type:"integer",description:"Total number of items across all pages.",minimum:0,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{json:"totalCount,omitempty"}},views:{type:"array","x-go-type-skip-optional-pointer":true,items:{"x-go-type":"MesheryViewWithLocation",type:"object",description:"A view enriched with the workspace and organization it belongs to.",required:["workspaceId","organizationId"],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},name:{type:"string",description:"Display name of the view.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"name",json:"name,omitempty"}},visibility:{type:"string",description:"Visibility level of the view.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"visibility",json:"visibility,omitempty"}},filters:{type:"object",description:"Filter configuration for this view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"filters",json:"filters,omitempty"}},metadata:{type:"object",description:"Metadata associated with the view.","x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"metadata",json:"metadata,omitempty"}},userId:{description:"ID of the user who created the view.","x-go-name":"UserID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"user_id",json:"userId,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},workspaceName:{type:"string",description:"Name of the workspace this view belongs to.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"workspace_name",json:"workspaceName,omitempty"}},workspaceId:{description:"ID of the workspace this view belongs to.","x-go-name":"WorkspaceID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"workspace_id",json:"workspaceId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationId:{description:"ID of the organization this view belongs to.","x-go-name":"OrganizationID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"organization_id",json:"organizationId"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},organizationName:{type:"string",description:"Name of the organization this view belongs to.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"organization_name",json:"organizationName,omitempty"}},createdAt:{type:"string",format:"date-time",description:"Timestamp when the view was created.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"}},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the view was last updated.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"}},deletedAt:{type:"string",format:"date-time",description:"Timestamp when the view was soft deleted. Null while the view remains active.",nullable:true,"x-go-type":"core.NullTime","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"}}}},description:"Views in this page, enriched with workspace and organization context."}}}}}},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/content/view/share":{post:{"x-internal":["cloud"],tags:["views"],operationId:"shareView",summary:"Share a view by email",description:`Shares a view with a list of email addresses. When \`share\` is true, the
|
|
6
6
|
view's visibility is flipped to public and an invitation email is sent
|
|
7
7
|
to each recipient. When \`share\` is false, visibility is reverted to
|
|
8
8
|
private. Only the owner of the view (or a provider admin) may change
|
|
@@ -4787,6 +4787,11 @@ export interface operations {
|
|
|
4787
4787
|
/** @description Order of sorting (asc or desc) */
|
|
4788
4788
|
order?: "asc" | "desc";
|
|
4789
4789
|
/** @description Number of results per page */
|
|
4790
|
+
pageSize?: number;
|
|
4791
|
+
/**
|
|
4792
|
+
* @deprecated
|
|
4793
|
+
* @description Number of results per page. Deprecated alias of pageSize.
|
|
4794
|
+
*/
|
|
4790
4795
|
pagesize?: number;
|
|
4791
4796
|
/** @description Page number */
|
|
4792
4797
|
page?: number;
|
|
@@ -8146,6 +8151,11 @@ export interface operations {
|
|
|
8146
8151
|
parameters: {
|
|
8147
8152
|
query?: {
|
|
8148
8153
|
/** @description Number of results per page */
|
|
8154
|
+
pageSize?: number;
|
|
8155
|
+
/**
|
|
8156
|
+
* @deprecated
|
|
8157
|
+
* @description Number of results per page. Deprecated alias of pageSize.
|
|
8158
|
+
*/
|
|
8149
8159
|
pagesize?: number;
|
|
8150
8160
|
/** @description Page number */
|
|
8151
8161
|
page?: number;
|