@meshery/schemas 1.2.20 → 1.2.22
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 +9 -9
- package/dist/cloudApi.d.ts +9 -9
- package/dist/constructs/v1beta1/academy/Academy.d.ts +65 -65
- package/dist/constructs/v1beta1/academy/AcademySchema.js +1 -1
- package/dist/constructs/v1beta1/academy/AcademySchema.mjs +1 -1
- package/dist/constructs/v1beta1/role/Role.d.ts +1 -1
- package/dist/constructs/v1beta1/role/RoleSchema.js +1 -1
- package/dist/constructs/v1beta1/role/RoleSchema.mjs +1 -1
- package/dist/constructs/v1beta1/user/User.d.ts +8 -8
- package/dist/constructs/v1beta1/user/UserSchema.js +1 -1
- package/dist/constructs/v1beta1/user/UserSchema.mjs +1 -1
- package/dist/constructs/v1beta2/academy/Academy.d.ts +65 -65
- package/dist/constructs/v1beta2/academy/AcademySchema.js +1 -1
- package/dist/constructs/v1beta2/academy/AcademySchema.mjs +1 -1
- package/dist/constructs/v1beta2/badge/BadgeSchema.js +1 -1
- package/dist/constructs/v1beta2/badge/BadgeSchema.mjs +1 -1
- package/dist/constructs/v1beta2/role/Role.d.ts +1 -1
- package/dist/constructs/v1beta2/role/RoleSchema.js +1 -1
- package/dist/constructs/v1beta2/role/RoleSchema.mjs +1 -1
- package/dist/constructs/v1beta2/user/User.d.ts +8 -8
- package/dist/constructs/v1beta2/user/UserSchema.js +1 -1
- package/dist/constructs/v1beta2/user/UserSchema.mjs +1 -1
- package/dist/constructs/v1beta3/academy/Academy.d.ts +65 -65
- 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 +8 -8
- package/dist/constructs/v1beta3/design/DesignSchema.js +8 -8
- package/dist/constructs/v1beta3/design/DesignSchema.mjs +8 -8
- package/dist/index.d.mts +41 -41
- package/dist/index.d.ts +41 -41
- package/dist/mesheryApi.d.mts +4 -4
- package/dist/mesheryApi.d.ts +4 -4
- package/dist/permissions.d.mts +1 -1
- package/dist/permissions.d.ts +1 -1
- package/package.json +1 -1
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
var e={openapi:"3.0.0",info:{title:"role",description:"Documentation for Meshery Cloud REST APIs for Roles",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"},version:"v1beta2"},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"}],security:[{jwt:[]}],tags:[{name:"roles",description:"Operations related to roles and role assignments"}],paths:{"/api/identity/roles":{post:{"x-internal":["cloud"],tags:["roles"],summary:"Add role holder",operationId:"addRoleHolder",description:"Assigns a role to a user identified by email.",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Request body for assigning a role to a user.",required:["email","roleNames"],properties:{email:{type:"string",format:"email",description:"Email of the user to assign roles to.","x-order":1,maxLength:500},roleNames:{type:"array",items:{type:"string",maxLength:500},description:"List of role names to assign.","x-order":2}}}}}},responses:{201:{description:"Role holder added"},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/identity/roles/{roleId}":{delete:{"x-internal":["cloud"],tags:["roles"],summary:"Delete role",operationId:"deleteRole",description:"Removes a role assignment by ID.",parameters:[{name:"roleId",in:"path",description:"Role 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:"Role 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/identity/orgs/{orgId}/roles":{get:{"x-internal":["cloud"],tags:["roles"],summary:"Get organization roles",operationId:"getAllRoles",description:"Returns all roles defined for the specified organization.",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:"Get responses by page size",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"}},{name:"all",in:"query",description:"Get all possible entries",schema:{type:"boolean"}},{name:"selector",in:"query",description:"Role grouping selector such as provider, organization, or team.",schema:{type:"string",maxLength:100}},{name:"teamId",in:"query",description:"Team ID used when selector is team.",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:"Roles response",content:{"application/json":{schema:{type:"object",description:"A paginated list of roles.",required:["page","pageSize","totalCount","roles"],properties:{page:{type:"integer",description:"Current page number (zero-based).","x-order":1,minimum:0},pageSize:{type:"integer",description:"Number of roles per page.","x-order":2,minimum:1},totalCount:{type:"integer",description:"Total number of roles across all pages.","x-order":3,minimum:0},roles:{type:"array",items:{"x-go-type":"Role",type:"object",description:"Role definition for Layer5 Cloud (Meshery).",required:["roleName","description"],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-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id"}},roleName:{type:"string",description:"Unique name of the role.","x-order":2,"x-oapi-codegen-extra-tags":{db:"role_name",json:"roleName"},maxLength:500},description:{type:"string",description:"Human-readable description of the role.","x-order":3,"x-oapi-codegen-extra-tags":{db:"description"},maxLength:5e3},createdAt:{description:"Timestamp when the role was created.","x-order":4,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the role was last updated.","x-order":5,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{description:"Timestamp when the role was soft-deleted, if applicable.","x-order":6,"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt"},"x-go-type":"NullTime",type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},"x-order":4,description:"The roles of the rolespage."}}}}}},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"}}}}}},post:{"x-internal":["cloud"],tags:["roles"],summary:"Upsert organization role",operationId:"upsertRole",description:"Creates or updates a role for the specified organization.",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"}}}],requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for upserting a role. Includes only client-settable fields.",required:["roleName","description"],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":{json:"id,omitempty"}},roleName:{type:"string",description:"Unique name of the role.","x-oapi-codegen-extra-tags":{json:"roleName"},maxLength:500},description:{type:"string",description:"Human-readable description of the role.",maxLength:5e3}}}}}},responses:{200:{description:"Role upserted",content:{"application/json":{schema:{type:"object",description:"Role definition for Layer5 Cloud (Meshery).",required:["roleName","description"],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-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id"}},roleName:{type:"string",description:"Unique name of the role.","x-order":2,"x-oapi-codegen-extra-tags":{db:"role_name",json:"roleName"},maxLength:500},description:{type:"string",description:"Human-readable description of the role.","x-order":3,"x-oapi-codegen-extra-tags":{db:"description"},maxLength:5e3},createdAt:{description:"Timestamp when the role was created.","x-order":4,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the role was last updated.","x-order":5,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{description:"Timestamp when the role was soft-deleted, if applicable.","x-order":6,"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt"},"x-go-type":"NullTime",type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},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:["roles"],summary:"Bulk edit role holders",operationId:"bulkEditRoleHolder",description:"Updates role assignments for multiple users in the organization.",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"}}}],requestBody:{required:true,content:{"application/json":{schema:{type:"array",items:{type:"object",description:"Request to update role assignments for a user.",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-go-name":"ID"},userId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":2,"x-oapi-codegen-extra-tags":{json:"userId"}},username:{type:"string","x-order":3,description:"The username of the user.",maxLength:500},email:{type:"string",format:"email","x-order":4,description:"Email address of the user.",maxLength:500},firstName:{type:"string","x-order":5,description:"First name of the user.",maxLength:500},lastName:{type:"string","x-order":6,description:"Last name of the user.",maxLength:500},status:{type:"string","x-order":7,description:"Current status of the user.",maxLength:255},roleNames:{type:"array",items:{type:"string",maxLength:500},"x-order":8,description:"Role names currently or newly assigned to the user."},createdAt:{description:"Timestamp when the user was created.","x-order":9,"x-oapi-codegen-extra-tags":{json:"createdAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the user was last updated.","x-order":10,"x-oapi-codegen-extra-tags":{json:"updatedAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{description:"Timestamp when the user was soft-deleted, if applicable.","x-order":11,"x-oapi-codegen-extra-tags":{json:"deletedAt"},"x-go-type":"NullTime",type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}}},responses:{200:{description:"Role holders updated"},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/identity/orgs/{orgId}/roles/{roleId}/keychains":{get:{"x-internal":["cloud"],tags:["roles"],summary:"Get keychains for role",operationId:"getRoleKeychains",description:"Returns all keychains assigned to the specified role.",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:"roleId",in:"path",description:"Role 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 page size",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:"Keychains response",content:{"application/json":{schema:{"x-go-type":"keychainv1beta1.KeychainPage","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/keychain",name:"keychainv1beta1"},type:"object",required:["page","page_size","total_count","keychains"],properties:{page:{"x-order":1,type:"integer","x-go-type-skip-optional-pointer":true},page_size:{"x-order":2,type:"integer","x-go-type-skip-optional-pointer":true},total_count:{"x-order":3,type:"integer","x-go-type-skip-optional-pointer":true},keychains:{type:"array",items:{type:"object",additionalProperties:false,description:"Represents a collection of keys.",required:["id","name","owner","created_at","updated_at"],properties:{id:{description:"Unique identifier for the keychain.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"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"},"x-order":2},owner:{description:"Owner of the keychain.","x-oapi-codegen-extra-tags":{db:"owner"},"x-order":3,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},created_at:{"x-order":4,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":5,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":6,description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},"x-order":4,description:"The keychains of the keychainpage."}}}}}},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/identity/orgs/{orgId}/roles/{roleId}/keychains/{keychainId}":{post:{"x-internal":["cloud"],tags:["roles"],summary:"Assign keychain to role",operationId:"assignKeychainToRole",description:"Associates a keychain with the specified role.",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:"roleId",in:"path",description:"Role 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:"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 assigned to role"},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:["roles"],summary:"Unassign keychain from role",operationId:"unassignKeychainFromRole",description:"Removes the association between a keychain and a role.",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:"roleId",in:"path",description:"Role 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:"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 unassigned from role"},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:{securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},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"}}},roleId:{name:"roleId",in:"path",description:"Role 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 page size",schema:{type:"string"}},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"}},all:{name:"all",in:"query",description:"Get all possible entries",schema:{type:"boolean"}},selector:{name:"selector",in:"query",description:"Role grouping selector such as provider, organization, or team.",schema:{type:"string",maxLength:100}},teamIdQuery:{name:"teamId",in:"query",description:"Team ID used when selector is team.",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"}}}},schemas:{Role:{type:"object",description:"Role definition for Layer5 Cloud (Meshery).",required:["roleName","description"],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-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id"}},roleName:{type:"string",description:"Unique name of the role.","x-order":2,"x-oapi-codegen-extra-tags":{db:"role_name",json:"roleName"},maxLength:500},description:{type:"string",description:"Human-readable description of the role.","x-order":3,"x-oapi-codegen-extra-tags":{db:"description"},maxLength:5e3},createdAt:{description:"Timestamp when the role was created.","x-order":4,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the role was last updated.","x-order":5,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{description:"Timestamp when the role was soft-deleted, if applicable.","x-order":6,"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt"},"x-go-type":"NullTime",type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},RolePayload:{type:"object",description:"Payload for upserting a role. Includes only client-settable fields.",required:["roleName","description"],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":{json:"id,omitempty"}},roleName:{type:"string",description:"Unique name of the role.","x-oapi-codegen-extra-tags":{json:"roleName"},maxLength:500},description:{type:"string",description:"Human-readable description of the role.",maxLength:5e3}}},RolesPage:{type:"object",description:"A paginated list of roles.",required:["page","pageSize","totalCount","roles"],properties:{page:{type:"integer",description:"Current page number (zero-based).","x-order":1,minimum:0},pageSize:{type:"integer",description:"Number of roles per page.","x-order":2,minimum:1},totalCount:{type:"integer",description:"Total number of roles across all pages.","x-order":3,minimum:0},roles:{type:"array",items:{"x-go-type":"Role",type:"object",description:"Role definition for Layer5 Cloud (Meshery).",required:["roleName","description"],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-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id"}},roleName:{type:"string",description:"Unique name of the role.","x-order":2,"x-oapi-codegen-extra-tags":{db:"role_name",json:"roleName"},maxLength:500},description:{type:"string",description:"Human-readable description of the role.","x-order":3,"x-oapi-codegen-extra-tags":{db:"description"},maxLength:5e3},createdAt:{description:"Timestamp when the role was created.","x-order":4,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the role was last updated.","x-order":5,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{description:"Timestamp when the role was soft-deleted, if applicable.","x-order":6,"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt"},"x-go-type":"NullTime",type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},"x-order":4,description:"The roles of the rolespage."}}},RolesKeychainsMapping:{type:"object",description:"Mapping between a role and a keychain.",required:["id","keychainId","roleId","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-order":1,"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id"}},keychainId:{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":2,"x-oapi-codegen-extra-tags":{db:"keychain_id",json:"keychainId"}},roleId:{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":3,"x-oapi-codegen-extra-tags":{db:"role_id",json:"roleId"}},createdAt:{description:"Timestamp when the mapping was created.","x-order":4,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the mapping was last updated.","x-order":5,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{description:"Timestamp when the mapping was soft-deleted, if applicable.","x-order":6,"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt"},"x-go-type":"NullTime",type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},RoleHolderRequest:{type:"object",description:"Request body for assigning a role to a user.",required:["email","roleNames"],properties:{email:{type:"string",format:"email",description:"Email of the user to assign roles to.","x-order":1,maxLength:500},roleNames:{type:"array",items:{type:"string",maxLength:500},description:"List of role names to assign.","x-order":2}}},UserRoleUpdateRequest:{type:"object",description:"Request to update role assignments for a user.",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-go-name":"ID"},userId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":2,"x-oapi-codegen-extra-tags":{json:"userId"}},username:{type:"string","x-order":3,description:"The username of the user.",maxLength:500},email:{type:"string",format:"email","x-order":4,description:"Email address of the user.",maxLength:500},firstName:{type:"string","x-order":5,description:"First name of the user.",maxLength:500},lastName:{type:"string","x-order":6,description:"Last name of the user.",maxLength:500},status:{type:"string","x-order":7,description:"Current status of the user.",maxLength:255},roleNames:{type:"array",items:{type:"string",maxLength:500},"x-order":8,description:"Role names currently or newly assigned to the user."},createdAt:{description:"Timestamp when the user was created.","x-order":9,"x-oapi-codegen-extra-tags":{json:"createdAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the user was last updated.","x-order":10,"x-oapi-codegen-extra-tags":{json:"updatedAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{description:"Timestamp when the user was soft-deleted, if applicable.","x-order":11,"x-oapi-codegen-extra-tags":{json:"deletedAt"},"x-go-type":"NullTime",type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},Preference:{type:"object",description:"User notification preferences.",required:["welcomeEmail","notifyRoleChange"],properties:{welcomeEmail:{type:"boolean",description:"Whether to send a welcome email to new users.","x-order":1},notifyRoleChange:{type:"boolean",description:"Whether to notify the user of role changes.","x-order":2}}}}}},t=e;
|
|
1
|
+
var e={openapi:"3.0.0",info:{title:"role",description:"Documentation for Meshery Cloud REST APIs for Roles",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"},version:"v1beta2"},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"}],security:[{jwt:[]}],tags:[{name:"roles",description:"Operations related to roles and role assignments"}],paths:{"/api/identity/roles":{post:{"x-internal":["cloud"],tags:["roles"],summary:"Add role holder",operationId:"addRoleHolder",description:"Assigns a role to a user identified by email.",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Request body for assigning a role to a user.",required:["email","roleNames"],properties:{email:{type:"string",format:"email",description:"Email of the user to assign roles to.","x-order":1,maxLength:500},roleNames:{type:"array",items:{type:"string",maxLength:500},description:"List of role names to assign.","x-order":2}}}}}},responses:{201:{description:"Role holder added"},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/identity/roles/{roleId}":{delete:{"x-internal":["cloud"],tags:["roles"],summary:"Delete role",operationId:"deleteRole",description:"Removes a role assignment by ID.",parameters:[{name:"roleId",in:"path",description:"Role 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:"Role 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/identity/orgs/{orgId}/roles":{get:{"x-internal":["cloud"],tags:["roles"],summary:"Get organization roles",operationId:"getAllRoles",description:"Returns all roles defined for the specified organization.",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:"Get responses by page size",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"}},{name:"all",in:"query",description:"Get all possible entries",schema:{type:"boolean"}},{name:"selector",in:"query",description:"Role grouping selector such as provider, organization, or team.",schema:{type:"string",maxLength:100}},{name:"teamId",in:"query",description:"Team ID used when selector is team.",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:"Roles response",content:{"application/json":{schema:{type:"object",description:"A paginated list of roles.",required:["page","pageSize","totalCount","roles"],properties:{page:{type:"integer",description:"Current page number (zero-based).","x-order":1,minimum:0},pageSize:{type:"integer",description:"Number of roles per page.","x-order":2,minimum:1},totalCount:{type:"integer",description:"Total number of roles across all pages.","x-order":3,minimum:0},roles:{type:"array",items:{"x-go-type":"Role",type:"object",description:"Role definition",required:["roleName","description"],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-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id"}},roleName:{type:"string",description:"Unique name of the role.","x-order":2,"x-oapi-codegen-extra-tags":{db:"role_name",json:"roleName"},maxLength:500},description:{type:"string",description:"Human-readable description of the role.","x-order":3,"x-oapi-codegen-extra-tags":{db:"description"},maxLength:5e3},createdAt:{description:"Timestamp when the role was created.","x-order":4,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the role was last updated.","x-order":5,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{description:"Timestamp when the role was soft-deleted, if applicable.","x-order":6,"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt"},"x-go-type":"NullTime",type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},"x-order":4,description:"The roles of the rolespage."}}}}}},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"}}}}}},post:{"x-internal":["cloud"],tags:["roles"],summary:"Upsert organization role",operationId:"upsertRole",description:"Creates or updates a role for the specified organization.",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"}}}],requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for upserting a role. Includes only client-settable fields.",required:["roleName","description"],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":{json:"id,omitempty"}},roleName:{type:"string",description:"Unique name of the role.","x-oapi-codegen-extra-tags":{json:"roleName"},maxLength:500},description:{type:"string",description:"Human-readable description of the role.",maxLength:5e3}}}}}},responses:{200:{description:"Role upserted",content:{"application/json":{schema:{type:"object",description:"Role definition",required:["roleName","description"],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-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id"}},roleName:{type:"string",description:"Unique name of the role.","x-order":2,"x-oapi-codegen-extra-tags":{db:"role_name",json:"roleName"},maxLength:500},description:{type:"string",description:"Human-readable description of the role.","x-order":3,"x-oapi-codegen-extra-tags":{db:"description"},maxLength:5e3},createdAt:{description:"Timestamp when the role was created.","x-order":4,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the role was last updated.","x-order":5,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{description:"Timestamp when the role was soft-deleted, if applicable.","x-order":6,"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt"},"x-go-type":"NullTime",type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},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:["roles"],summary:"Bulk edit role holders",operationId:"bulkEditRoleHolder",description:"Updates role assignments for multiple users in the organization.",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"}}}],requestBody:{required:true,content:{"application/json":{schema:{type:"array",items:{type:"object",description:"Request to update role assignments for a user.",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-go-name":"ID"},userId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":2,"x-oapi-codegen-extra-tags":{json:"userId"}},username:{type:"string","x-order":3,description:"The username of the user.",maxLength:500},email:{type:"string",format:"email","x-order":4,description:"Email address of the user.",maxLength:500},firstName:{type:"string","x-order":5,description:"First name of the user.",maxLength:500},lastName:{type:"string","x-order":6,description:"Last name of the user.",maxLength:500},status:{type:"string","x-order":7,description:"Current status of the user.",maxLength:255},roleNames:{type:"array",items:{type:"string",maxLength:500},"x-order":8,description:"Role names currently or newly assigned to the user."},createdAt:{description:"Timestamp when the user was created.","x-order":9,"x-oapi-codegen-extra-tags":{json:"createdAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the user was last updated.","x-order":10,"x-oapi-codegen-extra-tags":{json:"updatedAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{description:"Timestamp when the user was soft-deleted, if applicable.","x-order":11,"x-oapi-codegen-extra-tags":{json:"deletedAt"},"x-go-type":"NullTime",type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}}},responses:{200:{description:"Role holders updated"},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/identity/orgs/{orgId}/roles/{roleId}/keychains":{get:{"x-internal":["cloud"],tags:["roles"],summary:"Get keychains for role",operationId:"getRoleKeychains",description:"Returns all keychains assigned to the specified role.",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:"roleId",in:"path",description:"Role 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 page size",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:"Keychains response",content:{"application/json":{schema:{"x-go-type":"keychainv1beta1.KeychainPage","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/keychain",name:"keychainv1beta1"},type:"object",required:["page","page_size","total_count","keychains"],properties:{page:{"x-order":1,type:"integer","x-go-type-skip-optional-pointer":true},page_size:{"x-order":2,type:"integer","x-go-type-skip-optional-pointer":true},total_count:{"x-order":3,type:"integer","x-go-type-skip-optional-pointer":true},keychains:{type:"array",items:{type:"object",additionalProperties:false,description:"Represents a collection of keys.",required:["id","name","owner","created_at","updated_at"],properties:{id:{description:"Unique identifier for the keychain.","x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"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"},"x-order":2},owner:{description:"Owner of the keychain.","x-oapi-codegen-extra-tags":{db:"owner"},"x-order":3,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},created_at:{"x-order":4,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":5,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true},deleted_at:{"x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":6,description:"SQL null Timestamp to handle null values of time.","x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},"x-order":4,description:"The keychains of the keychainpage."}}}}}},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/identity/orgs/{orgId}/roles/{roleId}/keychains/{keychainId}":{post:{"x-internal":["cloud"],tags:["roles"],summary:"Assign keychain to role",operationId:"assignKeychainToRole",description:"Associates a keychain with the specified role.",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:"roleId",in:"path",description:"Role 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:"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 assigned to role"},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:["roles"],summary:"Unassign keychain from role",operationId:"unassignKeychainFromRole",description:"Removes the association between a keychain and a role.",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:"roleId",in:"path",description:"Role 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:"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 unassigned from role"},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:{securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},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"}}},roleId:{name:"roleId",in:"path",description:"Role 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 page size",schema:{type:"string"}},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"}},all:{name:"all",in:"query",description:"Get all possible entries",schema:{type:"boolean"}},selector:{name:"selector",in:"query",description:"Role grouping selector such as provider, organization, or team.",schema:{type:"string",maxLength:100}},teamIdQuery:{name:"teamId",in:"query",description:"Team ID used when selector is team.",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"}}}},schemas:{Role:{type:"object",description:"Role definition",required:["roleName","description"],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-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id"}},roleName:{type:"string",description:"Unique name of the role.","x-order":2,"x-oapi-codegen-extra-tags":{db:"role_name",json:"roleName"},maxLength:500},description:{type:"string",description:"Human-readable description of the role.","x-order":3,"x-oapi-codegen-extra-tags":{db:"description"},maxLength:5e3},createdAt:{description:"Timestamp when the role was created.","x-order":4,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the role was last updated.","x-order":5,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{description:"Timestamp when the role was soft-deleted, if applicable.","x-order":6,"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt"},"x-go-type":"NullTime",type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},RolePayload:{type:"object",description:"Payload for upserting a role. Includes only client-settable fields.",required:["roleName","description"],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":{json:"id,omitempty"}},roleName:{type:"string",description:"Unique name of the role.","x-oapi-codegen-extra-tags":{json:"roleName"},maxLength:500},description:{type:"string",description:"Human-readable description of the role.",maxLength:5e3}}},RolesPage:{type:"object",description:"A paginated list of roles.",required:["page","pageSize","totalCount","roles"],properties:{page:{type:"integer",description:"Current page number (zero-based).","x-order":1,minimum:0},pageSize:{type:"integer",description:"Number of roles per page.","x-order":2,minimum:1},totalCount:{type:"integer",description:"Total number of roles across all pages.","x-order":3,minimum:0},roles:{type:"array",items:{"x-go-type":"Role",type:"object",description:"Role definition",required:["roleName","description"],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-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id"}},roleName:{type:"string",description:"Unique name of the role.","x-order":2,"x-oapi-codegen-extra-tags":{db:"role_name",json:"roleName"},maxLength:500},description:{type:"string",description:"Human-readable description of the role.","x-order":3,"x-oapi-codegen-extra-tags":{db:"description"},maxLength:5e3},createdAt:{description:"Timestamp when the role was created.","x-order":4,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the role was last updated.","x-order":5,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{description:"Timestamp when the role was soft-deleted, if applicable.","x-order":6,"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt"},"x-go-type":"NullTime",type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},"x-order":4,description:"The roles of the rolespage."}}},RolesKeychainsMapping:{type:"object",description:"Mapping between a role and a keychain.",required:["id","keychainId","roleId","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-order":1,"x-go-name":"ID","x-oapi-codegen-extra-tags":{db:"id"}},keychainId:{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":2,"x-oapi-codegen-extra-tags":{db:"keychain_id",json:"keychainId"}},roleId:{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":3,"x-oapi-codegen-extra-tags":{db:"role_id",json:"roleId"}},createdAt:{description:"Timestamp when the mapping was created.","x-order":4,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the mapping was last updated.","x-order":5,"x-oapi-codegen-extra-tags":{db:"updated_at",json:"updatedAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{description:"Timestamp when the mapping was soft-deleted, if applicable.","x-order":6,"x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt"},"x-go-type":"NullTime",type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},RoleHolderRequest:{type:"object",description:"Request body for assigning a role to a user.",required:["email","roleNames"],properties:{email:{type:"string",format:"email",description:"Email of the user to assign roles to.","x-order":1,maxLength:500},roleNames:{type:"array",items:{type:"string",maxLength:500},description:"List of role names to assign.","x-order":2}}},UserRoleUpdateRequest:{type:"object",description:"Request to update role assignments for a user.",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-go-name":"ID"},userId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":2,"x-oapi-codegen-extra-tags":{json:"userId"}},username:{type:"string","x-order":3,description:"The username of the user.",maxLength:500},email:{type:"string",format:"email","x-order":4,description:"Email address of the user.",maxLength:500},firstName:{type:"string","x-order":5,description:"First name of the user.",maxLength:500},lastName:{type:"string","x-order":6,description:"Last name of the user.",maxLength:500},status:{type:"string","x-order":7,description:"Current status of the user.",maxLength:255},roleNames:{type:"array",items:{type:"string",maxLength:500},"x-order":8,description:"Role names currently or newly assigned to the user."},createdAt:{description:"Timestamp when the user was created.","x-order":9,"x-oapi-codegen-extra-tags":{json:"createdAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the user was last updated.","x-order":10,"x-oapi-codegen-extra-tags":{json:"updatedAt"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{description:"Timestamp when the user was soft-deleted, if applicable.","x-order":11,"x-oapi-codegen-extra-tags":{json:"deletedAt"},"x-go-type":"NullTime",type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},Preference:{type:"object",description:"User notification preferences.",required:["welcomeEmail","notifyRoleChange"],properties:{welcomeEmail:{type:"boolean",description:"Whether to send a welcome email to new users.","x-order":1},notifyRoleChange:{type:"boolean",description:"Whether to notify the user of role changes.","x-order":2}}}}}},t=e;
|
|
2
2
|
export{t as default};
|
|
@@ -22,7 +22,7 @@ export interface paths {
|
|
|
22
22
|
|
|
23
23
|
export interface components {
|
|
24
24
|
schemas: {
|
|
25
|
-
/** @description Represents a user
|
|
25
|
+
/** @description Represents a user */
|
|
26
26
|
User: {
|
|
27
27
|
/**
|
|
28
28
|
* Format: uuid
|
|
@@ -32,7 +32,7 @@ export interface components {
|
|
|
32
32
|
/** @description User identifier (username or external ID) */
|
|
33
33
|
userId: string;
|
|
34
34
|
/**
|
|
35
|
-
* @description Authentication provider (e.g.,
|
|
35
|
+
* @description Authentication provider (e.g., Google, Github)
|
|
36
36
|
* @example [
|
|
37
37
|
* "local",
|
|
38
38
|
* "github",
|
|
@@ -224,7 +224,7 @@ export interface components {
|
|
|
224
224
|
/** @description User identifier (username or external ID) */
|
|
225
225
|
userId: string;
|
|
226
226
|
/**
|
|
227
|
-
* @description Authentication provider (e.g.,
|
|
227
|
+
* @description Authentication provider (e.g., Google, Github)
|
|
228
228
|
* @example [
|
|
229
229
|
* "local",
|
|
230
230
|
* "github",
|
|
@@ -417,7 +417,7 @@ export interface components {
|
|
|
417
417
|
/** @description User identifier (username or external ID) */
|
|
418
418
|
userId: string;
|
|
419
419
|
/**
|
|
420
|
-
* @description Authentication provider (e.g.,
|
|
420
|
+
* @description Authentication provider (e.g., Google, Github)
|
|
421
421
|
* @example [
|
|
422
422
|
* "local",
|
|
423
423
|
* "github",
|
|
@@ -809,7 +809,7 @@ export interface operations {
|
|
|
809
809
|
/** @description User identifier (username or external ID) */
|
|
810
810
|
userId: string;
|
|
811
811
|
/**
|
|
812
|
-
* @description Authentication provider (e.g.,
|
|
812
|
+
* @description Authentication provider (e.g., Google, Github)
|
|
813
813
|
* @example [
|
|
814
814
|
* "local",
|
|
815
815
|
* "github",
|
|
@@ -1049,7 +1049,7 @@ export interface operations {
|
|
|
1049
1049
|
/** @description User identifier (username or external ID) */
|
|
1050
1050
|
userId: string;
|
|
1051
1051
|
/**
|
|
1052
|
-
* @description Authentication provider (e.g.,
|
|
1052
|
+
* @description Authentication provider (e.g., Google, Github)
|
|
1053
1053
|
* @example [
|
|
1054
1054
|
* "local",
|
|
1055
1055
|
* "github",
|
|
@@ -1266,7 +1266,7 @@ export interface operations {
|
|
|
1266
1266
|
/** @description User identifier (username or external ID) */
|
|
1267
1267
|
userId: string;
|
|
1268
1268
|
/**
|
|
1269
|
-
* @description Authentication provider (e.g.,
|
|
1269
|
+
* @description Authentication provider (e.g., Google, Github)
|
|
1270
1270
|
* @example [
|
|
1271
1271
|
* "local",
|
|
1272
1272
|
* "github",
|
|
@@ -1482,7 +1482,7 @@ export interface operations {
|
|
|
1482
1482
|
/** @description User identifier (username or external ID) */
|
|
1483
1483
|
userId: string;
|
|
1484
1484
|
/**
|
|
1485
|
-
* @description Authentication provider (e.g.,
|
|
1485
|
+
* @description Authentication provider (e.g., Google, Github)
|
|
1486
1486
|
* @example [
|
|
1487
1487
|
* "local",
|
|
1488
1488
|
* "github",
|