@meshery/schemas 1.3.26 → 1.3.28
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 +27241 -10449
- package/dist/cloudApi.d.ts +27241 -10449
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta2/key/Key.d.ts +1 -1
- package/dist/constructs/v1beta2/key/KeySchema.js +1 -1
- package/dist/constructs/v1beta2/key/KeySchema.mjs +1 -1
- package/dist/constructs/v1beta3/academy/Academy.d.ts +27 -27
- package/dist/constructs/v1beta3/academy/AcademySchema.js +1 -1
- package/dist/constructs/v1beta3/academy/AcademySchema.mjs +1 -1
- package/dist/constructs/v1beta3/design/Design.d.ts +4 -1
- package/dist/constructs/v1beta3/design/DesignSchema.js +1 -1
- package/dist/constructs/v1beta3/design/DesignSchema.mjs +1 -1
- package/dist/constructs/v1beta3/invitation/Invitation.d.ts +133 -65
- package/dist/constructs/v1beta3/invitation/InvitationSchema.js +2 -2
- package/dist/constructs/v1beta3/invitation/InvitationSchema.mjs +2 -2
- package/dist/constructs/v1beta3/token/Token.d.ts +2 -2
- package/dist/constructs/v1beta3/token/TokenSchema.js +1 -1
- package/dist/constructs/v1beta3/token/TokenSchema.mjs +1 -1
- package/dist/mesheryApi.d.mts +12077 -4717
- package/dist/mesheryApi.d.ts +12077 -4717
- 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:"Key",description:"OpenAPI schema for authorization key 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:"Key",description:"Operations related to authorization keys"},{name:"users",description:"Operations related to users and their authorization keys"}],paths:{"/api/identity/orgs/{orgId}/users/keys":{get:{"x-internal":["cloud","meshery"],tags:["users"],operationId:"getUserKeys",summary:"Get User Keys",description:"Get all keys based on roles assigned to user",parameters:[{name:"orgId",in:"path",description:"Organization 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"}}],responses:{200:{description:"Returns user keys based on roles assigned to user",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."}}}}}},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/keys":{get:{"x-internal":["cloud"],tags:["Key"],summary:"List key",operationId:"getKeys",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:"Keys fetched",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"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},post:{"x-internal":["cloud"],tags:["Key"],summary:"Create or update a key",operationId:"upsertKey",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for creating or updating a key.",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1,"x-oapi-codegen-extra-tags":{json:"id,omitempty"}},function:{type:"string",description:"Operation permitted by the key.","x-order":2,maxLength:500},category:{type:"string",description:"Category for the key.","x-order":3,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-order":4,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-order":5,maxLength:5e3}}}}}},responses:{200:{description:"Key upserted",content:{"application/json":{schema:{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}}}}}},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/key/{keyId}":{get:{"x-internal":["cloud"],tags:["Key"],summary:"Get key by ID",operationId:"getKeyById",parameters:[{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:{200:{description:"Key response",content:{"application/json":{schema:{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}}}}}},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:["Key"],summary:"Delete key",operationId:"deleteKey",parameters:[{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 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"}}}}}}}},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:{orgId:{name:"orgId",in:"path",description:"Organization 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"}}},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"}}},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:{Key:{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}}},KeyPayload:{type:"object",description:"Payload for creating or updating a key.",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1,"x-oapi-codegen-extra-tags":{json:"id,omitempty"}},function:{type:"string",description:"Operation permitted by the key.","x-order":2,maxLength:500},category:{type:"string",description:"Category for the key.","x-order":3,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-order":4,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-order":5,maxLength:5e3}}},KeyPage:{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."}}}}}},t=e;
|
|
1
|
+
var e={openapi:"3.0.0",info:{title:"Key",description:"OpenAPI schema for authorization key 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:"Key",description:"Operations related to authorization keys"},{name:"users",description:"Operations related to users and their authorization keys"}],paths:{"/api/identity/orgs/{orgId}/users/keys":{get:{"x-internal":["cloud","meshery"],tags:["users"],operationId:"getUserKeys",summary:"Get User Keys",description:"Get all keys based on roles assigned to user",parameters:[{name:"orgId",in:"path",description:"Organization 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"}}],responses:{200:{description:"Returns user keys based on roles assigned to user",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."}}}}}},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/keys":{get:{"x-internal":["cloud"],tags:["Key"],summary:"List key",operationId:"getKeys",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:"Keys fetched",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"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}},post:{"x-internal":["cloud"],tags:["Key"],summary:"Create or update a key",operationId:"upsertKey",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for creating or updating a key.",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1,"x-oapi-codegen-extra-tags":{json:"id,omitempty"}},function:{type:"string",description:"Operation permitted by the key.","x-order":2,maxLength:500},category:{type:"string",description:"Category for the key.","x-order":3,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-order":4,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-order":5,maxLength:5e3}}}}}},responses:{200:{description:"Key upserted",content:{"application/json":{schema:{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}}}}}},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/keys/{keyId}":{get:{"x-internal":["cloud"],tags:["Key"],summary:"Get key by ID",operationId:"getKeyById",parameters:[{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:{200:{description:"Key response",content:{"application/json":{schema:{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}}}}}},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:["Key"],summary:"Delete key",operationId:"deleteKey",parameters:[{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 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"}}}}}}}},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:{orgId:{name:"orgId",in:"path",description:"Organization 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"}}},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"}}},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:{Key:{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}}},KeyPayload:{type:"object",description:"Payload for creating or updating a key.",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1,"x-oapi-codegen-extra-tags":{json:"id,omitempty"}},function:{type:"string",description:"Operation permitted by the key.","x-order":2,maxLength:500},category:{type:"string",description:"Category for the key.","x-order":3,maxLength:500},subcategory:{type:"string",description:"Subcategory for the key.","x-order":4,maxLength:500},description:{type:"string",description:"Human readable description of the key.","x-order":5,maxLength:5e3}}},KeyPage:{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."}}}}}},t=e;
|
|
2
2
|
export{t as default};
|
|
@@ -1063,12 +1063,12 @@ export interface components {
|
|
|
1063
1063
|
* Format: uuid
|
|
1064
1064
|
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1065
1065
|
*/
|
|
1066
|
-
id: string;
|
|
1066
|
+
readonly id: string;
|
|
1067
1067
|
/**
|
|
1068
1068
|
* Format: uuid
|
|
1069
1069
|
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1070
1070
|
*/
|
|
1071
|
-
owner: string;
|
|
1071
|
+
readonly owner: string;
|
|
1072
1072
|
/** @description Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain. An organization can only have one default invitation. */
|
|
1073
1073
|
isDefault?: boolean;
|
|
1074
1074
|
/** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
|
|
@@ -1076,21 +1076,21 @@ export interface components {
|
|
|
1076
1076
|
/** @description Description of the invitation, which can be used to provide additional context. Null or empty string means the invitation does not have a description. */
|
|
1077
1077
|
description: string;
|
|
1078
1078
|
/** @description Email addresses or patterns for which the invitation is valid. Null means the invitation is valid for any email address. */
|
|
1079
|
-
emails: string[];
|
|
1079
|
+
emails: string[] | null;
|
|
1080
1080
|
/**
|
|
1081
1081
|
* Format: uuid
|
|
1082
1082
|
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
1083
1083
|
*/
|
|
1084
|
-
orgId: string;
|
|
1084
|
+
readonly orgId: string;
|
|
1085
1085
|
/**
|
|
1086
1086
|
* Format: date-time
|
|
1087
1087
|
* @description Timestamp when the invitation expires, if applicable. Null or empty means the invitation does not expire.
|
|
1088
1088
|
*/
|
|
1089
|
-
expiresAt?: string;
|
|
1089
|
+
expiresAt?: string | null;
|
|
1090
1090
|
/** @description Quota for the invitation; limits the number of users that can accept it. Null or empty means the invitation is unlimited. */
|
|
1091
1091
|
quota?: number;
|
|
1092
1092
|
/** @description List of user ids that have already accepted the invitation. Empty means the invitation has not been used yet. */
|
|
1093
|
-
acceptedBy: string[];
|
|
1093
|
+
readonly acceptedBy: string[];
|
|
1094
1094
|
/** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
|
|
1095
1095
|
roles: string[];
|
|
1096
1096
|
/** @description Teams that the user will be added to when accepting the invitation. Empty means the invitation does not specify any teams. */
|
|
@@ -1104,17 +1104,17 @@ export interface components {
|
|
|
1104
1104
|
* Format: date-time
|
|
1105
1105
|
* @description Timestamp when the invitation was created.
|
|
1106
1106
|
*/
|
|
1107
|
-
createdAt: string;
|
|
1107
|
+
readonly createdAt: string;
|
|
1108
1108
|
/**
|
|
1109
1109
|
* Format: date-time
|
|
1110
1110
|
* @description Timestamp when the invitation was last updated.
|
|
1111
1111
|
*/
|
|
1112
|
-
updatedAt: string;
|
|
1112
|
+
readonly updatedAt: string;
|
|
1113
1113
|
/**
|
|
1114
1114
|
* Format: date-time
|
|
1115
1115
|
* @description Timestamp when the invitation was deleted, if applicable.
|
|
1116
1116
|
*/
|
|
1117
|
-
deletedAt: string;
|
|
1117
|
+
readonly deletedAt: string | null;
|
|
1118
1118
|
};
|
|
1119
1119
|
};
|
|
1120
1120
|
CreateAcademyCurriculaRequest: {
|
|
@@ -6280,12 +6280,12 @@ export interface operations {
|
|
|
6280
6280
|
* Format: uuid
|
|
6281
6281
|
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
6282
6282
|
*/
|
|
6283
|
-
id: string;
|
|
6283
|
+
readonly id: string;
|
|
6284
6284
|
/**
|
|
6285
6285
|
* Format: uuid
|
|
6286
6286
|
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
6287
6287
|
*/
|
|
6288
|
-
owner: string;
|
|
6288
|
+
readonly owner: string;
|
|
6289
6289
|
/** @description Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain. An organization can only have one default invitation. */
|
|
6290
6290
|
isDefault?: boolean;
|
|
6291
6291
|
/** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
|
|
@@ -6293,21 +6293,21 @@ export interface operations {
|
|
|
6293
6293
|
/** @description Description of the invitation, which can be used to provide additional context. Null or empty string means the invitation does not have a description. */
|
|
6294
6294
|
description: string;
|
|
6295
6295
|
/** @description Email addresses or patterns for which the invitation is valid. Null means the invitation is valid for any email address. */
|
|
6296
|
-
emails: string[];
|
|
6296
|
+
emails: string[] | null;
|
|
6297
6297
|
/**
|
|
6298
6298
|
* Format: uuid
|
|
6299
6299
|
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
6300
6300
|
*/
|
|
6301
|
-
orgId: string;
|
|
6301
|
+
readonly orgId: string;
|
|
6302
6302
|
/**
|
|
6303
6303
|
* Format: date-time
|
|
6304
6304
|
* @description Timestamp when the invitation expires, if applicable. Null or empty means the invitation does not expire.
|
|
6305
6305
|
*/
|
|
6306
|
-
expiresAt?: string;
|
|
6306
|
+
expiresAt?: string | null;
|
|
6307
6307
|
/** @description Quota for the invitation; limits the number of users that can accept it. Null or empty means the invitation is unlimited. */
|
|
6308
6308
|
quota?: number;
|
|
6309
6309
|
/** @description List of user ids that have already accepted the invitation. Empty means the invitation has not been used yet. */
|
|
6310
|
-
acceptedBy: string[];
|
|
6310
|
+
readonly acceptedBy: string[];
|
|
6311
6311
|
/** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
|
|
6312
6312
|
roles: string[];
|
|
6313
6313
|
/** @description Teams that the user will be added to when accepting the invitation. Empty means the invitation does not specify any teams. */
|
|
@@ -6321,17 +6321,17 @@ export interface operations {
|
|
|
6321
6321
|
* Format: date-time
|
|
6322
6322
|
* @description Timestamp when the invitation was created.
|
|
6323
6323
|
*/
|
|
6324
|
-
createdAt: string;
|
|
6324
|
+
readonly createdAt: string;
|
|
6325
6325
|
/**
|
|
6326
6326
|
* Format: date-time
|
|
6327
6327
|
* @description Timestamp when the invitation was last updated.
|
|
6328
6328
|
*/
|
|
6329
|
-
updatedAt: string;
|
|
6329
|
+
readonly updatedAt: string;
|
|
6330
6330
|
/**
|
|
6331
6331
|
* Format: date-time
|
|
6332
6332
|
* @description Timestamp when the invitation was deleted, if applicable.
|
|
6333
6333
|
*/
|
|
6334
|
-
deletedAt: string;
|
|
6334
|
+
readonly deletedAt: string | null;
|
|
6335
6335
|
};
|
|
6336
6336
|
};
|
|
6337
6337
|
};
|
|
@@ -6773,12 +6773,12 @@ export interface operations {
|
|
|
6773
6773
|
* Format: uuid
|
|
6774
6774
|
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
6775
6775
|
*/
|
|
6776
|
-
id: string;
|
|
6776
|
+
readonly id: string;
|
|
6777
6777
|
/**
|
|
6778
6778
|
* Format: uuid
|
|
6779
6779
|
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
6780
6780
|
*/
|
|
6781
|
-
owner: string;
|
|
6781
|
+
readonly owner: string;
|
|
6782
6782
|
/** @description Indicates whether the invitation is a default invitation (open invite), which can be used to assign users when signing up from fqdn or custom domain. An organization can only have one default invitation. */
|
|
6783
6783
|
isDefault?: boolean;
|
|
6784
6784
|
/** @description Name of the invitation, which can be used to identify it. Required; cannot be an empty string. */
|
|
@@ -6786,21 +6786,21 @@ export interface operations {
|
|
|
6786
6786
|
/** @description Description of the invitation, which can be used to provide additional context. Null or empty string means the invitation does not have a description. */
|
|
6787
6787
|
description: string;
|
|
6788
6788
|
/** @description Email addresses or patterns for which the invitation is valid. Null means the invitation is valid for any email address. */
|
|
6789
|
-
emails: string[];
|
|
6789
|
+
emails: string[] | null;
|
|
6790
6790
|
/**
|
|
6791
6791
|
* Format: uuid
|
|
6792
6792
|
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
6793
6793
|
*/
|
|
6794
|
-
orgId: string;
|
|
6794
|
+
readonly orgId: string;
|
|
6795
6795
|
/**
|
|
6796
6796
|
* Format: date-time
|
|
6797
6797
|
* @description Timestamp when the invitation expires, if applicable. Null or empty means the invitation does not expire.
|
|
6798
6798
|
*/
|
|
6799
|
-
expiresAt?: string;
|
|
6799
|
+
expiresAt?: string | null;
|
|
6800
6800
|
/** @description Quota for the invitation; limits the number of users that can accept it. Null or empty means the invitation is unlimited. */
|
|
6801
6801
|
quota?: number;
|
|
6802
6802
|
/** @description List of user ids that have already accepted the invitation. Empty means the invitation has not been used yet. */
|
|
6803
|
-
acceptedBy: string[];
|
|
6803
|
+
readonly acceptedBy: string[];
|
|
6804
6804
|
/** @description Roles that the user will have when accepting the invitation. Empty means the invitation does not specify any roles. */
|
|
6805
6805
|
roles: string[];
|
|
6806
6806
|
/** @description Teams that the user will be added to when accepting the invitation. Empty means the invitation does not specify any teams. */
|
|
@@ -6814,17 +6814,17 @@ export interface operations {
|
|
|
6814
6814
|
* Format: date-time
|
|
6815
6815
|
* @description Timestamp when the invitation was created.
|
|
6816
6816
|
*/
|
|
6817
|
-
createdAt: string;
|
|
6817
|
+
readonly createdAt: string;
|
|
6818
6818
|
/**
|
|
6819
6819
|
* Format: date-time
|
|
6820
6820
|
* @description Timestamp when the invitation was last updated.
|
|
6821
6821
|
*/
|
|
6822
|
-
updatedAt: string;
|
|
6822
|
+
readonly updatedAt: string;
|
|
6823
6823
|
/**
|
|
6824
6824
|
* Format: date-time
|
|
6825
6825
|
* @description Timestamp when the invitation was deleted, if applicable.
|
|
6826
6826
|
*/
|
|
6827
|
-
deletedAt: string;
|
|
6827
|
+
readonly deletedAt: string | null;
|
|
6828
6828
|
};
|
|
6829
6829
|
};
|
|
6830
6830
|
};
|