@meshery/schemas 1.3.29 → 1.3.31
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 +4334 -3675
- package/dist/cloudApi.d.ts +4334 -3675
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta2/academy/AcademySchema.js +1 -1
- package/dist/constructs/v1beta2/academy/AcademySchema.mjs +1 -1
- package/dist/constructs/v1beta2/connection/Connection.d.ts +6 -6
- package/dist/constructs/v1beta2/connection/ConnectionSchema.js +1 -1
- package/dist/constructs/v1beta2/connection/ConnectionSchema.mjs +1 -1
- package/dist/constructs/v1beta2/core/Core.d.ts +1 -1
- package/dist/constructs/v1beta2/core/CoreSchema.js +1 -1
- package/dist/constructs/v1beta2/core/CoreSchema.mjs +1 -1
- package/dist/constructs/v1beta2/credential/Credential.d.ts +2 -2
- package/dist/constructs/v1beta2/credential/CredentialSchema.js +2 -2
- package/dist/constructs/v1beta2/credential/CredentialSchema.mjs +2 -2
- package/dist/constructs/v1beta2/design/DesignSchema.js +5 -5
- package/dist/constructs/v1beta2/design/DesignSchema.mjs +5 -5
- package/dist/constructs/v1beta2/event/EventSchema.js +1 -1
- package/dist/constructs/v1beta2/event/EventSchema.mjs +1 -1
- package/dist/constructs/v1beta2/invitation/InvitationSchema.js +1 -1
- package/dist/constructs/v1beta2/invitation/InvitationSchema.mjs +1 -1
- package/dist/constructs/v1beta2/key/Key.d.ts +3 -3
- package/dist/constructs/v1beta2/key/KeySchema.js +1 -1
- package/dist/constructs/v1beta2/key/KeySchema.mjs +1 -1
- package/dist/constructs/v1beta2/keychain/Keychain.d.ts +3 -3
- package/dist/constructs/v1beta2/keychain/KeychainSchema.js +1 -1
- package/dist/constructs/v1beta2/keychain/KeychainSchema.mjs +1 -1
- package/dist/constructs/v1beta2/plan/PlanSchema.js +1 -1
- package/dist/constructs/v1beta2/plan/PlanSchema.mjs +1 -1
- package/dist/constructs/v1beta2/role/Role.d.ts +3 -3
- package/dist/constructs/v1beta2/role/RoleSchema.js +1 -1
- package/dist/constructs/v1beta2/role/RoleSchema.mjs +1 -1
- package/dist/constructs/v1beta2/schedule/Schedule.d.ts +2 -2
- package/dist/constructs/v1beta2/schedule/ScheduleSchema.js +2 -2
- package/dist/constructs/v1beta2/schedule/ScheduleSchema.mjs +2 -2
- package/dist/constructs/v1beta2/subscription/SubscriptionSchema.js +1 -1
- package/dist/constructs/v1beta2/subscription/SubscriptionSchema.mjs +1 -1
- package/dist/constructs/v1beta2/team/Team.d.ts +4 -4
- package/dist/constructs/v1beta2/team/TeamSchema.js +1 -1
- package/dist/constructs/v1beta2/team/TeamSchema.mjs +1 -1
- package/dist/constructs/v1beta2/token/TokenSchema.js +1 -1
- package/dist/constructs/v1beta2/token/TokenSchema.mjs +1 -1
- package/dist/constructs/v1beta2/user/User.d.ts +6 -350
- package/dist/constructs/v1beta2/user/UserSchema.js +1 -1
- package/dist/constructs/v1beta2/user/UserSchema.mjs +1 -1
- package/dist/constructs/v1beta2/view/View.d.ts +2 -2
- package/dist/constructs/v1beta2/view/ViewSchema.js +2 -2
- package/dist/constructs/v1beta2/view/ViewSchema.mjs +2 -2
- package/dist/constructs/v1beta3/academy/AcademySchema.js +1 -1
- package/dist/constructs/v1beta3/academy/AcademySchema.mjs +1 -1
- package/dist/constructs/v1beta3/connection/Connection.d.ts +7 -7
- package/dist/constructs/v1beta3/connection/ConnectionSchema.js +1 -1
- package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +1 -1
- package/dist/constructs/v1beta3/design/DesignSchema.js +5 -5
- package/dist/constructs/v1beta3/design/DesignSchema.mjs +5 -5
- package/dist/constructs/v1beta3/environment/Environment.d.ts +3 -3
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.js +1 -1
- package/dist/constructs/v1beta3/environment/EnvironmentSchema.mjs +1 -1
- package/dist/constructs/v1beta3/event/EventSchema.js +1 -1
- package/dist/constructs/v1beta3/event/EventSchema.mjs +1 -1
- package/dist/constructs/v1beta3/filter/FilterSchema.js +2 -2
- package/dist/constructs/v1beta3/filter/FilterSchema.mjs +2 -2
- package/dist/constructs/v1beta3/invitation/InvitationSchema.js +1 -1
- package/dist/constructs/v1beta3/invitation/InvitationSchema.mjs +1 -1
- package/dist/constructs/v1beta3/pattern_resource/PatternResourceSchema.js +2 -2
- package/dist/constructs/v1beta3/pattern_resource/PatternResourceSchema.mjs +2 -2
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +4 -4
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.js +1 -1
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.mjs +1 -1
- package/dist/constructs/v1beta3/plan/PlanSchema.js +1 -1
- package/dist/constructs/v1beta3/plan/PlanSchema.mjs +1 -1
- package/dist/constructs/v1beta3/subscription/SubscriptionSchema.js +1 -1
- package/dist/constructs/v1beta3/subscription/SubscriptionSchema.mjs +1 -1
- package/dist/constructs/v1beta3/token/TokenSchema.js +1 -1
- package/dist/constructs/v1beta3/token/TokenSchema.mjs +1 -1
- package/dist/constructs/v1beta3/user/User.d.ts +536 -5
- package/dist/constructs/v1beta3/user/UserSchema.js +1 -1
- package/dist/constructs/v1beta3/user/UserSchema.mjs +1 -1
- package/dist/constructs/v1beta3/workspace/Workspace.d.ts +6 -6
- package/dist/constructs/v1beta3/workspace/WorkspaceSchema.js +2 -2
- package/dist/constructs/v1beta3/workspace/WorkspaceSchema.mjs +2 -2
- package/dist/index.d.mts +781 -75
- package/dist/index.d.ts +781 -75
- package/dist/index.js +7 -7
- package/dist/index.mjs +7 -7
- package/dist/mesheryApi.d.mts +3588 -3341
- package/dist/mesheryApi.d.ts +3588 -3341
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/package.json +1 -1
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
'use strict';var e={openapi:"3.0.0",info:{title:"Events",description:"OpenAPI schema for Meshery events and system notifications.",version:"v1beta3",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},tags:[{name:"events",description:"APIs for Meshery Cloud events."}],paths:{"/events/{eventId}":{delete:{"x-internal":["cloud","meshery"],tags:["events"],operationId:"deleteEvent",summary:"Delete a single event",parameters:[{name:"eventId",in:"path",description:"ID of the event.",required:true,schema:{type:"string",format:"uuid"}}],responses:{204:{description:"Event 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"}}}}}}},"/events":{post:{"x-internal":["cloud","meshery"],tags:["events"],operationId:"createEvent",summary:"Create a new event",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for creating a new event.",additionalProperties:true,properties:{owner:{type:"string",format:"uuid",description:"UUID of the user associated with the event.","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,omitempty"}},category:{type:"string",description:"The category of the event.",maxLength:500},action:{type:"string",description:"The action of the event.",maxLength:500},description:{type:"string",description:"Description of the event.",maxLength:5e3}}}}}},responses:{201:{description:"Event created"},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"}}}}}}},"/events/delete":{post:{"x-internal":["cloud","meshery"],tags:["events"],operationId:"bulkDeleteEvents",summary:"Bulk delete events",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for bulk-deleting events by ID.",required:["ids"],properties:{ids:{type:"array",items:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},description:"UUIDs of the events to delete."}}}}}},responses:{200:{description:"Events deleted",content:{"application/json":{schema:{type:"object",description:"Response body returned after bulk event deletion.",properties:{deleted:{type:"array",items:{type:"string",format:"uuid"},description:"UUIDs of events that were 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"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/events/status":{put:{"x-internal":["cloud","meshery"],tags:["events"],operationId:"bulkUpdateEventStatus",summary:"Bulk update event status",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for bulk-updating the status of events.",required:["ids","status"],properties:{ids:{type:"array",items:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},description:"UUIDs of the events to update."},status:{type:"string",example:"failed",description:"New status to apply to the selected events.",maxLength:255}}}}}},responses:{200:{description:"Events updated",content:{"application/json":{schema:{type:"object",description:"Response body returned after bulk event status update.",properties:{updated:{type:"array",items:{type:"string",format:"uuid"},description:"UUIDs of events whose status was 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"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/events/{eventId}/status":{put:{"x-internal":["cloud","meshery"],tags:["events"],operationId:"updateEventStatus",summary:"Update status of a single event",parameters:[{name:"eventId",in:"path",description:"ID of the event.",required:true,schema:{type:"string",format:"uuid"}}],requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for updating the status of a single event.",required:["status"],properties:{status:{type:"string",example:"completed",description:"Current status of the event.",maxLength:255}}}}}},responses:{200:{description:"Event status updated",content:{"application/json":{schema:{type:"object",description:"Response body returned after updating an event's status.",properties:{message:{type:"string",description:"Human-readable status message.",maxLength:500},eventId:{type:"string",format:"uuid",description:"UUID of the event whose status was updated.","x-oapi-codegen-extra-tags":{json:"eventId,omitempty"}},status:{type:"string",description:"Updated status of the event.",maxLength:255}}}}}},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/workspaces/{workspaceId}/events":{get:{"x-internal":["cloud"],tags:["events"],security:[{jwt:[]}],operationId:"getEventsOfWorkspace",summary:"Get workspace events",description:"Gets events for a workspace.",parameters:[{name:"workspaceId",in:"path",description:"Workspace ID",schema:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"workspace_id",json:"workspaceId"},"x-go-type-name":"WorkspaceId","x-go-type-skip-optional-pointer":true},required:true},{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer"}},{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:"integer"}},{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:"Workspace events",content:{"application/json":{schema:{type:"object",description:"Paginated list of events.",properties:{page:{description:"Zero-based page index returned in this response.",type:"integer","x-go-type-skip-optional-pointer":true},pageSize:{description:"Maximum number of items returned on each page.",minimum:1,"x-oapi-codegen-extra-tags":{json:"pageSize,omitempty"},type:"integer","x-go-type-skip-optional-pointer":true},totalCount:{description:"Total number of items across all pages.",minimum:0,"x-oapi-codegen-extra-tags":{json:"totalCount,omitempty"},type:"integer","x-go-type-skip-optional-pointer":true},data:{type:"array",items:{type:"object",additionalProperties:false,description:"EventResult entity schema.",properties:{owner:{type:"string",format:"uuid",description:"UUID of the user associated with the event.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"Owner","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"owner",json:"owner"}},systemId:{type:"string",description:"System identifier of the event source.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"system_id",json:"systemId"}},category:{type:"string",description:"The category of the event.",maxLength:500},action:{type:"string",description:"The action of the event.",maxLength:500},description:{type:"string",description:"Description of the event.",maxLength:5e3},firstName:{type:"string",description:"The first name of the user associated with the event.",maxLength:500},lastName:{type:"string",description:"The last name of the user associated with the event.",maxLength:500},email:{description:"Email address of the user associated with the event.",type:"string",format:"email","x-go-type-skip-optional-pointer":true},provider:{description:"Authentication provider of the user associated with the event.",type:"string","x-go-type-skip-optional-pointer":true},createdAt:{type:"string",format:"date-time",description:"Timestamp when the event was recorded.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"}}},required:["owner","category","action"]},description:"The events returned on the current page."}}}}}},400:{description:"Invalid request",content:{"application/json":{schema:{type:"object",description:"Generic error envelope returned for non-2xx responses.",properties:{error:{type:"string",description:"Human-readable error message.",maxLength:500}}}}}},401:{description:"Unauthorized"},404:{description:"Workspace not found"},500:{description:"Server error"}}}},"/api/events":{get:{"x-internal":["cloud"],tags:["events"],operationId:"getEventsAggregate",summary:"Get events aggregate summary",parameters:[{name:"cumulative",in:"query",description:"When true, return cumulative aggregate counts across all time.",required:false,schema:{type:"boolean"}}],responses:{200:{description:"Events aggregate",content:{"application/json":{schema:{type:"object",description:"Aggregated event counts across categories.",properties:{audit:{type:"integer",description:"Count of audit-category events.",minimum:0}},additionalProperties:true}}}},401:{description:"Unauthorized"},404:{description:"Not found"},500:{description:"Server error"}}}},"/api/events/list":{get:{"x-internal":["cloud"],tags:["events"],operationId:"getEvents",summary:"Get events list",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer"}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"integer"}},{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:"filter",in:"query",description:"Get filtered reponses",schema:{type:"string"}}],responses:{200:{description:"Events page",content:{"application/json":{schema:{type:"object",description:"Paginated list of events.",properties:{page:{description:"Zero-based page index returned in this response.",type:"integer","x-go-type-skip-optional-pointer":true},pageSize:{description:"Maximum number of items returned on each page.",minimum:1,"x-oapi-codegen-extra-tags":{json:"pageSize,omitempty"},type:"integer","x-go-type-skip-optional-pointer":true},totalCount:{description:"Total number of items across all pages.",minimum:0,"x-oapi-codegen-extra-tags":{json:"totalCount,omitempty"},type:"integer","x-go-type-skip-optional-pointer":true},data:{type:"array",items:{type:"object",additionalProperties:false,description:"EventResult entity schema.",properties:{owner:{type:"string",format:"uuid",description:"UUID of the user associated with the event.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"Owner","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"owner",json:"owner"}},systemId:{type:"string",description:"System identifier of the event source.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"system_id",json:"systemId"}},category:{type:"string",description:"The category of the event.",maxLength:500},action:{type:"string",description:"The action of the event.",maxLength:500},description:{type:"string",description:"Description of the event.",maxLength:5e3},firstName:{type:"string",description:"The first name of the user associated with the event.",maxLength:500},lastName:{type:"string",description:"The last name of the user associated with the event.",maxLength:500},email:{description:"Email address of the user associated with the event.",type:"string",format:"email","x-go-type-skip-optional-pointer":true},provider:{description:"Authentication provider of the user associated with the event.",type:"string","x-go-type-skip-optional-pointer":true},createdAt:{type:"string",format:"date-time",description:"Timestamp when the event was recorded.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"}}},required:["owner","category","action"]},description:"The events returned on the current page."}}}}}},401:{description:"Unauthorized"},404:{description:"Not found"},500:{description:"Server error"}}}},"/api/events/summary":{get:{"x-internal":["cloud"],tags:["events"],operationId:"getEventSummaryByUser",summary:"Get event summary by user",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer"}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"integer"}},{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:"filter",in:"query",description:"Get filtered reponses",schema:{type:"string"}}],responses:{200:{description:"Event summary page",content:{"application/json":{schema:{type:"object",description:"Paginated list of per-user event summaries.",properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1,"x-oapi-codegen-extra-tags":{json:"pageSize,omitempty"}},totalCount:{type:"integer",description:"Total number of items available.",minimum:0,"x-oapi-codegen-extra-tags":{json:"totalCount,omitempty"}},data:{type:"array",items:{type:"object",description:"Per-user event summary entry.",additionalProperties:true},description:"The event summaries returned on the current page."}}}}}},401:{description:"Unauthorized"},404:{description:"Not found"},500:{description:"Server error"}}}},"/api/events/types":{get:{"x-internal":["cloud"],tags:["events"],operationId:"getEventTypes",summary:"Get event types",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer"}},{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:"integer"}}],responses:{200:{description:"Event types",content:{"application/json":{schema:{type:"array",items:{type:"object",description:"A category/action pair describing one kind of event.",properties:{category:{type:"string",description:"The category of the event type.",maxLength:500},action:{type:"string",description:"The action of the event type.",maxLength:500}}}}}}},401:{description:"Unauthorized"},404:{description:"Not found"},500:{description:"Server error"}}}}},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:{eventId:{name:"eventId",in:"path",description:"ID of the event.",required:true,schema:{type:"string",format:"uuid"}},workspaceId:{name:"workspaceId",in:"path",description:"Workspace ID",schema:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"workspace_id",json:"workspaceId"},"x-go-type-name":"WorkspaceId","x-go-type-skip-optional-pointer":true},required:true},page:{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer"}},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",schema:{type:"integer"}},pagesizeLegacy:{name:"pagesize",in:"query",description:"Get responses by pagesize. Deprecated alias of pageSize.",deprecated:true,schema:{type:"integer"}},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"}},cumulative:{name:"cumulative",in:"query",description:"When true, return cumulative aggregate counts across all time.",required:false,schema:{type:"boolean"}},filter:{name:"filter",in:"query",description:"Get filtered reponses",schema:{type:"string"}},eventsFilter:{name:"filter",in:"query",description:"Get filtered reponses",schema:{type:"string"}}},securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},schemas:{EventPayload:{type:"object",description:"Payload for creating a new event.",additionalProperties:true,properties:{owner:{type:"string",format:"uuid",description:"UUID of the user associated with the event.","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,omitempty"}},category:{type:"string",description:"The category of the event.",maxLength:500},action:{type:"string",description:"The action of the event.",maxLength:500},description:{type:"string",description:"Description of the event.",maxLength:5e3}}},UpdateEventStatusRequest:{type:"object",description:"Payload for updating the status of a single event.",required:["status"],properties:{status:{type:"string",example:"completed",description:"Current status of the event.",maxLength:255}}},UpdateEventStatusResponse:{type:"object",description:"Response body returned after updating an event's status.",properties:{message:{type:"string",description:"Human-readable status message.",maxLength:500},eventId:{type:"string",format:"uuid",description:"UUID of the event whose status was updated.","x-oapi-codegen-extra-tags":{json:"eventId,omitempty"}},status:{type:"string",description:"Updated status of the event.",maxLength:255}}},BulkDeleteRequest:{type:"object",description:"Payload for bulk-deleting events by ID.",required:["ids"],properties:{ids:{type:"array",items:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},description:"UUIDs of the events to delete."}}},BulkDeleteResponse:{type:"object",description:"Response body returned after bulk event deletion.",properties:{deleted:{type:"array",items:{type:"string",format:"uuid"},description:"UUIDs of events that were deleted."}}},BulkUpdateStatusRequest:{type:"object",description:"Payload for bulk-updating the status of events.",required:["ids","status"],properties:{ids:{type:"array",items:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},description:"UUIDs of the events to update."},status:{type:"string",example:"failed",description:"New status to apply to the selected events.",maxLength:255}}},BulkUpdateStatusResponse:{type:"object",description:"Response body returned after bulk event status update.",properties:{updated:{type:"array",items:{type:"string",format:"uuid"},description:"UUIDs of events whose status was updated."}}},EventResult:{type:"object",additionalProperties:false,description:"EventResult entity schema.",properties:{owner:{type:"string",format:"uuid",description:"UUID of the user associated with the event.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"Owner","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"owner",json:"owner"}},systemId:{type:"string",description:"System identifier of the event source.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"system_id",json:"systemId"}},category:{type:"string",description:"The category of the event.",maxLength:500},action:{type:"string",description:"The action of the event.",maxLength:500},description:{type:"string",description:"Description of the event.",maxLength:5e3},firstName:{type:"string",description:"The first name of the user associated with the event.",maxLength:500},lastName:{type:"string",description:"The last name of the user associated with the event.",maxLength:500},email:{description:"Email address of the user associated with the event.",type:"string",format:"email","x-go-type-skip-optional-pointer":true},provider:{description:"Authentication provider of the user associated with the event.",type:"string","x-go-type-skip-optional-pointer":true},createdAt:{type:"string",format:"date-time",description:"Timestamp when the event was recorded.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"}}},required:["owner","category","action"]},EventsPage:{type:"object",description:"Paginated list of events.",properties:{page:{description:"Zero-based page index returned in this response.",type:"integer","x-go-type-skip-optional-pointer":true},pageSize:{description:"Maximum number of items returned on each page.",minimum:1,"x-oapi-codegen-extra-tags":{json:"pageSize,omitempty"},type:"integer","x-go-type-skip-optional-pointer":true},totalCount:{description:"Total number of items across all pages.",minimum:0,"x-oapi-codegen-extra-tags":{json:"totalCount,omitempty"},type:"integer","x-go-type-skip-optional-pointer":true},data:{type:"array",items:{type:"object",additionalProperties:false,description:"EventResult entity schema.",properties:{owner:{type:"string",format:"uuid",description:"UUID of the user associated with the event.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"Owner","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"owner",json:"owner"}},systemId:{type:"string",description:"System identifier of the event source.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"system_id",json:"systemId"}},category:{type:"string",description:"The category of the event.",maxLength:500},action:{type:"string",description:"The action of the event.",maxLength:500},description:{type:"string",description:"Description of the event.",maxLength:5e3},firstName:{type:"string",description:"The first name of the user associated with the event.",maxLength:500},lastName:{type:"string",description:"The last name of the user associated with the event.",maxLength:500},email:{description:"Email address of the user associated with the event.",type:"string",format:"email","x-go-type-skip-optional-pointer":true},provider:{description:"Authentication provider of the user associated with the event.",type:"string","x-go-type-skip-optional-pointer":true},createdAt:{type:"string",format:"date-time",description:"Timestamp when the event was recorded.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"}}},required:["owner","category","action"]},description:"The events returned on the current page."}}},EventsAggregate:{type:"object",description:"Aggregated event counts across categories.",properties:{audit:{type:"integer",description:"Count of audit-category events.",minimum:0}},additionalProperties:true},EventSummary:{type:"object",description:"Per-user event summary entry.",additionalProperties:true},EventSummaryPage:{type:"object",description:"Paginated list of per-user event summaries.",properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1,"x-oapi-codegen-extra-tags":{json:"pageSize,omitempty"}},totalCount:{type:"integer",description:"Total number of items available.",minimum:0,"x-oapi-codegen-extra-tags":{json:"totalCount,omitempty"}},data:{type:"array",items:{type:"object",description:"Per-user event summary entry.",additionalProperties:true},description:"The event summaries returned on the current page."}}},EventType:{type:"object",description:"A category/action pair describing one kind of event.",properties:{category:{type:"string",description:"The category of the event type.",maxLength:500},action:{type:"string",description:"The action of the event type.",maxLength:500}}},ErrorResponse:{type:"object",description:"Generic error envelope returned for non-2xx responses.",properties:{error:{type:"string",description:"Human-readable error message.",maxLength:500}}}}}},t=e;
|
|
1
|
+
'use strict';var e={openapi:"3.0.0",info:{title:"Events",description:"OpenAPI schema for Meshery events and system notifications.",version:"v1beta3",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},tags:[{name:"events",description:"APIs for Meshery Cloud events."}],paths:{"/events/{eventId}":{delete:{"x-internal":["cloud","meshery"],tags:["events"],operationId:"deleteEvent",summary:"Delete a single event",parameters:[{name:"eventId",in:"path",description:"ID of the event.",required:true,schema:{type:"string",format:"uuid"}}],responses:{204:{description:"Event 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"}}}}}}},"/events":{post:{"x-internal":["cloud","meshery"],tags:["events"],operationId:"createEvent",summary:"Create a new event",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for creating a new event.",additionalProperties:true,properties:{owner:{type:"string",format:"uuid",description:"UUID of the user associated with the event.","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,omitempty"}},category:{type:"string",description:"The category of the event.",maxLength:500},action:{type:"string",description:"The action of the event.",maxLength:500},description:{type:"string",description:"Description of the event.",maxLength:5e3}}}}}},responses:{201:{description:"Event created"},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"}}}}}}},"/events/delete":{post:{"x-internal":["cloud","meshery"],tags:["events"],operationId:"bulkDeleteEvents",summary:"Bulk delete events",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for bulk-deleting events by ID.",required:["ids"],properties:{ids:{type:"array",items:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},description:"UUIDs of the events to delete."}}}}}},responses:{200:{description:"Events deleted",content:{"application/json":{schema:{type:"object",description:"Response body returned after bulk event deletion.",properties:{deleted:{type:"array",items:{type:"string",format:"uuid"},description:"UUIDs of events that were 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"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/events/status":{put:{"x-internal":["cloud","meshery"],tags:["events"],operationId:"bulkUpdateEventStatus",summary:"Bulk update event status",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for bulk-updating the status of events.",required:["ids","status"],properties:{ids:{type:"array",items:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},description:"UUIDs of the events to update."},status:{type:"string",example:"failed",description:"New status to apply to the selected events.",maxLength:255}}}}}},responses:{200:{description:"Events updated",content:{"application/json":{schema:{type:"object",description:"Response body returned after bulk event status update.",properties:{updated:{type:"array",items:{type:"string",format:"uuid"},description:"UUIDs of events whose status was 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"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/events/{eventId}/status":{put:{"x-internal":["cloud","meshery"],tags:["events"],operationId:"updateEventStatus",summary:"Update status of a single event",parameters:[{name:"eventId",in:"path",description:"ID of the event.",required:true,schema:{type:"string",format:"uuid"}}],requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for updating the status of a single event.",required:["status"],properties:{status:{type:"string",example:"completed",description:"Current status of the event.",maxLength:255}}}}}},responses:{200:{description:"Event status updated",content:{"application/json":{schema:{type:"object",description:"Response body returned after updating an event's status.",properties:{message:{type:"string",description:"Human-readable status message.",maxLength:500},eventId:{type:"string",format:"uuid",description:"UUID of the event whose status was updated.","x-oapi-codegen-extra-tags":{json:"eventId,omitempty"}},status:{type:"string",description:"Updated status of the event.",maxLength:255}}}}}},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/workspaces/{workspaceId}/events":{get:{"x-internal":["cloud"],tags:["events"],security:[{jwt:[]}],operationId:"getEventsOfWorkspace",summary:"Get workspace events",description:"Gets events for a workspace.",parameters:[{name:"workspaceId",in:"path",description:"Workspace ID",schema:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"workspace_id",json:"workspaceId"},"x-go-type-name":"WorkspaceId","x-go-type-skip-optional-pointer":true},required:true},{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},{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:"integer"}},{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:"Workspace events",content:{"application/json":{schema:{type:"object",description:"Paginated list of events.",properties:{page:{description:"Zero-based page index returned in this response.",type:"integer","x-go-type-skip-optional-pointer":true},pageSize:{description:"Maximum number of items returned on each page.",minimum:1,"x-oapi-codegen-extra-tags":{json:"pageSize,omitempty"},type:"integer","x-go-type-skip-optional-pointer":true},totalCount:{description:"Total number of items across all pages.",minimum:0,"x-oapi-codegen-extra-tags":{json:"totalCount,omitempty"},type:"integer","x-go-type-skip-optional-pointer":true},data:{type:"array",items:{type:"object",additionalProperties:false,description:"EventResult entity schema.",properties:{owner:{type:"string",format:"uuid",description:"UUID of the user associated with the event.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"Owner","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"owner",json:"owner"}},systemId:{type:"string",description:"System identifier of the event source.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"system_id",json:"systemId"}},category:{type:"string",description:"The category of the event.",maxLength:500},action:{type:"string",description:"The action of the event.",maxLength:500},description:{type:"string",description:"Description of the event.",maxLength:5e3},firstName:{type:"string",description:"The first name of the user associated with the event.",maxLength:500},lastName:{type:"string",description:"The last name of the user associated with the event.",maxLength:500},email:{description:"Email address of the user associated with the event.",type:"string",format:"email","x-go-type-skip-optional-pointer":true},provider:{description:"Authentication provider of the user associated with the event.",type:"string","x-go-type-skip-optional-pointer":true},createdAt:{type:"string",format:"date-time",description:"Timestamp when the event was recorded.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"}}},required:["owner","category","action"]},description:"The events returned on the current page."}}}}}},400:{description:"Invalid request",content:{"application/json":{schema:{type:"object",description:"Generic error envelope returned for non-2xx responses.",properties:{error:{type:"string",description:"Human-readable error message.",maxLength:500}}}}}},401:{description:"Unauthorized"},404:{description:"Workspace not found"},500:{description:"Server error"}}}},"/api/events":{get:{"x-internal":["cloud"],tags:["events"],operationId:"getEventsAggregate",summary:"Get events aggregate summary",parameters:[{name:"cumulative",in:"query",description:"When true, return cumulative aggregate counts across all time.",required:false,schema:{type:"boolean"}}],responses:{200:{description:"Events aggregate",content:{"application/json":{schema:{type:"object",description:"Aggregated event counts across categories.",properties:{audit:{type:"integer",description:"Count of audit-category events.",minimum:0}},additionalProperties:true}}}},401:{description:"Unauthorized"},404:{description:"Not found"},500:{description:"Server error"}}}},"/api/events/list":{get:{"x-internal":["cloud"],tags:["events"],operationId:"getEvents",summary:"Get events list",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"integer"}},{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:"filter",in:"query",description:"Get filtered reponses",schema:{type:"string"}}],responses:{200:{description:"Events page",content:{"application/json":{schema:{type:"object",description:"Paginated list of events.",properties:{page:{description:"Zero-based page index returned in this response.",type:"integer","x-go-type-skip-optional-pointer":true},pageSize:{description:"Maximum number of items returned on each page.",minimum:1,"x-oapi-codegen-extra-tags":{json:"pageSize,omitempty"},type:"integer","x-go-type-skip-optional-pointer":true},totalCount:{description:"Total number of items across all pages.",minimum:0,"x-oapi-codegen-extra-tags":{json:"totalCount,omitempty"},type:"integer","x-go-type-skip-optional-pointer":true},data:{type:"array",items:{type:"object",additionalProperties:false,description:"EventResult entity schema.",properties:{owner:{type:"string",format:"uuid",description:"UUID of the user associated with the event.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"Owner","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"owner",json:"owner"}},systemId:{type:"string",description:"System identifier of the event source.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"system_id",json:"systemId"}},category:{type:"string",description:"The category of the event.",maxLength:500},action:{type:"string",description:"The action of the event.",maxLength:500},description:{type:"string",description:"Description of the event.",maxLength:5e3},firstName:{type:"string",description:"The first name of the user associated with the event.",maxLength:500},lastName:{type:"string",description:"The last name of the user associated with the event.",maxLength:500},email:{description:"Email address of the user associated with the event.",type:"string",format:"email","x-go-type-skip-optional-pointer":true},provider:{description:"Authentication provider of the user associated with the event.",type:"string","x-go-type-skip-optional-pointer":true},createdAt:{type:"string",format:"date-time",description:"Timestamp when the event was recorded.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"}}},required:["owner","category","action"]},description:"The events returned on the current page."}}}}}},401:{description:"Unauthorized"},404:{description:"Not found"},500:{description:"Server error"}}}},"/api/events/summary":{get:{"x-internal":["cloud"],tags:["events"],operationId:"getEventSummaryByUser",summary:"Get event summary by user",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"integer"}},{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:"filter",in:"query",description:"Get filtered reponses",schema:{type:"string"}}],responses:{200:{description:"Event summary page",content:{"application/json":{schema:{type:"object",description:"Paginated list of per-user event summaries.",properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1,"x-oapi-codegen-extra-tags":{json:"pageSize,omitempty"}},totalCount:{type:"integer",description:"Total number of items available.",minimum:0,"x-oapi-codegen-extra-tags":{json:"totalCount,omitempty"}},data:{type:"array",items:{type:"object",description:"Per-user event summary entry.",additionalProperties:true},description:"The event summaries returned on the current page."}}}}}},401:{description:"Unauthorized"},404:{description:"Not found"},500:{description:"Server error"}}}},"/api/events/types":{get:{"x-internal":["cloud"],tags:["events"],operationId:"getEventTypes",summary:"Get event types",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},{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:"integer"}}],responses:{200:{description:"Event types",content:{"application/json":{schema:{type:"array",items:{type:"object",description:"A category/action pair describing one kind of event.",properties:{category:{type:"string",description:"The category of the event type.",maxLength:500},action:{type:"string",description:"The action of the event type.",maxLength:500}}}}}}},401:{description:"Unauthorized"},404:{description:"Not found"},500:{description:"Server error"}}}}},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:{eventId:{name:"eventId",in:"path",description:"ID of the event.",required:true,schema:{type:"string",format:"uuid"}},workspaceId:{name:"workspaceId",in:"path",description:"Workspace ID",schema:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"workspace_id",json:"workspaceId"},"x-go-type-name":"WorkspaceId","x-go-type-skip-optional-pointer":true},required:true},page:{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},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",schema:{type:"integer"}},pagesizeLegacy:{name:"pagesize",in:"query",description:"Get responses by pagesize. Deprecated alias of pageSize.",deprecated:true,schema:{type:"integer"}},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"}},cumulative:{name:"cumulative",in:"query",description:"When true, return cumulative aggregate counts across all time.",required:false,schema:{type:"boolean"}},filter:{name:"filter",in:"query",description:"Get filtered reponses",schema:{type:"string"}},eventsFilter:{name:"filter",in:"query",description:"Get filtered reponses",schema:{type:"string"}}},securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},schemas:{EventPayload:{type:"object",description:"Payload for creating a new event.",additionalProperties:true,properties:{owner:{type:"string",format:"uuid",description:"UUID of the user associated with the event.","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,omitempty"}},category:{type:"string",description:"The category of the event.",maxLength:500},action:{type:"string",description:"The action of the event.",maxLength:500},description:{type:"string",description:"Description of the event.",maxLength:5e3}}},UpdateEventStatusRequest:{type:"object",description:"Payload for updating the status of a single event.",required:["status"],properties:{status:{type:"string",example:"completed",description:"Current status of the event.",maxLength:255}}},UpdateEventStatusResponse:{type:"object",description:"Response body returned after updating an event's status.",properties:{message:{type:"string",description:"Human-readable status message.",maxLength:500},eventId:{type:"string",format:"uuid",description:"UUID of the event whose status was updated.","x-oapi-codegen-extra-tags":{json:"eventId,omitempty"}},status:{type:"string",description:"Updated status of the event.",maxLength:255}}},BulkDeleteRequest:{type:"object",description:"Payload for bulk-deleting events by ID.",required:["ids"],properties:{ids:{type:"array",items:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},description:"UUIDs of the events to delete."}}},BulkDeleteResponse:{type:"object",description:"Response body returned after bulk event deletion.",properties:{deleted:{type:"array",items:{type:"string",format:"uuid"},description:"UUIDs of events that were deleted."}}},BulkUpdateStatusRequest:{type:"object",description:"Payload for bulk-updating the status of events.",required:["ids","status"],properties:{ids:{type:"array",items:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},description:"UUIDs of the events to update."},status:{type:"string",example:"failed",description:"New status to apply to the selected events.",maxLength:255}}},BulkUpdateStatusResponse:{type:"object",description:"Response body returned after bulk event status update.",properties:{updated:{type:"array",items:{type:"string",format:"uuid"},description:"UUIDs of events whose status was updated."}}},EventResult:{type:"object",additionalProperties:false,description:"EventResult entity schema.",properties:{owner:{type:"string",format:"uuid",description:"UUID of the user associated with the event.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"Owner","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"owner",json:"owner"}},systemId:{type:"string",description:"System identifier of the event source.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"system_id",json:"systemId"}},category:{type:"string",description:"The category of the event.",maxLength:500},action:{type:"string",description:"The action of the event.",maxLength:500},description:{type:"string",description:"Description of the event.",maxLength:5e3},firstName:{type:"string",description:"The first name of the user associated with the event.",maxLength:500},lastName:{type:"string",description:"The last name of the user associated with the event.",maxLength:500},email:{description:"Email address of the user associated with the event.",type:"string",format:"email","x-go-type-skip-optional-pointer":true},provider:{description:"Authentication provider of the user associated with the event.",type:"string","x-go-type-skip-optional-pointer":true},createdAt:{type:"string",format:"date-time",description:"Timestamp when the event was recorded.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"}}},required:["owner","category","action"]},EventsPage:{type:"object",description:"Paginated list of events.",properties:{page:{description:"Zero-based page index returned in this response.",type:"integer","x-go-type-skip-optional-pointer":true},pageSize:{description:"Maximum number of items returned on each page.",minimum:1,"x-oapi-codegen-extra-tags":{json:"pageSize,omitempty"},type:"integer","x-go-type-skip-optional-pointer":true},totalCount:{description:"Total number of items across all pages.",minimum:0,"x-oapi-codegen-extra-tags":{json:"totalCount,omitempty"},type:"integer","x-go-type-skip-optional-pointer":true},data:{type:"array",items:{type:"object",additionalProperties:false,description:"EventResult entity schema.",properties:{owner:{type:"string",format:"uuid",description:"UUID of the user associated with the event.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"Owner","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"owner",json:"owner"}},systemId:{type:"string",description:"System identifier of the event source.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"system_id",json:"systemId"}},category:{type:"string",description:"The category of the event.",maxLength:500},action:{type:"string",description:"The action of the event.",maxLength:500},description:{type:"string",description:"Description of the event.",maxLength:5e3},firstName:{type:"string",description:"The first name of the user associated with the event.",maxLength:500},lastName:{type:"string",description:"The last name of the user associated with the event.",maxLength:500},email:{description:"Email address of the user associated with the event.",type:"string",format:"email","x-go-type-skip-optional-pointer":true},provider:{description:"Authentication provider of the user associated with the event.",type:"string","x-go-type-skip-optional-pointer":true},createdAt:{type:"string",format:"date-time",description:"Timestamp when the event was recorded.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"}}},required:["owner","category","action"]},description:"The events returned on the current page."}}},EventsAggregate:{type:"object",description:"Aggregated event counts across categories.",properties:{audit:{type:"integer",description:"Count of audit-category events.",minimum:0}},additionalProperties:true},EventSummary:{type:"object",description:"Per-user event summary entry.",additionalProperties:true},EventSummaryPage:{type:"object",description:"Paginated list of per-user event summaries.",properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1,"x-oapi-codegen-extra-tags":{json:"pageSize,omitempty"}},totalCount:{type:"integer",description:"Total number of items available.",minimum:0,"x-oapi-codegen-extra-tags":{json:"totalCount,omitempty"}},data:{type:"array",items:{type:"object",description:"Per-user event summary entry.",additionalProperties:true},description:"The event summaries returned on the current page."}}},EventType:{type:"object",description:"A category/action pair describing one kind of event.",properties:{category:{type:"string",description:"The category of the event type.",maxLength:500},action:{type:"string",description:"The action of the event type.",maxLength:500}}},ErrorResponse:{type:"object",description:"Generic error envelope returned for non-2xx responses.",properties:{error:{type:"string",description:"Human-readable error message.",maxLength:500}}}}}},t=e;
|
|
2
2
|
module.exports=t;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
var e={openapi:"3.0.0",info:{title:"Events",description:"OpenAPI schema for Meshery events and system notifications.",version:"v1beta3",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},tags:[{name:"events",description:"APIs for Meshery Cloud events."}],paths:{"/events/{eventId}":{delete:{"x-internal":["cloud","meshery"],tags:["events"],operationId:"deleteEvent",summary:"Delete a single event",parameters:[{name:"eventId",in:"path",description:"ID of the event.",required:true,schema:{type:"string",format:"uuid"}}],responses:{204:{description:"Event 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"}}}}}}},"/events":{post:{"x-internal":["cloud","meshery"],tags:["events"],operationId:"createEvent",summary:"Create a new event",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for creating a new event.",additionalProperties:true,properties:{owner:{type:"string",format:"uuid",description:"UUID of the user associated with the event.","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,omitempty"}},category:{type:"string",description:"The category of the event.",maxLength:500},action:{type:"string",description:"The action of the event.",maxLength:500},description:{type:"string",description:"Description of the event.",maxLength:5e3}}}}}},responses:{201:{description:"Event created"},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"}}}}}}},"/events/delete":{post:{"x-internal":["cloud","meshery"],tags:["events"],operationId:"bulkDeleteEvents",summary:"Bulk delete events",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for bulk-deleting events by ID.",required:["ids"],properties:{ids:{type:"array",items:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},description:"UUIDs of the events to delete."}}}}}},responses:{200:{description:"Events deleted",content:{"application/json":{schema:{type:"object",description:"Response body returned after bulk event deletion.",properties:{deleted:{type:"array",items:{type:"string",format:"uuid"},description:"UUIDs of events that were 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"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/events/status":{put:{"x-internal":["cloud","meshery"],tags:["events"],operationId:"bulkUpdateEventStatus",summary:"Bulk update event status",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for bulk-updating the status of events.",required:["ids","status"],properties:{ids:{type:"array",items:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},description:"UUIDs of the events to update."},status:{type:"string",example:"failed",description:"New status to apply to the selected events.",maxLength:255}}}}}},responses:{200:{description:"Events updated",content:{"application/json":{schema:{type:"object",description:"Response body returned after bulk event status update.",properties:{updated:{type:"array",items:{type:"string",format:"uuid"},description:"UUIDs of events whose status was 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"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/events/{eventId}/status":{put:{"x-internal":["cloud","meshery"],tags:["events"],operationId:"updateEventStatus",summary:"Update status of a single event",parameters:[{name:"eventId",in:"path",description:"ID of the event.",required:true,schema:{type:"string",format:"uuid"}}],requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for updating the status of a single event.",required:["status"],properties:{status:{type:"string",example:"completed",description:"Current status of the event.",maxLength:255}}}}}},responses:{200:{description:"Event status updated",content:{"application/json":{schema:{type:"object",description:"Response body returned after updating an event's status.",properties:{message:{type:"string",description:"Human-readable status message.",maxLength:500},eventId:{type:"string",format:"uuid",description:"UUID of the event whose status was updated.","x-oapi-codegen-extra-tags":{json:"eventId,omitempty"}},status:{type:"string",description:"Updated status of the event.",maxLength:255}}}}}},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/workspaces/{workspaceId}/events":{get:{"x-internal":["cloud"],tags:["events"],security:[{jwt:[]}],operationId:"getEventsOfWorkspace",summary:"Get workspace events",description:"Gets events for a workspace.",parameters:[{name:"workspaceId",in:"path",description:"Workspace ID",schema:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"workspace_id",json:"workspaceId"},"x-go-type-name":"WorkspaceId","x-go-type-skip-optional-pointer":true},required:true},{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer"}},{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:"integer"}},{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:"Workspace events",content:{"application/json":{schema:{type:"object",description:"Paginated list of events.",properties:{page:{description:"Zero-based page index returned in this response.",type:"integer","x-go-type-skip-optional-pointer":true},pageSize:{description:"Maximum number of items returned on each page.",minimum:1,"x-oapi-codegen-extra-tags":{json:"pageSize,omitempty"},type:"integer","x-go-type-skip-optional-pointer":true},totalCount:{description:"Total number of items across all pages.",minimum:0,"x-oapi-codegen-extra-tags":{json:"totalCount,omitempty"},type:"integer","x-go-type-skip-optional-pointer":true},data:{type:"array",items:{type:"object",additionalProperties:false,description:"EventResult entity schema.",properties:{owner:{type:"string",format:"uuid",description:"UUID of the user associated with the event.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"Owner","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"owner",json:"owner"}},systemId:{type:"string",description:"System identifier of the event source.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"system_id",json:"systemId"}},category:{type:"string",description:"The category of the event.",maxLength:500},action:{type:"string",description:"The action of the event.",maxLength:500},description:{type:"string",description:"Description of the event.",maxLength:5e3},firstName:{type:"string",description:"The first name of the user associated with the event.",maxLength:500},lastName:{type:"string",description:"The last name of the user associated with the event.",maxLength:500},email:{description:"Email address of the user associated with the event.",type:"string",format:"email","x-go-type-skip-optional-pointer":true},provider:{description:"Authentication provider of the user associated with the event.",type:"string","x-go-type-skip-optional-pointer":true},createdAt:{type:"string",format:"date-time",description:"Timestamp when the event was recorded.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"}}},required:["owner","category","action"]},description:"The events returned on the current page."}}}}}},400:{description:"Invalid request",content:{"application/json":{schema:{type:"object",description:"Generic error envelope returned for non-2xx responses.",properties:{error:{type:"string",description:"Human-readable error message.",maxLength:500}}}}}},401:{description:"Unauthorized"},404:{description:"Workspace not found"},500:{description:"Server error"}}}},"/api/events":{get:{"x-internal":["cloud"],tags:["events"],operationId:"getEventsAggregate",summary:"Get events aggregate summary",parameters:[{name:"cumulative",in:"query",description:"When true, return cumulative aggregate counts across all time.",required:false,schema:{type:"boolean"}}],responses:{200:{description:"Events aggregate",content:{"application/json":{schema:{type:"object",description:"Aggregated event counts across categories.",properties:{audit:{type:"integer",description:"Count of audit-category events.",minimum:0}},additionalProperties:true}}}},401:{description:"Unauthorized"},404:{description:"Not found"},500:{description:"Server error"}}}},"/api/events/list":{get:{"x-internal":["cloud"],tags:["events"],operationId:"getEvents",summary:"Get events list",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer"}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"integer"}},{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:"filter",in:"query",description:"Get filtered reponses",schema:{type:"string"}}],responses:{200:{description:"Events page",content:{"application/json":{schema:{type:"object",description:"Paginated list of events.",properties:{page:{description:"Zero-based page index returned in this response.",type:"integer","x-go-type-skip-optional-pointer":true},pageSize:{description:"Maximum number of items returned on each page.",minimum:1,"x-oapi-codegen-extra-tags":{json:"pageSize,omitempty"},type:"integer","x-go-type-skip-optional-pointer":true},totalCount:{description:"Total number of items across all pages.",minimum:0,"x-oapi-codegen-extra-tags":{json:"totalCount,omitempty"},type:"integer","x-go-type-skip-optional-pointer":true},data:{type:"array",items:{type:"object",additionalProperties:false,description:"EventResult entity schema.",properties:{owner:{type:"string",format:"uuid",description:"UUID of the user associated with the event.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"Owner","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"owner",json:"owner"}},systemId:{type:"string",description:"System identifier of the event source.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"system_id",json:"systemId"}},category:{type:"string",description:"The category of the event.",maxLength:500},action:{type:"string",description:"The action of the event.",maxLength:500},description:{type:"string",description:"Description of the event.",maxLength:5e3},firstName:{type:"string",description:"The first name of the user associated with the event.",maxLength:500},lastName:{type:"string",description:"The last name of the user associated with the event.",maxLength:500},email:{description:"Email address of the user associated with the event.",type:"string",format:"email","x-go-type-skip-optional-pointer":true},provider:{description:"Authentication provider of the user associated with the event.",type:"string","x-go-type-skip-optional-pointer":true},createdAt:{type:"string",format:"date-time",description:"Timestamp when the event was recorded.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"}}},required:["owner","category","action"]},description:"The events returned on the current page."}}}}}},401:{description:"Unauthorized"},404:{description:"Not found"},500:{description:"Server error"}}}},"/api/events/summary":{get:{"x-internal":["cloud"],tags:["events"],operationId:"getEventSummaryByUser",summary:"Get event summary by user",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer"}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"integer"}},{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:"filter",in:"query",description:"Get filtered reponses",schema:{type:"string"}}],responses:{200:{description:"Event summary page",content:{"application/json":{schema:{type:"object",description:"Paginated list of per-user event summaries.",properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1,"x-oapi-codegen-extra-tags":{json:"pageSize,omitempty"}},totalCount:{type:"integer",description:"Total number of items available.",minimum:0,"x-oapi-codegen-extra-tags":{json:"totalCount,omitempty"}},data:{type:"array",items:{type:"object",description:"Per-user event summary entry.",additionalProperties:true},description:"The event summaries returned on the current page."}}}}}},401:{description:"Unauthorized"},404:{description:"Not found"},500:{description:"Server error"}}}},"/api/events/types":{get:{"x-internal":["cloud"],tags:["events"],operationId:"getEventTypes",summary:"Get event types",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer"}},{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:"integer"}}],responses:{200:{description:"Event types",content:{"application/json":{schema:{type:"array",items:{type:"object",description:"A category/action pair describing one kind of event.",properties:{category:{type:"string",description:"The category of the event type.",maxLength:500},action:{type:"string",description:"The action of the event type.",maxLength:500}}}}}}},401:{description:"Unauthorized"},404:{description:"Not found"},500:{description:"Server error"}}}}},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:{eventId:{name:"eventId",in:"path",description:"ID of the event.",required:true,schema:{type:"string",format:"uuid"}},workspaceId:{name:"workspaceId",in:"path",description:"Workspace ID",schema:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"workspace_id",json:"workspaceId"},"x-go-type-name":"WorkspaceId","x-go-type-skip-optional-pointer":true},required:true},page:{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer"}},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",schema:{type:"integer"}},pagesizeLegacy:{name:"pagesize",in:"query",description:"Get responses by pagesize. Deprecated alias of pageSize.",deprecated:true,schema:{type:"integer"}},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"}},cumulative:{name:"cumulative",in:"query",description:"When true, return cumulative aggregate counts across all time.",required:false,schema:{type:"boolean"}},filter:{name:"filter",in:"query",description:"Get filtered reponses",schema:{type:"string"}},eventsFilter:{name:"filter",in:"query",description:"Get filtered reponses",schema:{type:"string"}}},securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},schemas:{EventPayload:{type:"object",description:"Payload for creating a new event.",additionalProperties:true,properties:{owner:{type:"string",format:"uuid",description:"UUID of the user associated with the event.","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,omitempty"}},category:{type:"string",description:"The category of the event.",maxLength:500},action:{type:"string",description:"The action of the event.",maxLength:500},description:{type:"string",description:"Description of the event.",maxLength:5e3}}},UpdateEventStatusRequest:{type:"object",description:"Payload for updating the status of a single event.",required:["status"],properties:{status:{type:"string",example:"completed",description:"Current status of the event.",maxLength:255}}},UpdateEventStatusResponse:{type:"object",description:"Response body returned after updating an event's status.",properties:{message:{type:"string",description:"Human-readable status message.",maxLength:500},eventId:{type:"string",format:"uuid",description:"UUID of the event whose status was updated.","x-oapi-codegen-extra-tags":{json:"eventId,omitempty"}},status:{type:"string",description:"Updated status of the event.",maxLength:255}}},BulkDeleteRequest:{type:"object",description:"Payload for bulk-deleting events by ID.",required:["ids"],properties:{ids:{type:"array",items:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},description:"UUIDs of the events to delete."}}},BulkDeleteResponse:{type:"object",description:"Response body returned after bulk event deletion.",properties:{deleted:{type:"array",items:{type:"string",format:"uuid"},description:"UUIDs of events that were deleted."}}},BulkUpdateStatusRequest:{type:"object",description:"Payload for bulk-updating the status of events.",required:["ids","status"],properties:{ids:{type:"array",items:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},description:"UUIDs of the events to update."},status:{type:"string",example:"failed",description:"New status to apply to the selected events.",maxLength:255}}},BulkUpdateStatusResponse:{type:"object",description:"Response body returned after bulk event status update.",properties:{updated:{type:"array",items:{type:"string",format:"uuid"},description:"UUIDs of events whose status was updated."}}},EventResult:{type:"object",additionalProperties:false,description:"EventResult entity schema.",properties:{owner:{type:"string",format:"uuid",description:"UUID of the user associated with the event.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"Owner","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"owner",json:"owner"}},systemId:{type:"string",description:"System identifier of the event source.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"system_id",json:"systemId"}},category:{type:"string",description:"The category of the event.",maxLength:500},action:{type:"string",description:"The action of the event.",maxLength:500},description:{type:"string",description:"Description of the event.",maxLength:5e3},firstName:{type:"string",description:"The first name of the user associated with the event.",maxLength:500},lastName:{type:"string",description:"The last name of the user associated with the event.",maxLength:500},email:{description:"Email address of the user associated with the event.",type:"string",format:"email","x-go-type-skip-optional-pointer":true},provider:{description:"Authentication provider of the user associated with the event.",type:"string","x-go-type-skip-optional-pointer":true},createdAt:{type:"string",format:"date-time",description:"Timestamp when the event was recorded.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"}}},required:["owner","category","action"]},EventsPage:{type:"object",description:"Paginated list of events.",properties:{page:{description:"Zero-based page index returned in this response.",type:"integer","x-go-type-skip-optional-pointer":true},pageSize:{description:"Maximum number of items returned on each page.",minimum:1,"x-oapi-codegen-extra-tags":{json:"pageSize,omitempty"},type:"integer","x-go-type-skip-optional-pointer":true},totalCount:{description:"Total number of items across all pages.",minimum:0,"x-oapi-codegen-extra-tags":{json:"totalCount,omitempty"},type:"integer","x-go-type-skip-optional-pointer":true},data:{type:"array",items:{type:"object",additionalProperties:false,description:"EventResult entity schema.",properties:{owner:{type:"string",format:"uuid",description:"UUID of the user associated with the event.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"Owner","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"owner",json:"owner"}},systemId:{type:"string",description:"System identifier of the event source.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"system_id",json:"systemId"}},category:{type:"string",description:"The category of the event.",maxLength:500},action:{type:"string",description:"The action of the event.",maxLength:500},description:{type:"string",description:"Description of the event.",maxLength:5e3},firstName:{type:"string",description:"The first name of the user associated with the event.",maxLength:500},lastName:{type:"string",description:"The last name of the user associated with the event.",maxLength:500},email:{description:"Email address of the user associated with the event.",type:"string",format:"email","x-go-type-skip-optional-pointer":true},provider:{description:"Authentication provider of the user associated with the event.",type:"string","x-go-type-skip-optional-pointer":true},createdAt:{type:"string",format:"date-time",description:"Timestamp when the event was recorded.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"}}},required:["owner","category","action"]},description:"The events returned on the current page."}}},EventsAggregate:{type:"object",description:"Aggregated event counts across categories.",properties:{audit:{type:"integer",description:"Count of audit-category events.",minimum:0}},additionalProperties:true},EventSummary:{type:"object",description:"Per-user event summary entry.",additionalProperties:true},EventSummaryPage:{type:"object",description:"Paginated list of per-user event summaries.",properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1,"x-oapi-codegen-extra-tags":{json:"pageSize,omitempty"}},totalCount:{type:"integer",description:"Total number of items available.",minimum:0,"x-oapi-codegen-extra-tags":{json:"totalCount,omitempty"}},data:{type:"array",items:{type:"object",description:"Per-user event summary entry.",additionalProperties:true},description:"The event summaries returned on the current page."}}},EventType:{type:"object",description:"A category/action pair describing one kind of event.",properties:{category:{type:"string",description:"The category of the event type.",maxLength:500},action:{type:"string",description:"The action of the event type.",maxLength:500}}},ErrorResponse:{type:"object",description:"Generic error envelope returned for non-2xx responses.",properties:{error:{type:"string",description:"Human-readable error message.",maxLength:500}}}}}},t=e;
|
|
1
|
+
var e={openapi:"3.0.0",info:{title:"Events",description:"OpenAPI schema for Meshery events and system notifications.",version:"v1beta3",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},tags:[{name:"events",description:"APIs for Meshery Cloud events."}],paths:{"/events/{eventId}":{delete:{"x-internal":["cloud","meshery"],tags:["events"],operationId:"deleteEvent",summary:"Delete a single event",parameters:[{name:"eventId",in:"path",description:"ID of the event.",required:true,schema:{type:"string",format:"uuid"}}],responses:{204:{description:"Event 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"}}}}}}},"/events":{post:{"x-internal":["cloud","meshery"],tags:["events"],operationId:"createEvent",summary:"Create a new event",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for creating a new event.",additionalProperties:true,properties:{owner:{type:"string",format:"uuid",description:"UUID of the user associated with the event.","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,omitempty"}},category:{type:"string",description:"The category of the event.",maxLength:500},action:{type:"string",description:"The action of the event.",maxLength:500},description:{type:"string",description:"Description of the event.",maxLength:5e3}}}}}},responses:{201:{description:"Event created"},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"}}}}}}},"/events/delete":{post:{"x-internal":["cloud","meshery"],tags:["events"],operationId:"bulkDeleteEvents",summary:"Bulk delete events",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for bulk-deleting events by ID.",required:["ids"],properties:{ids:{type:"array",items:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},description:"UUIDs of the events to delete."}}}}}},responses:{200:{description:"Events deleted",content:{"application/json":{schema:{type:"object",description:"Response body returned after bulk event deletion.",properties:{deleted:{type:"array",items:{type:"string",format:"uuid"},description:"UUIDs of events that were 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"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/events/status":{put:{"x-internal":["cloud","meshery"],tags:["events"],operationId:"bulkUpdateEventStatus",summary:"Bulk update event status",requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for bulk-updating the status of events.",required:["ids","status"],properties:{ids:{type:"array",items:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},description:"UUIDs of the events to update."},status:{type:"string",example:"failed",description:"New status to apply to the selected events.",maxLength:255}}}}}},responses:{200:{description:"Events updated",content:{"application/json":{schema:{type:"object",description:"Response body returned after bulk event status update.",properties:{updated:{type:"array",items:{type:"string",format:"uuid"},description:"UUIDs of events whose status was 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"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/events/{eventId}/status":{put:{"x-internal":["cloud","meshery"],tags:["events"],operationId:"updateEventStatus",summary:"Update status of a single event",parameters:[{name:"eventId",in:"path",description:"ID of the event.",required:true,schema:{type:"string",format:"uuid"}}],requestBody:{required:true,content:{"application/json":{schema:{type:"object",description:"Payload for updating the status of a single event.",required:["status"],properties:{status:{type:"string",example:"completed",description:"Current status of the event.",maxLength:255}}}}}},responses:{200:{description:"Event status updated",content:{"application/json":{schema:{type:"object",description:"Response body returned after updating an event's status.",properties:{message:{type:"string",description:"Human-readable status message.",maxLength:500},eventId:{type:"string",format:"uuid",description:"UUID of the event whose status was updated.","x-oapi-codegen-extra-tags":{json:"eventId,omitempty"}},status:{type:"string",description:"Updated status of the event.",maxLength:255}}}}}},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/workspaces/{workspaceId}/events":{get:{"x-internal":["cloud"],tags:["events"],security:[{jwt:[]}],operationId:"getEventsOfWorkspace",summary:"Get workspace events",description:"Gets events for a workspace.",parameters:[{name:"workspaceId",in:"path",description:"Workspace ID",schema:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"workspace_id",json:"workspaceId"},"x-go-type-name":"WorkspaceId","x-go-type-skip-optional-pointer":true},required:true},{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},{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:"integer"}},{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:"Workspace events",content:{"application/json":{schema:{type:"object",description:"Paginated list of events.",properties:{page:{description:"Zero-based page index returned in this response.",type:"integer","x-go-type-skip-optional-pointer":true},pageSize:{description:"Maximum number of items returned on each page.",minimum:1,"x-oapi-codegen-extra-tags":{json:"pageSize,omitempty"},type:"integer","x-go-type-skip-optional-pointer":true},totalCount:{description:"Total number of items across all pages.",minimum:0,"x-oapi-codegen-extra-tags":{json:"totalCount,omitempty"},type:"integer","x-go-type-skip-optional-pointer":true},data:{type:"array",items:{type:"object",additionalProperties:false,description:"EventResult entity schema.",properties:{owner:{type:"string",format:"uuid",description:"UUID of the user associated with the event.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"Owner","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"owner",json:"owner"}},systemId:{type:"string",description:"System identifier of the event source.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"system_id",json:"systemId"}},category:{type:"string",description:"The category of the event.",maxLength:500},action:{type:"string",description:"The action of the event.",maxLength:500},description:{type:"string",description:"Description of the event.",maxLength:5e3},firstName:{type:"string",description:"The first name of the user associated with the event.",maxLength:500},lastName:{type:"string",description:"The last name of the user associated with the event.",maxLength:500},email:{description:"Email address of the user associated with the event.",type:"string",format:"email","x-go-type-skip-optional-pointer":true},provider:{description:"Authentication provider of the user associated with the event.",type:"string","x-go-type-skip-optional-pointer":true},createdAt:{type:"string",format:"date-time",description:"Timestamp when the event was recorded.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"}}},required:["owner","category","action"]},description:"The events returned on the current page."}}}}}},400:{description:"Invalid request",content:{"application/json":{schema:{type:"object",description:"Generic error envelope returned for non-2xx responses.",properties:{error:{type:"string",description:"Human-readable error message.",maxLength:500}}}}}},401:{description:"Unauthorized"},404:{description:"Workspace not found"},500:{description:"Server error"}}}},"/api/events":{get:{"x-internal":["cloud"],tags:["events"],operationId:"getEventsAggregate",summary:"Get events aggregate summary",parameters:[{name:"cumulative",in:"query",description:"When true, return cumulative aggregate counts across all time.",required:false,schema:{type:"boolean"}}],responses:{200:{description:"Events aggregate",content:{"application/json":{schema:{type:"object",description:"Aggregated event counts across categories.",properties:{audit:{type:"integer",description:"Count of audit-category events.",minimum:0}},additionalProperties:true}}}},401:{description:"Unauthorized"},404:{description:"Not found"},500:{description:"Server error"}}}},"/api/events/list":{get:{"x-internal":["cloud"],tags:["events"],operationId:"getEvents",summary:"Get events list",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"integer"}},{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:"filter",in:"query",description:"Get filtered reponses",schema:{type:"string"}}],responses:{200:{description:"Events page",content:{"application/json":{schema:{type:"object",description:"Paginated list of events.",properties:{page:{description:"Zero-based page index returned in this response.",type:"integer","x-go-type-skip-optional-pointer":true},pageSize:{description:"Maximum number of items returned on each page.",minimum:1,"x-oapi-codegen-extra-tags":{json:"pageSize,omitempty"},type:"integer","x-go-type-skip-optional-pointer":true},totalCount:{description:"Total number of items across all pages.",minimum:0,"x-oapi-codegen-extra-tags":{json:"totalCount,omitempty"},type:"integer","x-go-type-skip-optional-pointer":true},data:{type:"array",items:{type:"object",additionalProperties:false,description:"EventResult entity schema.",properties:{owner:{type:"string",format:"uuid",description:"UUID of the user associated with the event.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"Owner","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"owner",json:"owner"}},systemId:{type:"string",description:"System identifier of the event source.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"system_id",json:"systemId"}},category:{type:"string",description:"The category of the event.",maxLength:500},action:{type:"string",description:"The action of the event.",maxLength:500},description:{type:"string",description:"Description of the event.",maxLength:5e3},firstName:{type:"string",description:"The first name of the user associated with the event.",maxLength:500},lastName:{type:"string",description:"The last name of the user associated with the event.",maxLength:500},email:{description:"Email address of the user associated with the event.",type:"string",format:"email","x-go-type-skip-optional-pointer":true},provider:{description:"Authentication provider of the user associated with the event.",type:"string","x-go-type-skip-optional-pointer":true},createdAt:{type:"string",format:"date-time",description:"Timestamp when the event was recorded.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"}}},required:["owner","category","action"]},description:"The events returned on the current page."}}}}}},401:{description:"Unauthorized"},404:{description:"Not found"},500:{description:"Server error"}}}},"/api/events/summary":{get:{"x-internal":["cloud"],tags:["events"],operationId:"getEventSummaryByUser",summary:"Get event summary by user",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},{name:"pagesize",in:"query",description:"Get responses by pagesize",schema:{type:"integer"}},{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:"filter",in:"query",description:"Get filtered reponses",schema:{type:"string"}}],responses:{200:{description:"Event summary page",content:{"application/json":{schema:{type:"object",description:"Paginated list of per-user event summaries.",properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1,"x-oapi-codegen-extra-tags":{json:"pageSize,omitempty"}},totalCount:{type:"integer",description:"Total number of items available.",minimum:0,"x-oapi-codegen-extra-tags":{json:"totalCount,omitempty"}},data:{type:"array",items:{type:"object",description:"Per-user event summary entry.",additionalProperties:true},description:"The event summaries returned on the current page."}}}}}},401:{description:"Unauthorized"},404:{description:"Not found"},500:{description:"Server error"}}}},"/api/events/types":{get:{"x-internal":["cloud"],tags:["events"],operationId:"getEventTypes",summary:"Get event types",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},{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:"integer"}}],responses:{200:{description:"Event types",content:{"application/json":{schema:{type:"array",items:{type:"object",description:"A category/action pair describing one kind of event.",properties:{category:{type:"string",description:"The category of the event type.",maxLength:500},action:{type:"string",description:"The action of the event type.",maxLength:500}}}}}}},401:{description:"Unauthorized"},404:{description:"Not found"},500:{description:"Server error"}}}}},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:{eventId:{name:"eventId",in:"path",description:"ID of the event.",required:true,schema:{type:"string",format:"uuid"}},workspaceId:{name:"workspaceId",in:"path",description:"Workspace ID",schema:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"workspace_id",json:"workspaceId"},"x-go-type-name":"WorkspaceId","x-go-type-skip-optional-pointer":true},required:true},page:{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},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",schema:{type:"integer"}},pagesizeLegacy:{name:"pagesize",in:"query",description:"Get responses by pagesize. Deprecated alias of pageSize.",deprecated:true,schema:{type:"integer"}},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"}},cumulative:{name:"cumulative",in:"query",description:"When true, return cumulative aggregate counts across all time.",required:false,schema:{type:"boolean"}},filter:{name:"filter",in:"query",description:"Get filtered reponses",schema:{type:"string"}},eventsFilter:{name:"filter",in:"query",description:"Get filtered reponses",schema:{type:"string"}}},securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},schemas:{EventPayload:{type:"object",description:"Payload for creating a new event.",additionalProperties:true,properties:{owner:{type:"string",format:"uuid",description:"UUID of the user associated with the event.","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,omitempty"}},category:{type:"string",description:"The category of the event.",maxLength:500},action:{type:"string",description:"The action of the event.",maxLength:500},description:{type:"string",description:"Description of the event.",maxLength:5e3}}},UpdateEventStatusRequest:{type:"object",description:"Payload for updating the status of a single event.",required:["status"],properties:{status:{type:"string",example:"completed",description:"Current status of the event.",maxLength:255}}},UpdateEventStatusResponse:{type:"object",description:"Response body returned after updating an event's status.",properties:{message:{type:"string",description:"Human-readable status message.",maxLength:500},eventId:{type:"string",format:"uuid",description:"UUID of the event whose status was updated.","x-oapi-codegen-extra-tags":{json:"eventId,omitempty"}},status:{type:"string",description:"Updated status of the event.",maxLength:255}}},BulkDeleteRequest:{type:"object",description:"Payload for bulk-deleting events by ID.",required:["ids"],properties:{ids:{type:"array",items:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},description:"UUIDs of the events to delete."}}},BulkDeleteResponse:{type:"object",description:"Response body returned after bulk event deletion.",properties:{deleted:{type:"array",items:{type:"string",format:"uuid"},description:"UUIDs of events that were deleted."}}},BulkUpdateStatusRequest:{type:"object",description:"Payload for bulk-updating the status of events.",required:["ids","status"],properties:{ids:{type:"array",items:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},description:"UUIDs of the events to update."},status:{type:"string",example:"failed",description:"New status to apply to the selected events.",maxLength:255}}},BulkUpdateStatusResponse:{type:"object",description:"Response body returned after bulk event status update.",properties:{updated:{type:"array",items:{type:"string",format:"uuid"},description:"UUIDs of events whose status was updated."}}},EventResult:{type:"object",additionalProperties:false,description:"EventResult entity schema.",properties:{owner:{type:"string",format:"uuid",description:"UUID of the user associated with the event.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"Owner","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"owner",json:"owner"}},systemId:{type:"string",description:"System identifier of the event source.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"system_id",json:"systemId"}},category:{type:"string",description:"The category of the event.",maxLength:500},action:{type:"string",description:"The action of the event.",maxLength:500},description:{type:"string",description:"Description of the event.",maxLength:5e3},firstName:{type:"string",description:"The first name of the user associated with the event.",maxLength:500},lastName:{type:"string",description:"The last name of the user associated with the event.",maxLength:500},email:{description:"Email address of the user associated with the event.",type:"string",format:"email","x-go-type-skip-optional-pointer":true},provider:{description:"Authentication provider of the user associated with the event.",type:"string","x-go-type-skip-optional-pointer":true},createdAt:{type:"string",format:"date-time",description:"Timestamp when the event was recorded.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"}}},required:["owner","category","action"]},EventsPage:{type:"object",description:"Paginated list of events.",properties:{page:{description:"Zero-based page index returned in this response.",type:"integer","x-go-type-skip-optional-pointer":true},pageSize:{description:"Maximum number of items returned on each page.",minimum:1,"x-oapi-codegen-extra-tags":{json:"pageSize,omitempty"},type:"integer","x-go-type-skip-optional-pointer":true},totalCount:{description:"Total number of items across all pages.",minimum:0,"x-oapi-codegen-extra-tags":{json:"totalCount,omitempty"},type:"integer","x-go-type-skip-optional-pointer":true},data:{type:"array",items:{type:"object",additionalProperties:false,description:"EventResult entity schema.",properties:{owner:{type:"string",format:"uuid",description:"UUID of the user associated with the event.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"Owner","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"owner",json:"owner"}},systemId:{type:"string",description:"System identifier of the event source.",maxLength:255,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"system_id",json:"systemId"}},category:{type:"string",description:"The category of the event.",maxLength:500},action:{type:"string",description:"The action of the event.",maxLength:500},description:{type:"string",description:"Description of the event.",maxLength:5e3},firstName:{type:"string",description:"The first name of the user associated with the event.",maxLength:500},lastName:{type:"string",description:"The last name of the user associated with the event.",maxLength:500},email:{description:"Email address of the user associated with the event.",type:"string",format:"email","x-go-type-skip-optional-pointer":true},provider:{description:"Authentication provider of the user associated with the event.",type:"string","x-go-type-skip-optional-pointer":true},createdAt:{type:"string",format:"date-time",description:"Timestamp when the event was recorded.","x-go-type":"time.Time","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"created_at",json:"createdAt"}}},required:["owner","category","action"]},description:"The events returned on the current page."}}},EventsAggregate:{type:"object",description:"Aggregated event counts across categories.",properties:{audit:{type:"integer",description:"Count of audit-category events.",minimum:0}},additionalProperties:true},EventSummary:{type:"object",description:"Per-user event summary entry.",additionalProperties:true},EventSummaryPage:{type:"object",description:"Paginated list of per-user event summaries.",properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1,"x-oapi-codegen-extra-tags":{json:"pageSize,omitempty"}},totalCount:{type:"integer",description:"Total number of items available.",minimum:0,"x-oapi-codegen-extra-tags":{json:"totalCount,omitempty"}},data:{type:"array",items:{type:"object",description:"Per-user event summary entry.",additionalProperties:true},description:"The event summaries returned on the current page."}}},EventType:{type:"object",description:"A category/action pair describing one kind of event.",properties:{category:{type:"string",description:"The category of the event type.",maxLength:500},action:{type:"string",description:"The action of the event type.",maxLength:500}}},ErrorResponse:{type:"object",description:"Generic error envelope returned for non-2xx responses.",properties:{error:{type:"string",description:"Human-readable error message.",maxLength:500}}}}}},t=e;
|
|
2
2
|
export{t as default};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
'use strict';var e={openapi:"3.0.0",info:{title:"Filter",description:"OpenAPI schema for managing Meshery filters. Filters carry an\nopaque body (`filterFile`) plus catalog and visibility metadata,\npersisted by `meshery-cloud` in the `meshery_filters` table and\nconsumed locally by `meshery/server/models.MesheryFilter`.\n\nThe endpoint surface mirrors the live `meshery-cloud` Echo handlers\n(`POST/GET /api/content/filters`,\n`GET/DELETE /api/content/filters/{filterId}`,\n`POST /api/content/filters/clone/{filterId}`,\n`GET /api/content/filters/download/{filterId}`) plus the bulk-delete\nsub-resource and the cross-construct content-share endpoint owned by\nthe design package.\n",version:"v1beta3",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:"filters",description:"Operations related to Meshery filters."}],paths:{"/api/content/filters":{get:{"x-internal":["cloud"],tags:["filters"],summary:"Get filters",operationId:"getFilters",description:"Returns a paginated list of filters accessible to the user.",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer"}},{name:"pageSize",in:"query",description:"Number of items per page (canonical camelCase form).",schema:{type:"integer",minimum:1}},{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:"orgId",in:"query",description:"User's organization ID",schema:{type:"string",format:"uuid"}},{name:"visibility",in:"query",required:false,description:"Filter by visibility (public, private, published). May be repeated.",schema:{type:"array",items:{type:"string"}}},{name:"owner",in:"query",required:false,description:`UUID of the owning user. Pass when fetching public/published
|
|
1
|
+
'use strict';var e={openapi:"3.0.0",info:{title:"Filter",description:"OpenAPI schema for managing Meshery filters. Filters carry an\nopaque body (`filterFile`) plus catalog and visibility metadata,\npersisted by `meshery-cloud` in the `meshery_filters` table and\nconsumed locally by `meshery/server/models.MesheryFilter`.\n\nThe endpoint surface mirrors the live `meshery-cloud` Echo handlers\n(`POST/GET /api/content/filters`,\n`GET/DELETE /api/content/filters/{filterId}`,\n`POST /api/content/filters/clone/{filterId}`,\n`GET /api/content/filters/download/{filterId}`) plus the bulk-delete\nsub-resource and the cross-construct content-share endpoint owned by\nthe design package.\n",version:"v1beta3",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:"filters",description:"Operations related to Meshery filters."}],paths:{"/api/content/filters":{get:{"x-internal":["cloud"],tags:["filters"],summary:"Get filters",operationId:"getFilters",description:"Returns a paginated list of filters accessible to the user.",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},{name:"pageSize",in:"query",description:"Number of items per page (canonical camelCase form).",schema:{type:"integer",minimum:1}},{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:"orgId",in:"query",description:"User's organization ID",schema:{type:"string",format:"uuid"}},{name:"visibility",in:"query",required:false,description:"Filter by visibility (public, private, published). May be repeated.",schema:{type:"array",items:{type:"string"}}},{name:"owner",in:"query",required:false,description:`UUID of the owning user. Pass when fetching public/published
|
|
2
2
|
filters for a specific user (public-profile lookups).
|
|
3
3
|
`,schema:{type:"string",format:"uuid"}}],responses:{200:{description:"Filters response",content:{"application/json":{schema:{type:"object",description:"Paginated collection of filters.",properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1},totalCount:{type:"integer",description:"Total number of items available.",minimum:0},filters:{type:"array",items:{"x-go-type":"MesheryFilter",$schema:"http://json-schema.org/draft-07/schema#",title:"Filter Schema",description:"Server-returned Meshery filter resource as persisted by meshery-cloud\n(`meshery_filters` table) and consumed by meshery's\n`models.MesheryFilter`. Filters carry an opaque body (`filterFile`) plus\ncatalog and visibility metadata, and follow the same content-resource\nshape as designs minus the catalog engagement counters (the\n`meshery_filters` table has no `view_count` / `download_count` columns).\n",type:"object",additionalProperties:false,required:["id","name","owner","createdAt","updatedAt"],properties:{id:{description:"Server-generated filter 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:"Human-readable filter name; required, used for catalog listings.",minLength:1,maxLength:255,"x-order":2},owner:{description:"Owning user ID.","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":3,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},filterFile:{type:"string",format:"byte",description:"Raw filter source persisted as a byte array (`bytea` column\n`filter_file`). Wire form is base64 per OpenAPI `format: byte`.\n",maxLength:10485760,"x-oapi-codegen-extra-tags":{db:"filter_file"},"x-order":4},filterResource:{type:"string",description:`Filter resource discriminator describing the filter body's source
|
|
4
4
|
format (e.g. WASM module identifier or external resource path).
|
|
@@ -45,7 +45,7 @@ server-generated derivative of the source filter's name.
|
|
|
45
45
|
`,minLength:1,maxLength:255}}}}}},responses:{200:{description:"Filter cloned",content:{"application/json":{schema:{$schema:"http://json-schema.org/draft-07/schema#",title:"Filter Schema",description:"Server-returned Meshery filter resource as persisted by meshery-cloud\n(`meshery_filters` table) and consumed by meshery's\n`models.MesheryFilter`. Filters carry an opaque body (`filterFile`) plus\ncatalog and visibility metadata, and follow the same content-resource\nshape as designs minus the catalog engagement counters (the\n`meshery_filters` table has no `view_count` / `download_count` columns).\n",type:"object",additionalProperties:false,required:["id","name","owner","createdAt","updatedAt"],properties:{id:{description:"Server-generated filter 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:"Human-readable filter name; required, used for catalog listings.",minLength:1,maxLength:255,"x-order":2},owner:{description:"Owning user ID.","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":3,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},filterFile:{type:"string",format:"byte",description:"Raw filter source persisted as a byte array (`bytea` column\n`filter_file`). Wire form is base64 per OpenAPI `format: byte`.\n",maxLength:10485760,"x-oapi-codegen-extra-tags":{db:"filter_file"},"x-order":4},filterResource:{type:"string",description:`Filter resource discriminator describing the filter body's source
|
|
46
46
|
format (e.g. WASM module identifier or external resource path).
|
|
47
47
|
Stored in the \`filter_resource\` text column.
|
|
48
|
-
`,maxLength:5e3,"x-oapi-codegen-extra-tags":{db:"filter_resource"},"x-order":5},location:{description:"Optional structured location metadata (branch, host, path, ...).","x-order":6,type:"object",additionalProperties:{type:"string"},"x-go-type-skip-optional-pointer":true},visibility:{description:"Visibility scope (private, public, published).","x-order":7,type:"string",enum:["private","public","published"],"x-go-type-skip-optional-pointer":true},catalogData:{description:"Catalog metadata attached to the filter when published.","x-go-type":"catalogv1alpha2.CatalogData","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha2/catalog",name:"catalogv1alpha2"},"x-oapi-codegen-extra-tags":{db:"catalog_data"},"x-order":8,type:"object",additionalProperties:false,properties:{publishedVersion:{description:"Tracks the specific content version that has been made available in the Catalog.",type:"string",maxLength:500},class:{description:"Published content is classifed by its support level. Content classes help you understand the origin and expected support level for each piece of content. It is important to note that the level of support may vary within each class, and you should exercise discretion when using community-contributed content. Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable. Content produced by partners and verified by Meshery maintainers. While not directly maintained by Meshery, it has undergone a verification process to ensure quality and compatibility. Content produced and supported by the respective project or organization responsible for the specific technology. This class offers a level of support from the project maintainers themselves. Content produced and shared by Meshery users. This includes a wide range of content, such as performance profiles, test results, filters, patterns, and applications. Community content may have varying levels of support and reliability.",type:"string",oneOf:[{const:"official",description:"Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable."},{const:"verified",description:"Content produced by partners and verified by Meshery maintainers. While not directly maintained by Meshery, it has undergone a verification process to ensure quality and compatibility."},{const:"reference architecture",description:"Content produced and shared by Meshery users. This includes a wide range of content, such as performance profiles, test results, filters, patterns, and applications. Reference architecture content may have varying levels of support and reliability."}],maxLength:500},compatibility:{type:"array",title:"Model",items:{enum:["kubernetes"],type:"string"},uniqueItems:true,minItems:1,description:"One or more models associated with this catalog item. For designs, a list of one or more models implicated by components within the design. For models, this is self-referential."},patternCaveats:{type:"string",title:"Caveats and Considerations",description:"Specific stipulations to consider and known behaviors to be aware of when using this design.",maxLength:500},patternInfo:{type:"string",title:"Description",minLength:1,description:"Purpose of the design along with its intended and unintended uses."},type:{type:"string",title:"Type","x-enum-casing-exempt":true,enum:["Deployment","Observability","Resiliency","Scaling","Security","Traffic-management","Troubleshooting","Workloads"],default:"Deployment",description:"Categorization of the type of design or operational flow depicted in this design."},snapshotURL:{type:"array",items:{type:"string",format:"uri",pattern:"^(https?|http?|oci)://"},description:"Contains reference to the dark and light mode snapshots of the design."}},required:["compatibility","patternCaveats","patternInfo","type"]},createdAt:{description:"Timestamp of filter creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last filter modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":10,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},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/content/filters/download/{filterId}":{get:{"x-internal":["cloud"],tags:["filters"],summary:"Download filter file",operationId:"getFilterFile",description:"Downloads the raw filter body associated with the supplied\nfilter ID. The server streams the bytes verbatim with\n`Content-Type: application/wasm` and a\n`Content-Disposition: attachment` header naming the filter.\n",parameters:[{name:"filterId",in:"path",description:"Filter 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:"Filter file content",content:{"application/wasm":{schema:{type:"string",format:"binary"}}}},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:{filterId:{name:"filterId",in:"path",description:"Filter 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:"integer"}},pageSize:{name:"pageSize",in:"query",description:"Number of items per page (canonical camelCase form).",schema:{type:"integer",minimum:1}},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"}},orgIdQuery:{name:"orgId",in:"query",description:"User's organization ID",schema:{type:"string",format:"uuid"}}},schemas:{MesheryFilter:{$schema:"http://json-schema.org/draft-07/schema#",title:"Filter Schema",description:"Server-returned Meshery filter resource as persisted by meshery-cloud\n(`meshery_filters` table) and consumed by meshery's\n`models.MesheryFilter`. Filters carry an opaque body (`filterFile`) plus\ncatalog and visibility metadata, and follow the same content-resource\nshape as designs minus the catalog engagement counters (the\n`meshery_filters` table has no `view_count` / `download_count` columns).\n",type:"object",additionalProperties:false,required:["id","name","owner","createdAt","updatedAt"],properties:{id:{description:"Server-generated filter 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:"Human-readable filter name; required, used for catalog listings.",minLength:1,maxLength:255,"x-order":2},owner:{description:"Owning user ID.","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":3,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},filterFile:{type:"string",format:"byte",description:"Raw filter source persisted as a byte array (`bytea` column\n`filter_file`). Wire form is base64 per OpenAPI `format: byte`.\n",maxLength:10485760,"x-oapi-codegen-extra-tags":{db:"filter_file"},"x-order":4},filterResource:{type:"string",description:`Filter resource discriminator describing the filter body's source
|
|
48
|
+
`,maxLength:5e3,"x-oapi-codegen-extra-tags":{db:"filter_resource"},"x-order":5},location:{description:"Optional structured location metadata (branch, host, path, ...).","x-order":6,type:"object",additionalProperties:{type:"string"},"x-go-type-skip-optional-pointer":true},visibility:{description:"Visibility scope (private, public, published).","x-order":7,type:"string",enum:["private","public","published"],"x-go-type-skip-optional-pointer":true},catalogData:{description:"Catalog metadata attached to the filter when published.","x-go-type":"catalogv1alpha2.CatalogData","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha2/catalog",name:"catalogv1alpha2"},"x-oapi-codegen-extra-tags":{db:"catalog_data"},"x-order":8,type:"object",additionalProperties:false,properties:{publishedVersion:{description:"Tracks the specific content version that has been made available in the Catalog.",type:"string",maxLength:500},class:{description:"Published content is classifed by its support level. Content classes help you understand the origin and expected support level for each piece of content. It is important to note that the level of support may vary within each class, and you should exercise discretion when using community-contributed content. Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable. Content produced by partners and verified by Meshery maintainers. While not directly maintained by Meshery, it has undergone a verification process to ensure quality and compatibility. Content produced and supported by the respective project or organization responsible for the specific technology. This class offers a level of support from the project maintainers themselves. Content produced and shared by Meshery users. This includes a wide range of content, such as performance profiles, test results, filters, patterns, and applications. Community content may have varying levels of support and reliability.",type:"string",oneOf:[{const:"official",description:"Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable."},{const:"verified",description:"Content produced by partners and verified by Meshery maintainers. While not directly maintained by Meshery, it has undergone a verification process to ensure quality and compatibility."},{const:"reference architecture",description:"Content produced and shared by Meshery users. This includes a wide range of content, such as performance profiles, test results, filters, patterns, and applications. Reference architecture content may have varying levels of support and reliability."}],maxLength:500},compatibility:{type:"array",title:"Model",items:{enum:["kubernetes"],type:"string"},uniqueItems:true,minItems:1,description:"One or more models associated with this catalog item. For designs, a list of one or more models implicated by components within the design. For models, this is self-referential."},patternCaveats:{type:"string",title:"Caveats and Considerations",description:"Specific stipulations to consider and known behaviors to be aware of when using this design.",maxLength:500},patternInfo:{type:"string",title:"Description",minLength:1,description:"Purpose of the design along with its intended and unintended uses."},type:{type:"string",title:"Type","x-enum-casing-exempt":true,enum:["Deployment","Observability","Resiliency","Scaling","Security","Traffic-management","Troubleshooting","Workloads"],default:"Deployment",description:"Categorization of the type of design or operational flow depicted in this design."},snapshotURL:{type:"array",items:{type:"string",format:"uri",pattern:"^(https?|http?|oci)://"},description:"Contains reference to the dark and light mode snapshots of the design."}},required:["compatibility","patternCaveats","patternInfo","type"]},createdAt:{description:"Timestamp of filter creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last filter modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":10,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},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/content/filters/download/{filterId}":{get:{"x-internal":["cloud"],tags:["filters"],summary:"Download filter file",operationId:"getFilterFile",description:"Downloads the raw filter body associated with the supplied\nfilter ID. The server streams the bytes verbatim with\n`Content-Type: application/wasm` and a\n`Content-Disposition: attachment` header naming the filter.\n",parameters:[{name:"filterId",in:"path",description:"Filter 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:"Filter file content",content:{"application/wasm":{schema:{type:"string",format:"binary"}}}},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:{filterId:{name:"filterId",in:"path",description:"Filter 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:"integer",minimum:0}},pageSize:{name:"pageSize",in:"query",description:"Number of items per page (canonical camelCase form).",schema:{type:"integer",minimum:1}},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"}},orgIdQuery:{name:"orgId",in:"query",description:"User's organization ID",schema:{type:"string",format:"uuid"}}},schemas:{MesheryFilter:{$schema:"http://json-schema.org/draft-07/schema#",title:"Filter Schema",description:"Server-returned Meshery filter resource as persisted by meshery-cloud\n(`meshery_filters` table) and consumed by meshery's\n`models.MesheryFilter`. Filters carry an opaque body (`filterFile`) plus\ncatalog and visibility metadata, and follow the same content-resource\nshape as designs minus the catalog engagement counters (the\n`meshery_filters` table has no `view_count` / `download_count` columns).\n",type:"object",additionalProperties:false,required:["id","name","owner","createdAt","updatedAt"],properties:{id:{description:"Server-generated filter 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:"Human-readable filter name; required, used for catalog listings.",minLength:1,maxLength:255,"x-order":2},owner:{description:"Owning user ID.","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":3,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},filterFile:{type:"string",format:"byte",description:"Raw filter source persisted as a byte array (`bytea` column\n`filter_file`). Wire form is base64 per OpenAPI `format: byte`.\n",maxLength:10485760,"x-oapi-codegen-extra-tags":{db:"filter_file"},"x-order":4},filterResource:{type:"string",description:`Filter resource discriminator describing the filter body's source
|
|
49
49
|
format (e.g. WASM module identifier or external resource path).
|
|
50
50
|
Stored in the \`filter_resource\` text column.
|
|
51
51
|
`,maxLength:5e3,"x-oapi-codegen-extra-tags":{db:"filter_resource"},"x-order":5},location:{description:"Optional structured location metadata (branch, host, path, ...).","x-order":6,type:"object",additionalProperties:{type:"string"},"x-go-type-skip-optional-pointer":true},visibility:{description:"Visibility scope (private, public, published).","x-order":7,type:"string",enum:["private","public","published"],"x-go-type-skip-optional-pointer":true},catalogData:{description:"Catalog metadata attached to the filter when published.","x-go-type":"catalogv1alpha2.CatalogData","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha2/catalog",name:"catalogv1alpha2"},"x-oapi-codegen-extra-tags":{db:"catalog_data"},"x-order":8,type:"object",additionalProperties:false,properties:{publishedVersion:{description:"Tracks the specific content version that has been made available in the Catalog.",type:"string",maxLength:500},class:{description:"Published content is classifed by its support level. Content classes help you understand the origin and expected support level for each piece of content. It is important to note that the level of support may vary within each class, and you should exercise discretion when using community-contributed content. Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable. Content produced by partners and verified by Meshery maintainers. While not directly maintained by Meshery, it has undergone a verification process to ensure quality and compatibility. Content produced and supported by the respective project or organization responsible for the specific technology. This class offers a level of support from the project maintainers themselves. Content produced and shared by Meshery users. This includes a wide range of content, such as performance profiles, test results, filters, patterns, and applications. Community content may have varying levels of support and reliability.",type:"string",oneOf:[{const:"official",description:"Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable."},{const:"verified",description:"Content produced by partners and verified by Meshery maintainers. While not directly maintained by Meshery, it has undergone a verification process to ensure quality and compatibility."},{const:"reference architecture",description:"Content produced and shared by Meshery users. This includes a wide range of content, such as performance profiles, test results, filters, patterns, and applications. Reference architecture content may have varying levels of support and reliability."}],maxLength:500},compatibility:{type:"array",title:"Model",items:{enum:["kubernetes"],type:"string"},uniqueItems:true,minItems:1,description:"One or more models associated with this catalog item. For designs, a list of one or more models implicated by components within the design. For models, this is self-referential."},patternCaveats:{type:"string",title:"Caveats and Considerations",description:"Specific stipulations to consider and known behaviors to be aware of when using this design.",maxLength:500},patternInfo:{type:"string",title:"Description",minLength:1,description:"Purpose of the design along with its intended and unintended uses."},type:{type:"string",title:"Type","x-enum-casing-exempt":true,enum:["Deployment","Observability","Resiliency","Scaling","Security","Traffic-management","Troubleshooting","Workloads"],default:"Deployment",description:"Categorization of the type of design or operational flow depicted in this design."},snapshotURL:{type:"array",items:{type:"string",format:"uri",pattern:"^(https?|http?|oci)://"},description:"Contains reference to the dark and light mode snapshots of the design."}},required:["compatibility","patternCaveats","patternInfo","type"]},createdAt:{description:"Timestamp of filter creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last filter modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":10,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},MesheryFilterPayload:{type:"object",description:"Payload for creating or updating a filter via\n`POST /api/content/filters` or\n`PUT /api/content/filters/{filterId}`. Contains only\nclient-settable fields; server-generated `createdAt` /\n`updatedAt` and the owning `userId` (which the server derives\nfrom the authenticated session) are intentionally excluded.\n",required:["name"],properties:{id:{description:'Existing filter ID for updates; omit on create. Wrapped in\nan `allOf` so we can attach the `json:"id,omitempty"` tag\nfor upsert ergonomics without recursing into the underlying\nUUID definition.\n',"x-oapi-codegen-extra-tags":{json:"id,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Human-readable filter name.",minLength:1,maxLength:255},filterFile:{type:"string",format:"byte",description:`Raw filter source as base64-encoded bytes (\`format: byte\`).
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
var e={openapi:"3.0.0",info:{title:"Filter",description:"OpenAPI schema for managing Meshery filters. Filters carry an\nopaque body (`filterFile`) plus catalog and visibility metadata,\npersisted by `meshery-cloud` in the `meshery_filters` table and\nconsumed locally by `meshery/server/models.MesheryFilter`.\n\nThe endpoint surface mirrors the live `meshery-cloud` Echo handlers\n(`POST/GET /api/content/filters`,\n`GET/DELETE /api/content/filters/{filterId}`,\n`POST /api/content/filters/clone/{filterId}`,\n`GET /api/content/filters/download/{filterId}`) plus the bulk-delete\nsub-resource and the cross-construct content-share endpoint owned by\nthe design package.\n",version:"v1beta3",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:"filters",description:"Operations related to Meshery filters."}],paths:{"/api/content/filters":{get:{"x-internal":["cloud"],tags:["filters"],summary:"Get filters",operationId:"getFilters",description:"Returns a paginated list of filters accessible to the user.",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer"}},{name:"pageSize",in:"query",description:"Number of items per page (canonical camelCase form).",schema:{type:"integer",minimum:1}},{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:"orgId",in:"query",description:"User's organization ID",schema:{type:"string",format:"uuid"}},{name:"visibility",in:"query",required:false,description:"Filter by visibility (public, private, published). May be repeated.",schema:{type:"array",items:{type:"string"}}},{name:"owner",in:"query",required:false,description:`UUID of the owning user. Pass when fetching public/published
|
|
1
|
+
var e={openapi:"3.0.0",info:{title:"Filter",description:"OpenAPI schema for managing Meshery filters. Filters carry an\nopaque body (`filterFile`) plus catalog and visibility metadata,\npersisted by `meshery-cloud` in the `meshery_filters` table and\nconsumed locally by `meshery/server/models.MesheryFilter`.\n\nThe endpoint surface mirrors the live `meshery-cloud` Echo handlers\n(`POST/GET /api/content/filters`,\n`GET/DELETE /api/content/filters/{filterId}`,\n`POST /api/content/filters/clone/{filterId}`,\n`GET /api/content/filters/download/{filterId}`) plus the bulk-delete\nsub-resource and the cross-construct content-share endpoint owned by\nthe design package.\n",version:"v1beta3",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:"filters",description:"Operations related to Meshery filters."}],paths:{"/api/content/filters":{get:{"x-internal":["cloud"],tags:["filters"],summary:"Get filters",operationId:"getFilters",description:"Returns a paginated list of filters accessible to the user.",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},{name:"pageSize",in:"query",description:"Number of items per page (canonical camelCase form).",schema:{type:"integer",minimum:1}},{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:"orgId",in:"query",description:"User's organization ID",schema:{type:"string",format:"uuid"}},{name:"visibility",in:"query",required:false,description:"Filter by visibility (public, private, published). May be repeated.",schema:{type:"array",items:{type:"string"}}},{name:"owner",in:"query",required:false,description:`UUID of the owning user. Pass when fetching public/published
|
|
2
2
|
filters for a specific user (public-profile lookups).
|
|
3
3
|
`,schema:{type:"string",format:"uuid"}}],responses:{200:{description:"Filters response",content:{"application/json":{schema:{type:"object",description:"Paginated collection of filters.",properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1},totalCount:{type:"integer",description:"Total number of items available.",minimum:0},filters:{type:"array",items:{"x-go-type":"MesheryFilter",$schema:"http://json-schema.org/draft-07/schema#",title:"Filter Schema",description:"Server-returned Meshery filter resource as persisted by meshery-cloud\n(`meshery_filters` table) and consumed by meshery's\n`models.MesheryFilter`. Filters carry an opaque body (`filterFile`) plus\ncatalog and visibility metadata, and follow the same content-resource\nshape as designs minus the catalog engagement counters (the\n`meshery_filters` table has no `view_count` / `download_count` columns).\n",type:"object",additionalProperties:false,required:["id","name","owner","createdAt","updatedAt"],properties:{id:{description:"Server-generated filter 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:"Human-readable filter name; required, used for catalog listings.",minLength:1,maxLength:255,"x-order":2},owner:{description:"Owning user ID.","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":3,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},filterFile:{type:"string",format:"byte",description:"Raw filter source persisted as a byte array (`bytea` column\n`filter_file`). Wire form is base64 per OpenAPI `format: byte`.\n",maxLength:10485760,"x-oapi-codegen-extra-tags":{db:"filter_file"},"x-order":4},filterResource:{type:"string",description:`Filter resource discriminator describing the filter body's source
|
|
4
4
|
format (e.g. WASM module identifier or external resource path).
|
|
@@ -45,7 +45,7 @@ server-generated derivative of the source filter's name.
|
|
|
45
45
|
`,minLength:1,maxLength:255}}}}}},responses:{200:{description:"Filter cloned",content:{"application/json":{schema:{$schema:"http://json-schema.org/draft-07/schema#",title:"Filter Schema",description:"Server-returned Meshery filter resource as persisted by meshery-cloud\n(`meshery_filters` table) and consumed by meshery's\n`models.MesheryFilter`. Filters carry an opaque body (`filterFile`) plus\ncatalog and visibility metadata, and follow the same content-resource\nshape as designs minus the catalog engagement counters (the\n`meshery_filters` table has no `view_count` / `download_count` columns).\n",type:"object",additionalProperties:false,required:["id","name","owner","createdAt","updatedAt"],properties:{id:{description:"Server-generated filter 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:"Human-readable filter name; required, used for catalog listings.",minLength:1,maxLength:255,"x-order":2},owner:{description:"Owning user ID.","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":3,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},filterFile:{type:"string",format:"byte",description:"Raw filter source persisted as a byte array (`bytea` column\n`filter_file`). Wire form is base64 per OpenAPI `format: byte`.\n",maxLength:10485760,"x-oapi-codegen-extra-tags":{db:"filter_file"},"x-order":4},filterResource:{type:"string",description:`Filter resource discriminator describing the filter body's source
|
|
46
46
|
format (e.g. WASM module identifier or external resource path).
|
|
47
47
|
Stored in the \`filter_resource\` text column.
|
|
48
|
-
`,maxLength:5e3,"x-oapi-codegen-extra-tags":{db:"filter_resource"},"x-order":5},location:{description:"Optional structured location metadata (branch, host, path, ...).","x-order":6,type:"object",additionalProperties:{type:"string"},"x-go-type-skip-optional-pointer":true},visibility:{description:"Visibility scope (private, public, published).","x-order":7,type:"string",enum:["private","public","published"],"x-go-type-skip-optional-pointer":true},catalogData:{description:"Catalog metadata attached to the filter when published.","x-go-type":"catalogv1alpha2.CatalogData","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha2/catalog",name:"catalogv1alpha2"},"x-oapi-codegen-extra-tags":{db:"catalog_data"},"x-order":8,type:"object",additionalProperties:false,properties:{publishedVersion:{description:"Tracks the specific content version that has been made available in the Catalog.",type:"string",maxLength:500},class:{description:"Published content is classifed by its support level. Content classes help you understand the origin and expected support level for each piece of content. It is important to note that the level of support may vary within each class, and you should exercise discretion when using community-contributed content. Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable. Content produced by partners and verified by Meshery maintainers. While not directly maintained by Meshery, it has undergone a verification process to ensure quality and compatibility. Content produced and supported by the respective project or organization responsible for the specific technology. This class offers a level of support from the project maintainers themselves. Content produced and shared by Meshery users. This includes a wide range of content, such as performance profiles, test results, filters, patterns, and applications. Community content may have varying levels of support and reliability.",type:"string",oneOf:[{const:"official",description:"Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable."},{const:"verified",description:"Content produced by partners and verified by Meshery maintainers. While not directly maintained by Meshery, it has undergone a verification process to ensure quality and compatibility."},{const:"reference architecture",description:"Content produced and shared by Meshery users. This includes a wide range of content, such as performance profiles, test results, filters, patterns, and applications. Reference architecture content may have varying levels of support and reliability."}],maxLength:500},compatibility:{type:"array",title:"Model",items:{enum:["kubernetes"],type:"string"},uniqueItems:true,minItems:1,description:"One or more models associated with this catalog item. For designs, a list of one or more models implicated by components within the design. For models, this is self-referential."},patternCaveats:{type:"string",title:"Caveats and Considerations",description:"Specific stipulations to consider and known behaviors to be aware of when using this design.",maxLength:500},patternInfo:{type:"string",title:"Description",minLength:1,description:"Purpose of the design along with its intended and unintended uses."},type:{type:"string",title:"Type","x-enum-casing-exempt":true,enum:["Deployment","Observability","Resiliency","Scaling","Security","Traffic-management","Troubleshooting","Workloads"],default:"Deployment",description:"Categorization of the type of design or operational flow depicted in this design."},snapshotURL:{type:"array",items:{type:"string",format:"uri",pattern:"^(https?|http?|oci)://"},description:"Contains reference to the dark and light mode snapshots of the design."}},required:["compatibility","patternCaveats","patternInfo","type"]},createdAt:{description:"Timestamp of filter creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last filter modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":10,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},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/content/filters/download/{filterId}":{get:{"x-internal":["cloud"],tags:["filters"],summary:"Download filter file",operationId:"getFilterFile",description:"Downloads the raw filter body associated with the supplied\nfilter ID. The server streams the bytes verbatim with\n`Content-Type: application/wasm` and a\n`Content-Disposition: attachment` header naming the filter.\n",parameters:[{name:"filterId",in:"path",description:"Filter 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:"Filter file content",content:{"application/wasm":{schema:{type:"string",format:"binary"}}}},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:{filterId:{name:"filterId",in:"path",description:"Filter 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:"integer"}},pageSize:{name:"pageSize",in:"query",description:"Number of items per page (canonical camelCase form).",schema:{type:"integer",minimum:1}},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"}},orgIdQuery:{name:"orgId",in:"query",description:"User's organization ID",schema:{type:"string",format:"uuid"}}},schemas:{MesheryFilter:{$schema:"http://json-schema.org/draft-07/schema#",title:"Filter Schema",description:"Server-returned Meshery filter resource as persisted by meshery-cloud\n(`meshery_filters` table) and consumed by meshery's\n`models.MesheryFilter`. Filters carry an opaque body (`filterFile`) plus\ncatalog and visibility metadata, and follow the same content-resource\nshape as designs minus the catalog engagement counters (the\n`meshery_filters` table has no `view_count` / `download_count` columns).\n",type:"object",additionalProperties:false,required:["id","name","owner","createdAt","updatedAt"],properties:{id:{description:"Server-generated filter 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:"Human-readable filter name; required, used for catalog listings.",minLength:1,maxLength:255,"x-order":2},owner:{description:"Owning user ID.","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":3,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},filterFile:{type:"string",format:"byte",description:"Raw filter source persisted as a byte array (`bytea` column\n`filter_file`). Wire form is base64 per OpenAPI `format: byte`.\n",maxLength:10485760,"x-oapi-codegen-extra-tags":{db:"filter_file"},"x-order":4},filterResource:{type:"string",description:`Filter resource discriminator describing the filter body's source
|
|
48
|
+
`,maxLength:5e3,"x-oapi-codegen-extra-tags":{db:"filter_resource"},"x-order":5},location:{description:"Optional structured location metadata (branch, host, path, ...).","x-order":6,type:"object",additionalProperties:{type:"string"},"x-go-type-skip-optional-pointer":true},visibility:{description:"Visibility scope (private, public, published).","x-order":7,type:"string",enum:["private","public","published"],"x-go-type-skip-optional-pointer":true},catalogData:{description:"Catalog metadata attached to the filter when published.","x-go-type":"catalogv1alpha2.CatalogData","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha2/catalog",name:"catalogv1alpha2"},"x-oapi-codegen-extra-tags":{db:"catalog_data"},"x-order":8,type:"object",additionalProperties:false,properties:{publishedVersion:{description:"Tracks the specific content version that has been made available in the Catalog.",type:"string",maxLength:500},class:{description:"Published content is classifed by its support level. Content classes help you understand the origin and expected support level for each piece of content. It is important to note that the level of support may vary within each class, and you should exercise discretion when using community-contributed content. Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable. Content produced by partners and verified by Meshery maintainers. While not directly maintained by Meshery, it has undergone a verification process to ensure quality and compatibility. Content produced and supported by the respective project or organization responsible for the specific technology. This class offers a level of support from the project maintainers themselves. Content produced and shared by Meshery users. This includes a wide range of content, such as performance profiles, test results, filters, patterns, and applications. Community content may have varying levels of support and reliability.",type:"string",oneOf:[{const:"official",description:"Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable."},{const:"verified",description:"Content produced by partners and verified by Meshery maintainers. While not directly maintained by Meshery, it has undergone a verification process to ensure quality and compatibility."},{const:"reference architecture",description:"Content produced and shared by Meshery users. This includes a wide range of content, such as performance profiles, test results, filters, patterns, and applications. Reference architecture content may have varying levels of support and reliability."}],maxLength:500},compatibility:{type:"array",title:"Model",items:{enum:["kubernetes"],type:"string"},uniqueItems:true,minItems:1,description:"One or more models associated with this catalog item. For designs, a list of one or more models implicated by components within the design. For models, this is self-referential."},patternCaveats:{type:"string",title:"Caveats and Considerations",description:"Specific stipulations to consider and known behaviors to be aware of when using this design.",maxLength:500},patternInfo:{type:"string",title:"Description",minLength:1,description:"Purpose of the design along with its intended and unintended uses."},type:{type:"string",title:"Type","x-enum-casing-exempt":true,enum:["Deployment","Observability","Resiliency","Scaling","Security","Traffic-management","Troubleshooting","Workloads"],default:"Deployment",description:"Categorization of the type of design or operational flow depicted in this design."},snapshotURL:{type:"array",items:{type:"string",format:"uri",pattern:"^(https?|http?|oci)://"},description:"Contains reference to the dark and light mode snapshots of the design."}},required:["compatibility","patternCaveats","patternInfo","type"]},createdAt:{description:"Timestamp of filter creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last filter modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":10,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},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/content/filters/download/{filterId}":{get:{"x-internal":["cloud"],tags:["filters"],summary:"Download filter file",operationId:"getFilterFile",description:"Downloads the raw filter body associated with the supplied\nfilter ID. The server streams the bytes verbatim with\n`Content-Type: application/wasm` and a\n`Content-Disposition: attachment` header naming the filter.\n",parameters:[{name:"filterId",in:"path",description:"Filter 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:"Filter file content",content:{"application/wasm":{schema:{type:"string",format:"binary"}}}},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:{filterId:{name:"filterId",in:"path",description:"Filter 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:"integer",minimum:0}},pageSize:{name:"pageSize",in:"query",description:"Number of items per page (canonical camelCase form).",schema:{type:"integer",minimum:1}},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"}},orgIdQuery:{name:"orgId",in:"query",description:"User's organization ID",schema:{type:"string",format:"uuid"}}},schemas:{MesheryFilter:{$schema:"http://json-schema.org/draft-07/schema#",title:"Filter Schema",description:"Server-returned Meshery filter resource as persisted by meshery-cloud\n(`meshery_filters` table) and consumed by meshery's\n`models.MesheryFilter`. Filters carry an opaque body (`filterFile`) plus\ncatalog and visibility metadata, and follow the same content-resource\nshape as designs minus the catalog engagement counters (the\n`meshery_filters` table has no `view_count` / `download_count` columns).\n",type:"object",additionalProperties:false,required:["id","name","owner","createdAt","updatedAt"],properties:{id:{description:"Server-generated filter 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:"Human-readable filter name; required, used for catalog listings.",minLength:1,maxLength:255,"x-order":2},owner:{description:"Owning user ID.","x-oapi-codegen-extra-tags":{db:"owner",json:"owner"},"x-order":3,type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},filterFile:{type:"string",format:"byte",description:"Raw filter source persisted as a byte array (`bytea` column\n`filter_file`). Wire form is base64 per OpenAPI `format: byte`.\n",maxLength:10485760,"x-oapi-codegen-extra-tags":{db:"filter_file"},"x-order":4},filterResource:{type:"string",description:`Filter resource discriminator describing the filter body's source
|
|
49
49
|
format (e.g. WASM module identifier or external resource path).
|
|
50
50
|
Stored in the \`filter_resource\` text column.
|
|
51
51
|
`,maxLength:5e3,"x-oapi-codegen-extra-tags":{db:"filter_resource"},"x-order":5},location:{description:"Optional structured location metadata (branch, host, path, ...).","x-order":6,type:"object",additionalProperties:{type:"string"},"x-go-type-skip-optional-pointer":true},visibility:{description:"Visibility scope (private, public, published).","x-order":7,type:"string",enum:["private","public","published"],"x-go-type-skip-optional-pointer":true},catalogData:{description:"Catalog metadata attached to the filter when published.","x-go-type":"catalogv1alpha2.CatalogData","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha2/catalog",name:"catalogv1alpha2"},"x-oapi-codegen-extra-tags":{db:"catalog_data"},"x-order":8,type:"object",additionalProperties:false,properties:{publishedVersion:{description:"Tracks the specific content version that has been made available in the Catalog.",type:"string",maxLength:500},class:{description:"Published content is classifed by its support level. Content classes help you understand the origin and expected support level for each piece of content. It is important to note that the level of support may vary within each class, and you should exercise discretion when using community-contributed content. Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable. Content produced by partners and verified by Meshery maintainers. While not directly maintained by Meshery, it has undergone a verification process to ensure quality and compatibility. Content produced and supported by the respective project or organization responsible for the specific technology. This class offers a level of support from the project maintainers themselves. Content produced and shared by Meshery users. This includes a wide range of content, such as performance profiles, test results, filters, patterns, and applications. Community content may have varying levels of support and reliability.",type:"string",oneOf:[{const:"official",description:"Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable."},{const:"verified",description:"Content produced by partners and verified by Meshery maintainers. While not directly maintained by Meshery, it has undergone a verification process to ensure quality and compatibility."},{const:"reference architecture",description:"Content produced and shared by Meshery users. This includes a wide range of content, such as performance profiles, test results, filters, patterns, and applications. Reference architecture content may have varying levels of support and reliability."}],maxLength:500},compatibility:{type:"array",title:"Model",items:{enum:["kubernetes"],type:"string"},uniqueItems:true,minItems:1,description:"One or more models associated with this catalog item. For designs, a list of one or more models implicated by components within the design. For models, this is self-referential."},patternCaveats:{type:"string",title:"Caveats and Considerations",description:"Specific stipulations to consider and known behaviors to be aware of when using this design.",maxLength:500},patternInfo:{type:"string",title:"Description",minLength:1,description:"Purpose of the design along with its intended and unintended uses."},type:{type:"string",title:"Type","x-enum-casing-exempt":true,enum:["Deployment","Observability","Resiliency","Scaling","Security","Traffic-management","Troubleshooting","Workloads"],default:"Deployment",description:"Categorization of the type of design or operational flow depicted in this design."},snapshotURL:{type:"array",items:{type:"string",format:"uri",pattern:"^(https?|http?|oci)://"},description:"Contains reference to the dark and light mode snapshots of the design."}},required:["compatibility","patternCaveats","patternInfo","type"]},createdAt:{description:"Timestamp of filter creation.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":9,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp of last filter modification.","x-oapi-codegen-extra-tags":{db:"updated_at"},"x-order":10,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true}}},MesheryFilterPayload:{type:"object",description:"Payload for creating or updating a filter via\n`POST /api/content/filters` or\n`PUT /api/content/filters/{filterId}`. Contains only\nclient-settable fields; server-generated `createdAt` /\n`updatedAt` and the owning `userId` (which the server derives\nfrom the authenticated session) are intentionally excluded.\n",required:["name"],properties:{id:{description:'Existing filter ID for updates; omit on create. Wrapped in\nan `allOf` so we can attach the `json:"id,omitempty"` tag\nfor upsert ergonomics without recursing into the underlying\nUUID definition.\n',"x-oapi-codegen-extra-tags":{json:"id,omitempty"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Human-readable filter name.",minLength:1,maxLength:255},filterFile:{type:"string",format:"byte",description:`Raw filter source as base64-encoded bytes (\`format: byte\`).
|