@meshery/schemas 1.3.96 → 1.3.98
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 +1246 -1458
- package/dist/cloudApi.d.ts +1246 -1458
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta2/organization/Organization.d.ts +1 -1
- package/dist/constructs/v1beta2/organization/OrganizationSchema.js +1 -1
- package/dist/constructs/v1beta2/organization/OrganizationSchema.mjs +1 -1
- package/dist/constructs/v1beta3/claim/Claim.d.ts +492 -80
- package/dist/constructs/v1beta3/claim/ClaimSchema.js +25 -84
- package/dist/constructs/v1beta3/claim/ClaimSchema.mjs +25 -84
- package/dist/constructs/v1beta3/connection/Connection.d.ts +171 -0
- package/dist/constructs/v1beta3/connection/ConnectionSchema.js +2 -2
- package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +2 -2
- package/dist/constructs/v1beta3/content_item/ContentItem.d.ts +30 -0
- package/dist/constructs/v1beta3/content_item/ContentItemSchema.js +12 -6
- package/dist/constructs/v1beta3/content_item/ContentItemSchema.mjs +12 -6
- package/dist/constructs/v1beta3/content_metrics/ContentMetrics.d.ts +151 -0
- package/dist/constructs/v1beta3/content_metrics/ContentMetrics.js +1 -0
- package/dist/constructs/v1beta3/content_metrics/ContentMetrics.mjs +0 -0
- package/dist/constructs/v1beta3/content_metrics/ContentMetricsSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/content_metrics/ContentMetricsSchema.js +16 -0
- package/dist/constructs/v1beta3/content_metrics/ContentMetricsSchema.mjs +16 -0
- package/dist/constructs/v1beta3/design/Design.d.ts +2 -2
- package/dist/constructs/v1beta3/design/DesignSchema.js +2 -2
- package/dist/constructs/v1beta3/design/DesignSchema.mjs +2 -2
- package/dist/constructs/v1beta3/event/Event.d.ts +7 -7
- package/dist/constructs/v1beta3/event/EventSchema.js +5 -2
- package/dist/constructs/v1beta3/event/EventSchema.mjs +5 -2
- package/dist/constructs/v1beta3/follower_demographics/FollowerDemographics.d.ts +94 -0
- package/dist/constructs/v1beta3/follower_demographics/FollowerDemographics.js +1 -0
- package/dist/constructs/v1beta3/follower_demographics/FollowerDemographics.mjs +0 -0
- package/dist/constructs/v1beta3/follower_demographics/FollowerDemographicsSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/follower_demographics/FollowerDemographicsSchema.js +25 -0
- package/dist/constructs/v1beta3/follower_demographics/FollowerDemographicsSchema.mjs +25 -0
- package/dist/constructs/v1beta3/follower_metrics/FollowerMetrics.d.ts +90 -0
- package/dist/constructs/v1beta3/follower_metrics/FollowerMetrics.js +1 -0
- package/dist/constructs/v1beta3/follower_metrics/FollowerMetrics.mjs +0 -0
- package/dist/constructs/v1beta3/follower_metrics/FollowerMetricsSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/follower_metrics/FollowerMetricsSchema.js +16 -0
- package/dist/constructs/v1beta3/follower_metrics/FollowerMetricsSchema.mjs +16 -0
- package/dist/constructs/v1beta3/ledger/Ledger.d.ts +157 -11
- package/dist/constructs/v1beta3/ledger/LedgerSchema.js +19 -27
- package/dist/constructs/v1beta3/ledger/LedgerSchema.mjs +19 -27
- package/dist/constructs/v1beta3/schedule/Schedule.d.ts +1342 -1586
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.js +10 -34
- package/dist/constructs/v1beta3/schedule/ScheduleSchema.mjs +10 -34
- package/dist/constructs/v1beta3/token/Token.d.ts +17 -77
- package/dist/constructs/v1beta3/token/TokenSchema.js +3 -3
- package/dist/constructs/v1beta3/token/TokenSchema.mjs +3 -3
- package/dist/index.d.mts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/mesheryApi.d.mts +4 -2
- package/dist/mesheryApi.d.ts +4 -2
- package/package.json +1 -1
|
@@ -1,2 +1,5 @@
|
|
|
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:{"/api/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"}}}}}}},"/api/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"}}}}}}},"/api/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"}}}}}}},"/api/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"},403:{description:"Forbidden",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},404:{description:"Not found - the caller is not a provider-wide Provider Admin",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Server error"}}},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},idempotencyKey:{type:"string",description:"Optional client-chosen key that makes recording this event safe to retry. Keys are scoped to the authenticated caller (organization and user), never to the client-settable `owner` field, so `owner` may be omitted without affecting deduplication. The first event a caller records with a key is kept, and a later create with the same key records nothing and answers 200 with that event, whatever the rest of the payload says. Use a value that names the occurrence, for example a run id, so a client replaying a local queue after a timeout never records a duplicate. Omit it for events that need no deduplication.\n",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{json:"idempotencyKey,omitempty"}}}}}}},description:"Records an event and answers 201 with it. When the payload carries an `idempotencyKey` the authenticated caller already used, nothing new is recorded and the answer is 200 with the event first recorded under that key.\n",responses:{200:{description:"An event with this `idempotencyKey` was already recorded by the same caller; it is returned unchanged and no new event is recorded.\n",content:{"application/json":{schema:{type:"object",description:"One recorded event (an `event_trackers` row) in the wire form MeshKit's `models/events.Event` serializes. Meshery Cloud returns these, for example, as the per-path failure records of a GitHub repository import (`importGithubRepository`, `errors`). Unlike EventResult, it carries no joined user profile fields.\n",required:["id","actedUpon","action","category","description","metadata","operationId","severity","status","systemId","createdAt","updatedAt"],properties:{id:{description:"Event ID.","x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},actedUpon:{description:"ID of the entity on which the event was performed.","x-oapi-codegen-extra-tags":{db:"acted_upon"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},action:{type:"string",description:"Action taken on the resource, for example `import`.",maxLength:500,"x-oapi-codegen-extra-tags":{db:"action"}},category:{type:"string",description:"Resource kind the operation was invoked on, for example `pattern`.",maxLength:500,"x-oapi-codegen-extra-tags":{db:"category"}},description:{type:"string",description:"Human-readable summary of what happened.",maxLength:5e3,"x-oapi-codegen-extra-tags":{db:"description"}},metadata:{type:"object",description:"Event-specific details; the structure varies by event kind. `null` when the producer attached none.\n",additionalProperties:true,nullable:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"metadata"}},operationId:{description:"ID correlating the events one operation emitted.","x-go-name":"OperationID","x-oapi-codegen-extra-tags":{db:"operation_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},severity:{type:"string",description:"Event level. MeshKit's producers set one of `emergency`, `alert`, `critical`, `error`, `warning`, `informational`, `debug` or `success`. The set is not closed on the wire - the event write APIs persist the value they are given - so consumers must tolerate other values.\n",maxLength:255,"x-oapi-codegen-extra-tags":{db:"severity"}},status:{type:"string",description:"Read state of the event. MeshKit records new events as `unread`, and acknowledged ones become `read`; the event status APIs persist any value they are given, so consumers must tolerate other values.\n",maxLength:255,"x-oapi-codegen-extra-tags":{db:"status"}},systemId:{description:"ID of the system instance that emitted the event.",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"system_id"},"x-go-name":"SystemID","x-go-type-skip-optional-pointer":true},owner:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"owner"}},createdAt:{description:"Timestamp when the event was recorded.","x-oapi-codegen-extra-tags":{db:"created_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the event was last updated.","x-oapi-codegen-extra-tags":{db:"updated_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{description:"Timestamp when the event was soft-deleted; omitted when it was not.","x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time",nullable:true,"x-go-type-skip-optional-pointer":true}}}}}},201:{description:"Event created",content:{"application/json":{schema:{type:"object",description:"One recorded event (an `event_trackers` row) in the wire form MeshKit's `models/events.Event` serializes. Meshery Cloud returns these, for example, as the per-path failure records of a GitHub repository import (`importGithubRepository`, `errors`). Unlike EventResult, it carries no joined user profile fields.\n",required:["id","actedUpon","action","category","description","metadata","operationId","severity","status","systemId","createdAt","updatedAt"],properties:{id:{description:"Event ID.","x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},actedUpon:{description:"ID of the entity on which the event was performed.","x-oapi-codegen-extra-tags":{db:"acted_upon"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},action:{type:"string",description:"Action taken on the resource, for example `import`.",maxLength:500,"x-oapi-codegen-extra-tags":{db:"action"}},category:{type:"string",description:"Resource kind the operation was invoked on, for example `pattern`.",maxLength:500,"x-oapi-codegen-extra-tags":{db:"category"}},description:{type:"string",description:"Human-readable summary of what happened.",maxLength:5e3,"x-oapi-codegen-extra-tags":{db:"description"}},metadata:{type:"object",description:"Event-specific details; the structure varies by event kind. `null` when the producer attached none.\n",additionalProperties:true,nullable:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"metadata"}},operationId:{description:"ID correlating the events one operation emitted.","x-go-name":"OperationID","x-oapi-codegen-extra-tags":{db:"operation_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},severity:{type:"string",description:"Event level. MeshKit's producers set one of `emergency`, `alert`, `critical`, `error`, `warning`, `informational`, `debug` or `success`. The set is not closed on the wire - the event write APIs persist the value they are given - so consumers must tolerate other values.\n",maxLength:255,"x-oapi-codegen-extra-tags":{db:"severity"}},status:{type:"string",description:"Read state of the event. MeshKit records new events as `unread`, and acknowledged ones become `read`; the event status APIs persist any value they are given, so consumers must tolerate other values.\n",maxLength:255,"x-oapi-codegen-extra-tags":{db:"status"}},systemId:{description:"ID of the system instance that emitted the event.",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"system_id"},"x-go-name":"SystemID","x-go-type-skip-optional-pointer":true},owner:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"owner"}},createdAt:{description:"Timestamp when the event was recorded.","x-oapi-codegen-extra-tags":{db:"created_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the event was last updated.","x-oapi-codegen-extra-tags":{db:"updated_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{description:"Timestamp when the event was soft-deleted; omitted when it was not.","x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time",nullable:true,"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"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/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"}}}},MeshkitError403:{description:"Forbidden",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{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},idempotencyKey:{type:"string",description:"Optional client-chosen key that makes recording this event safe to retry. Keys are scoped to the authenticated caller (organization and user), never to the client-settable `owner` field, so `owner` may be omitted without affecting deduplication. The first event a caller records with a key is kept, and a later create with the same key records nothing and answers 200 with that event, whatever the rest of the payload says. Use a value that names the occurrence, for example a run id, so a client replaying a local queue after a timeout never records a duplicate. Omit it for events that need no deduplication.\n",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{json:"idempotencyKey,omitempty"}}}},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"]},Event:{type:"object",description:"One recorded event (an `event_trackers` row) in the wire form MeshKit's `models/events.Event` serializes. Meshery Cloud returns these, for example, as the per-path failure records of a GitHub repository import (`importGithubRepository`, `errors`). Unlike EventResult, it carries no joined user profile fields.\n",required:["id","actedUpon","action","category","description","metadata","operationId","severity","status","systemId","createdAt","updatedAt"],properties:{id:{description:"Event ID.","x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},actedUpon:{description:"ID of the entity on which the event was performed.","x-oapi-codegen-extra-tags":{db:"acted_upon"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},action:{type:"string",description:"Action taken on the resource, for example `import`.",maxLength:500,"x-oapi-codegen-extra-tags":{db:"action"}},category:{type:"string",description:"Resource kind the operation was invoked on, for example `pattern`.",maxLength:500,"x-oapi-codegen-extra-tags":{db:"category"}},description:{type:"string",description:"Human-readable summary of what happened.",maxLength:5e3,"x-oapi-codegen-extra-tags":{db:"description"}},metadata:{type:"object",description:"Event-specific details; the structure varies by event kind. `null` when the producer attached none.\n",additionalProperties:true,nullable:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"metadata"}},operationId:{description:"ID correlating the events one operation emitted.","x-go-name":"OperationID","x-oapi-codegen-extra-tags":{db:"operation_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},severity:{type:"string",description:"Event level. MeshKit's producers set one of `emergency`, `alert`, `critical`, `error`, `warning`, `informational`, `debug` or `success`. The set is not closed on the wire - the event write APIs persist the value they are given - so consumers must tolerate other values.\n",maxLength:255,"x-oapi-codegen-extra-tags":{db:"severity"}},status:{type:"string",description:"Read state of the event. MeshKit records new events as `unread`, and acknowledged ones become `read`; the event status APIs persist any value they are given, so consumers must tolerate other values.\n",maxLength:255,"x-oapi-codegen-extra-tags":{db:"status"}},systemId:{description:"ID of the system instance that emitted the event.",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"system_id"},"x-go-name":"SystemID","x-go-type-skip-optional-pointer":true},owner:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"owner"}},createdAt:{description:"Timestamp when the event was recorded.","x-oapi-codegen-extra-tags":{db:"created_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the event was last updated.","x-oapi-codegen-extra-tags":{db:"updated_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{description:"Timestamp when the event was soft-deleted; omitted when it was not.","x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time",nullable:true,"x-go-type-skip-optional-pointer":true}}},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
|
-
export{t as default};
|
|
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:{"/api/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"}}}}}}},"/api/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"}}}}}}},"/api/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"}}}}}}},"/api/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: a Meshery Server instance ID, the nil UUID for an event the provider emits itself, or the connection ID of the client machine that emitted it (for example a desktop client recording a run). Asserted by the sender, not checked.
|
|
2
|
+
`,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"},403:{description:"Forbidden",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{type:"string"}}}}}}},404:{description:"Not found - the caller is not a provider-wide Provider Admin",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Server error"}}},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},idempotencyKey:{type:"string",description:"Optional client-chosen key that makes recording this event safe to retry. Keys are scoped to the authenticated caller (organization and user), never to the client-settable `owner` field, so `owner` may be omitted without affecting deduplication. The first event a caller records with a key is kept, and a later create with the same key records nothing and answers 200 with that event, whatever the rest of the payload says. Use a value that names the occurrence, for example a run id, so a client replaying a local queue after a timeout never records a duplicate. Omit it for events that need no deduplication.\n",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{json:"idempotencyKey,omitempty"}}}}}}},description:"Records an event and answers 201 with it. When the payload carries an `idempotencyKey` the authenticated caller already used, nothing new is recorded and the answer is 200 with the event first recorded under that key.\n",responses:{200:{description:"An event with this `idempotencyKey` was already recorded by the same caller; it is returned unchanged and no new event is recorded.\n",content:{"application/json":{schema:{type:"object",description:"One recorded event (an `event_trackers` row) in the wire form MeshKit's `models/events.Event` serializes. Meshery Cloud returns these, for example, as the per-path failure records of a GitHub repository import (`importGithubRepository`, `errors`). Unlike EventResult, it carries no joined user profile fields.\n",required:["id","actedUpon","action","category","description","metadata","operationId","severity","status","systemId","createdAt","updatedAt"],properties:{id:{description:"Event ID.","x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},actedUpon:{description:"ID of the entity on which the event was performed.","x-oapi-codegen-extra-tags":{db:"acted_upon"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},action:{type:"string",description:"Action taken on the resource, for example `import`.",maxLength:500,"x-oapi-codegen-extra-tags":{db:"action"}},category:{type:"string",description:"Resource kind the operation was invoked on, for example `pattern`.",maxLength:500,"x-oapi-codegen-extra-tags":{db:"category"}},description:{type:"string",description:"Human-readable summary of what happened.",maxLength:5e3,"x-oapi-codegen-extra-tags":{db:"description"}},metadata:{type:"object",description:"Event-specific details; the structure varies by event kind. `null` when the producer attached none.\n",additionalProperties:true,nullable:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"metadata"}},operationId:{description:"ID correlating the events one operation emitted.","x-go-name":"OperationID","x-oapi-codegen-extra-tags":{db:"operation_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},severity:{type:"string",description:"Event level. MeshKit's producers set one of `emergency`, `alert`, `critical`, `error`, `warning`, `informational`, `debug` or `success`. The set is not closed on the wire - the event write APIs persist the value they are given - so consumers must tolerate other values.\n",maxLength:255,"x-oapi-codegen-extra-tags":{db:"severity"}},status:{type:"string",description:"Read state of the event. MeshKit records new events as `unread`, and acknowledged ones become `read`; the event status APIs persist any value they are given, so consumers must tolerate other values.\n",maxLength:255,"x-oapi-codegen-extra-tags":{db:"status"}},systemId:{description:"ID of the system instance that emitted the event. A Meshery Server sends its server instance ID; an event the provider emits itself carries the nil UUID. A client that registered a connection for its machine (for example a desktop client) sets its connection ID, so an event that records a run names the computer that ran it and can be joined to the claim it released (`Claim.outcomeEventId`) and to the connection (`connections.id`). The value is asserted by the sender and is not checked against the caller's connections.\n",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"system_id"},"x-go-name":"SystemID","x-go-type-skip-optional-pointer":true},owner:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"owner"}},createdAt:{description:"Timestamp when the event was recorded.","x-oapi-codegen-extra-tags":{db:"created_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the event was last updated.","x-oapi-codegen-extra-tags":{db:"updated_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{description:"Timestamp when the event was soft-deleted; omitted when it was not.","x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time",nullable:true,"x-go-type-skip-optional-pointer":true}}}}}},201:{description:"Event created",content:{"application/json":{schema:{type:"object",description:"One recorded event (an `event_trackers` row) in the wire form MeshKit's `models/events.Event` serializes. Meshery Cloud returns these, for example, as the per-path failure records of a GitHub repository import (`importGithubRepository`, `errors`). Unlike EventResult, it carries no joined user profile fields.\n",required:["id","actedUpon","action","category","description","metadata","operationId","severity","status","systemId","createdAt","updatedAt"],properties:{id:{description:"Event ID.","x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},actedUpon:{description:"ID of the entity on which the event was performed.","x-oapi-codegen-extra-tags":{db:"acted_upon"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},action:{type:"string",description:"Action taken on the resource, for example `import`.",maxLength:500,"x-oapi-codegen-extra-tags":{db:"action"}},category:{type:"string",description:"Resource kind the operation was invoked on, for example `pattern`.",maxLength:500,"x-oapi-codegen-extra-tags":{db:"category"}},description:{type:"string",description:"Human-readable summary of what happened.",maxLength:5e3,"x-oapi-codegen-extra-tags":{db:"description"}},metadata:{type:"object",description:"Event-specific details; the structure varies by event kind. `null` when the producer attached none.\n",additionalProperties:true,nullable:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"metadata"}},operationId:{description:"ID correlating the events one operation emitted.","x-go-name":"OperationID","x-oapi-codegen-extra-tags":{db:"operation_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},severity:{type:"string",description:"Event level. MeshKit's producers set one of `emergency`, `alert`, `critical`, `error`, `warning`, `informational`, `debug` or `success`. The set is not closed on the wire - the event write APIs persist the value they are given - so consumers must tolerate other values.\n",maxLength:255,"x-oapi-codegen-extra-tags":{db:"severity"}},status:{type:"string",description:"Read state of the event. MeshKit records new events as `unread`, and acknowledged ones become `read`; the event status APIs persist any value they are given, so consumers must tolerate other values.\n",maxLength:255,"x-oapi-codegen-extra-tags":{db:"status"}},systemId:{description:"ID of the system instance that emitted the event. A Meshery Server sends its server instance ID; an event the provider emits itself carries the nil UUID. A client that registered a connection for its machine (for example a desktop client) sets its connection ID, so an event that records a run names the computer that ran it and can be joined to the claim it released (`Claim.outcomeEventId`) and to the connection (`connections.id`). The value is asserted by the sender and is not checked against the caller's connections.\n",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"system_id"},"x-go-name":"SystemID","x-go-type-skip-optional-pointer":true},owner:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"owner"}},createdAt:{description:"Timestamp when the event was recorded.","x-oapi-codegen-extra-tags":{db:"created_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the event was last updated.","x-oapi-codegen-extra-tags":{db:"updated_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{description:"Timestamp when the event was soft-deleted; omitted when it was not.","x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time",nullable:true,"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"}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/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: a Meshery Server instance ID, the nil UUID for an event the provider emits itself, or the connection ID of the client machine that emitted it (for example a desktop client recording a run). Asserted by the sender, not checked.
|
|
3
|
+
`,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"}}}},MeshkitError403:{description:"Forbidden",content:{"application/json":{schema:{type:"object",description:"A MeshKit error answered as a JSON body. `error` is the sentence the caller is shown; MeshKit's long description is never serialized. Use the `MeshkitError400`, `MeshkitError403`, `MeshkitError404`, `MeshkitError409`, `MeshkitError500` and `MeshkitError502` responses for an operation whose server answers its refusals this way.",required:["error"],additionalProperties:false,properties:{error:{type:"string",minLength:1,description:"The sentence the caller is shown."},code:{type:"string",minLength:1,description:"MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error."},severity:{type:"string",description:"MeshKit severity name. Omitted when MeshKit reports none.",enum:["emergency","alert","critical","fatal"]},probableCause:{type:"array",description:"MeshKit's probable causes of the error.",items:{type:"string"}},suggestedRemediation:{type:"array",description:"MeshKit's suggested remediations for the error.",items:{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},idempotencyKey:{type:"string",description:"Optional client-chosen key that makes recording this event safe to retry. Keys are scoped to the authenticated caller (organization and user), never to the client-settable `owner` field, so `owner` may be omitted without affecting deduplication. The first event a caller records with a key is kept, and a later create with the same key records nothing and answers 200 with that event, whatever the rest of the payload says. Use a value that names the occurrence, for example a run id, so a client replaying a local queue after a timeout never records a duplicate. Omit it for events that need no deduplication.\n",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{json:"idempotencyKey,omitempty"}}}},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: a Meshery Server instance ID, the nil UUID for an event the provider emits itself, or the connection ID of the client machine that emitted it (for example a desktop client recording a run). Asserted by the sender, not checked.
|
|
4
|
+
`,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"]},Event:{type:"object",description:"One recorded event (an `event_trackers` row) in the wire form MeshKit's `models/events.Event` serializes. Meshery Cloud returns these, for example, as the per-path failure records of a GitHub repository import (`importGithubRepository`, `errors`). Unlike EventResult, it carries no joined user profile fields.\n",required:["id","actedUpon","action","category","description","metadata","operationId","severity","status","systemId","createdAt","updatedAt"],properties:{id:{description:"Event ID.","x-oapi-codegen-extra-tags":{db:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},actedUpon:{description:"ID of the entity on which the event was performed.","x-oapi-codegen-extra-tags":{db:"acted_upon"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},action:{type:"string",description:"Action taken on the resource, for example `import`.",maxLength:500,"x-oapi-codegen-extra-tags":{db:"action"}},category:{type:"string",description:"Resource kind the operation was invoked on, for example `pattern`.",maxLength:500,"x-oapi-codegen-extra-tags":{db:"category"}},description:{type:"string",description:"Human-readable summary of what happened.",maxLength:5e3,"x-oapi-codegen-extra-tags":{db:"description"}},metadata:{type:"object",description:"Event-specific details; the structure varies by event kind. `null` when the producer attached none.\n",additionalProperties:true,nullable:true,"x-go-type":"core.Map","x-go-type-import":{path:"github.com/meshery/schemas/models/core"},"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"metadata"}},operationId:{description:"ID correlating the events one operation emitted.","x-go-name":"OperationID","x-oapi-codegen-extra-tags":{db:"operation_id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},severity:{type:"string",description:"Event level. MeshKit's producers set one of `emergency`, `alert`, `critical`, `error`, `warning`, `informational`, `debug` or `success`. The set is not closed on the wire - the event write APIs persist the value they are given - so consumers must tolerate other values.\n",maxLength:255,"x-oapi-codegen-extra-tags":{db:"severity"}},status:{type:"string",description:"Read state of the event. MeshKit records new events as `unread`, and acknowledged ones become `read`; the event status APIs persist any value they are given, so consumers must tolerate other values.\n",maxLength:255,"x-oapi-codegen-extra-tags":{db:"status"}},systemId:{description:"ID of the system instance that emitted the event. A Meshery Server sends its server instance ID; an event the provider emits itself carries the nil UUID. A client that registered a connection for its machine (for example a desktop client) sets its connection ID, so an event that records a run names the computer that ran it and can be joined to the claim it released (`Claim.outcomeEventId`) and to the connection (`connections.id`). The value is asserted by the sender and is not checked against the caller's connections.\n",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"system_id"},"x-go-name":"SystemID","x-go-type-skip-optional-pointer":true},owner:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"owner"}},createdAt:{description:"Timestamp when the event was recorded.","x-oapi-codegen-extra-tags":{db:"created_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},updatedAt:{description:"Timestamp when the event was last updated.","x-oapi-codegen-extra-tags":{db:"updated_at"},type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},deletedAt:{description:"Timestamp when the event was soft-deleted; omitted when it was not.","x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-go-type":"meshcore.NullTime","x-go-type-import":{name:"meshcore",path:"github.com/meshery/schemas/models/core"},type:"string",format:"date-time",nullable:true,"x-go-type-skip-optional-pointer":true}}},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: a Meshery Server instance ID, the nil UUID for an event the provider emits itself, or the connection ID of the client machine that emitted it (for example a desktop client recording a run). Asserted by the sender, not checked.
|
|
5
|
+
`,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;export{t as default};
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
export type paths = Record<string, never>;
|
|
7
|
+
export type webhooks = Record<string, never>;
|
|
8
|
+
export interface components {
|
|
9
|
+
schemas: {
|
|
10
|
+
/**
|
|
11
|
+
* Follower Demographics Schema
|
|
12
|
+
* @description Server-returned follower-breakdown snapshot row for one page, as
|
|
13
|
+
* recorded in the `metadata` of an event on the events service (category
|
|
14
|
+
* `blowhorn`, action `follower_demographics`); the event construct carries
|
|
15
|
+
* the envelope and this construct names the metadata's own shape, which
|
|
16
|
+
* Event leaves open. One row is one category of one breakdown of one page
|
|
17
|
+
* on one day, keyed by (organizationId, platform, subject, readingDate,
|
|
18
|
+
* dimension, category): the page's follower total on that snapshot day
|
|
19
|
+
* falls into exactly one category of each dimension, so a dimension's
|
|
20
|
+
* categories sum to the page's total. `followers` is a cumulative count
|
|
21
|
+
* on the day, not a daily change, and is nullable: a blank figure in the
|
|
22
|
+
* source export is not a zero.
|
|
23
|
+
*/
|
|
24
|
+
FollowerDemographics: {
|
|
25
|
+
/**
|
|
26
|
+
* Format: uuid
|
|
27
|
+
* @description Owning organization ID.
|
|
28
|
+
*/
|
|
29
|
+
organizationId: string;
|
|
30
|
+
/** @description The platform the page belongs to (today only `linkedin` produces these exports). */
|
|
31
|
+
platform: string;
|
|
32
|
+
/** @description The page the figures describe, named as the source export names it. */
|
|
33
|
+
subject: string;
|
|
34
|
+
/**
|
|
35
|
+
* Format: date
|
|
36
|
+
* @description The day the snapshot describes, as an ISO calendar date.
|
|
37
|
+
*/
|
|
38
|
+
readingDate: string;
|
|
39
|
+
/**
|
|
40
|
+
* @description The breakdown the category belongs to; one value per breakdown sheet the source export carries.
|
|
41
|
+
* @enum {string}
|
|
42
|
+
*/
|
|
43
|
+
dimension: "location" | "job_function" | "seniority" | "industry" | "company_size";
|
|
44
|
+
/** @description The breakdown row's label, verbatim from the source export (e.g. a location or an industry name). */
|
|
45
|
+
category: string;
|
|
46
|
+
/** @description The page's cumulative followers in this category on the snapshot day; null when the export's cell is blank. */
|
|
47
|
+
followers?: number | null;
|
|
48
|
+
/** @description The export file the row was read from; empty when the row did not come from a file export. */
|
|
49
|
+
sourceFile?: string;
|
|
50
|
+
};
|
|
51
|
+
/**
|
|
52
|
+
* @description Payload for recording one follower-breakdown snapshot row for a
|
|
53
|
+
* page, sent as the `metadata` of a create-event call. Contains
|
|
54
|
+
* only client-settable fields; the row has no server-generated
|
|
55
|
+
* fields, because the events service stores and returns event
|
|
56
|
+
* metadata verbatim, so the payload and the recorded row
|
|
57
|
+
* (FollowerDemographics) share one field set.
|
|
58
|
+
*/
|
|
59
|
+
FollowerDemographicsPayload: {
|
|
60
|
+
/**
|
|
61
|
+
* Format: uuid
|
|
62
|
+
* @description Owning organization ID.
|
|
63
|
+
*/
|
|
64
|
+
organizationId: string;
|
|
65
|
+
/** @description The platform the page belongs to (today only `linkedin` produces these exports). */
|
|
66
|
+
platform: string;
|
|
67
|
+
/** @description The page the figures describe, named as the source export names it. */
|
|
68
|
+
subject: string;
|
|
69
|
+
/**
|
|
70
|
+
* Format: date
|
|
71
|
+
* @description The day the snapshot describes, as an ISO calendar date.
|
|
72
|
+
*/
|
|
73
|
+
readingDate: string;
|
|
74
|
+
/**
|
|
75
|
+
* @description The breakdown the category belongs to; one value per breakdown sheet the source export carries.
|
|
76
|
+
* @enum {string}
|
|
77
|
+
*/
|
|
78
|
+
dimension: "location" | "job_function" | "seniority" | "industry" | "company_size";
|
|
79
|
+
/** @description The breakdown row's label, verbatim from the source export (e.g. a location or an industry name). */
|
|
80
|
+
category: string;
|
|
81
|
+
/** @description The page's cumulative followers in this category on the snapshot day; null when the export's cell is blank. */
|
|
82
|
+
followers?: number | null;
|
|
83
|
+
/** @description The export file the row was read from; empty when the row did not come from a file export. */
|
|
84
|
+
sourceFile?: string;
|
|
85
|
+
};
|
|
86
|
+
};
|
|
87
|
+
responses: never;
|
|
88
|
+
parameters: never;
|
|
89
|
+
requestBodies: never;
|
|
90
|
+
headers: never;
|
|
91
|
+
pathItems: never;
|
|
92
|
+
}
|
|
93
|
+
export type $defs = Record<string, never>;
|
|
94
|
+
export type operations = Record<string, never>;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
'use strict';
|
|
File without changes
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
'use strict';var e={openapi:"3.0.0",info:{title:"Follower Demographics",description:`OpenAPI schema for follower-breakdown snapshot rows for a page,
|
|
2
|
+
consumed by Blowhorn's analytics store. The rows have no endpoints
|
|
3
|
+
of their own: they are recorded and read back as the \`metadata\` of
|
|
4
|
+
events on the events service (category \`blowhorn\`, action
|
|
5
|
+
\`follower_demographics\`; see the event construct), so this file
|
|
6
|
+
declares the components only and the paths stay with the event
|
|
7
|
+
construct.
|
|
8
|
+
`,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"}},paths:{},components:{securitySchemes:{jwt:{type:"http",scheme:"Bearer [REDACTED]",bearerFormat:"JWT"}},schemas:{FollowerDemographics:{$schema:"http://json-schema.org/draft-07/schema#",title:"Follower Demographics Schema",description:`Server-returned follower-breakdown snapshot row for one page, as
|
|
9
|
+
recorded in the \`metadata\` of an event on the events service (category
|
|
10
|
+
\`blowhorn\`, action \`follower_demographics\`); the event construct carries
|
|
11
|
+
the envelope and this construct names the metadata's own shape, which
|
|
12
|
+
Event leaves open. One row is one category of one breakdown of one page
|
|
13
|
+
on one day, keyed by (organizationId, platform, subject, readingDate,
|
|
14
|
+
dimension, category): the page's follower total on that snapshot day
|
|
15
|
+
falls into exactly one category of each dimension, so a dimension's
|
|
16
|
+
categories sum to the page's total. \`followers\` is a cumulative count
|
|
17
|
+
on the day, not a daily change, and is nullable: a blank figure in the
|
|
18
|
+
source export is not a zero.
|
|
19
|
+
`,type:"object",additionalProperties:false,required:["organizationId","platform","subject","readingDate","dimension","category"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":1},platform:{type:"string",description:"The platform the page belongs to (today only `linkedin` produces these exports).","x-oapi-codegen-extra-tags":{db:"platform"},"x-order":2},subject:{type:"string",description:"The page the figures describe, named as the source export names it.","x-oapi-codegen-extra-tags":{db:"subject"},"x-order":3},readingDate:{type:"string",format:"date",description:"The day the snapshot describes, as an ISO calendar date.","x-oapi-codegen-extra-tags":{db:"reading_date"},"x-order":4},dimension:{type:"string",enum:["location","job_function","seniority","industry","company_size"],description:"The breakdown the category belongs to; one value per breakdown sheet the source export carries.","x-oapi-codegen-extra-tags":{db:"dimension"},"x-order":5},category:{type:"string",description:"The breakdown row's label, verbatim from the source export (e.g. a location or an industry name).","x-oapi-codegen-extra-tags":{db:"category"},"x-order":6},followers:{type:"integer",nullable:true,minimum:0,description:"The page's cumulative followers in this category on the snapshot day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"followers"},"x-order":7},sourceFile:{type:"string",description:"The export file the row was read from; empty when the row did not come from a file export.","x-oapi-codegen-extra-tags":{db:"source_file"},"x-order":8}}},FollowerDemographicsPayload:{type:"object",description:`Payload for recording one follower-breakdown snapshot row for a
|
|
20
|
+
page, sent as the \`metadata\` of a create-event call. Contains
|
|
21
|
+
only client-settable fields; the row has no server-generated
|
|
22
|
+
fields, because the events service stores and returns event
|
|
23
|
+
metadata verbatim, so the payload and the recorded row
|
|
24
|
+
(FollowerDemographics) share one field set.
|
|
25
|
+
`,additionalProperties:false,required:["organizationId","platform","subject","readingDate","dimension","category"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},platform:{type:"string",description:"The platform the page belongs to (today only `linkedin` produces these exports)."},subject:{type:"string",description:"The page the figures describe, named as the source export names it."},readingDate:{type:"string",format:"date",description:"The day the snapshot describes, as an ISO calendar date."},dimension:{type:"string",enum:["location","job_function","seniority","industry","company_size"],description:"The breakdown the category belongs to; one value per breakdown sheet the source export carries."},category:{type:"string",description:"The breakdown row's label, verbatim from the source export (e.g. a location or an industry name)."},followers:{type:"integer",nullable:true,minimum:0,description:"The page's cumulative followers in this category on the snapshot day; null when the export's cell is blank."},sourceFile:{type:"string",description:"The export file the row was read from; empty when the row did not come from a file export."}}}}}},o=e;module.exports=o;
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
var e={openapi:"3.0.0",info:{title:"Follower Demographics",description:`OpenAPI schema for follower-breakdown snapshot rows for a page,
|
|
2
|
+
consumed by Blowhorn's analytics store. The rows have no endpoints
|
|
3
|
+
of their own: they are recorded and read back as the \`metadata\` of
|
|
4
|
+
events on the events service (category \`blowhorn\`, action
|
|
5
|
+
\`follower_demographics\`; see the event construct), so this file
|
|
6
|
+
declares the components only and the paths stay with the event
|
|
7
|
+
construct.
|
|
8
|
+
`,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"}},paths:{},components:{securitySchemes:{jwt:{type:"http",scheme:"Bearer [REDACTED]",bearerFormat:"JWT"}},schemas:{FollowerDemographics:{$schema:"http://json-schema.org/draft-07/schema#",title:"Follower Demographics Schema",description:`Server-returned follower-breakdown snapshot row for one page, as
|
|
9
|
+
recorded in the \`metadata\` of an event on the events service (category
|
|
10
|
+
\`blowhorn\`, action \`follower_demographics\`); the event construct carries
|
|
11
|
+
the envelope and this construct names the metadata's own shape, which
|
|
12
|
+
Event leaves open. One row is one category of one breakdown of one page
|
|
13
|
+
on one day, keyed by (organizationId, platform, subject, readingDate,
|
|
14
|
+
dimension, category): the page's follower total on that snapshot day
|
|
15
|
+
falls into exactly one category of each dimension, so a dimension's
|
|
16
|
+
categories sum to the page's total. \`followers\` is a cumulative count
|
|
17
|
+
on the day, not a daily change, and is nullable: a blank figure in the
|
|
18
|
+
source export is not a zero.
|
|
19
|
+
`,type:"object",additionalProperties:false,required:["organizationId","platform","subject","readingDate","dimension","category"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":1},platform:{type:"string",description:"The platform the page belongs to (today only `linkedin` produces these exports).","x-oapi-codegen-extra-tags":{db:"platform"},"x-order":2},subject:{type:"string",description:"The page the figures describe, named as the source export names it.","x-oapi-codegen-extra-tags":{db:"subject"},"x-order":3},readingDate:{type:"string",format:"date",description:"The day the snapshot describes, as an ISO calendar date.","x-oapi-codegen-extra-tags":{db:"reading_date"},"x-order":4},dimension:{type:"string",enum:["location","job_function","seniority","industry","company_size"],description:"The breakdown the category belongs to; one value per breakdown sheet the source export carries.","x-oapi-codegen-extra-tags":{db:"dimension"},"x-order":5},category:{type:"string",description:"The breakdown row's label, verbatim from the source export (e.g. a location or an industry name).","x-oapi-codegen-extra-tags":{db:"category"},"x-order":6},followers:{type:"integer",nullable:true,minimum:0,description:"The page's cumulative followers in this category on the snapshot day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"followers"},"x-order":7},sourceFile:{type:"string",description:"The export file the row was read from; empty when the row did not come from a file export.","x-oapi-codegen-extra-tags":{db:"source_file"},"x-order":8}}},FollowerDemographicsPayload:{type:"object",description:`Payload for recording one follower-breakdown snapshot row for a
|
|
20
|
+
page, sent as the \`metadata\` of a create-event call. Contains
|
|
21
|
+
only client-settable fields; the row has no server-generated
|
|
22
|
+
fields, because the events service stores and returns event
|
|
23
|
+
metadata verbatim, so the payload and the recorded row
|
|
24
|
+
(FollowerDemographics) share one field set.
|
|
25
|
+
`,additionalProperties:false,required:["organizationId","platform","subject","readingDate","dimension","category"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},platform:{type:"string",description:"The platform the page belongs to (today only `linkedin` produces these exports)."},subject:{type:"string",description:"The page the figures describe, named as the source export names it."},readingDate:{type:"string",format:"date",description:"The day the snapshot describes, as an ISO calendar date."},dimension:{type:"string",enum:["location","job_function","seniority","industry","company_size"],description:"The breakdown the category belongs to; one value per breakdown sheet the source export carries."},category:{type:"string",description:"The breakdown row's label, verbatim from the source export (e.g. a location or an industry name)."},followers:{type:"integer",nullable:true,minimum:0,description:"The page's cumulative followers in this category on the snapshot day; null when the export's cell is blank."},sourceFile:{type:"string",description:"The export file the row was read from; empty when the row did not come from a file export."}}}}}},o=e;export{o as default};
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
export type paths = Record<string, never>;
|
|
7
|
+
export type webhooks = Record<string, never>;
|
|
8
|
+
export interface components {
|
|
9
|
+
schemas: {
|
|
10
|
+
/**
|
|
11
|
+
* Follower Metrics Schema
|
|
12
|
+
* @description Server-returned daily new-follower figures for one page, as recorded in
|
|
13
|
+
* the `metadata` of an event on the events service (category `blowhorn`,
|
|
14
|
+
* action `follower_metrics`); the event construct carries the envelope and
|
|
15
|
+
* this construct names the metadata's own shape, which Event leaves open.
|
|
16
|
+
* One row is one page on one day, keyed by (organizationId, platform,
|
|
17
|
+
* subject, readingDate): the day's NEW followers split by the source that
|
|
18
|
+
* produced them. The source export's "Total followers" column is a day's
|
|
19
|
+
* total of new followers, not a lifetime count. Every figure is nullable:
|
|
20
|
+
* a blank figure in the source export is not a zero.
|
|
21
|
+
*/
|
|
22
|
+
FollowerMetrics: {
|
|
23
|
+
/**
|
|
24
|
+
* Format: uuid
|
|
25
|
+
* @description Owning organization ID.
|
|
26
|
+
*/
|
|
27
|
+
organizationId: string;
|
|
28
|
+
/** @description The platform the page belongs to (today only `linkedin` produces these exports). */
|
|
29
|
+
platform: string;
|
|
30
|
+
/** @description The page the figures describe, named as the source export names it. */
|
|
31
|
+
subject: string;
|
|
32
|
+
/**
|
|
33
|
+
* Format: date
|
|
34
|
+
* @description The day the figures describe, as an ISO calendar date.
|
|
35
|
+
*/
|
|
36
|
+
readingDate: string;
|
|
37
|
+
/** @description New followers that day from sponsored content; null when the export's cell is blank. */
|
|
38
|
+
newSponsored?: number | null;
|
|
39
|
+
/** @description New followers that day from organic content; null when the export's cell is blank. */
|
|
40
|
+
newOrganic?: number | null;
|
|
41
|
+
/** @description New followers that day from auto-invites; null when the export's cell is blank. */
|
|
42
|
+
newAutoInvited?: number | null;
|
|
43
|
+
/** @description All new followers that day; null when the export's cell is blank. */
|
|
44
|
+
newTotal?: number | null;
|
|
45
|
+
/** @description The export file the row was read from; empty when the row did not come from a file export. */
|
|
46
|
+
sourceFile?: string;
|
|
47
|
+
};
|
|
48
|
+
/**
|
|
49
|
+
* @description Payload for recording one day's new-follower figures for a page,
|
|
50
|
+
* sent as the `metadata` of a create-event call. Contains only
|
|
51
|
+
* client-settable fields; the row has no server-generated fields,
|
|
52
|
+
* because the events service stores and returns event metadata
|
|
53
|
+
* verbatim, so the payload and the recorded row (FollowerMetrics)
|
|
54
|
+
* share one field set.
|
|
55
|
+
*/
|
|
56
|
+
FollowerMetricsPayload: {
|
|
57
|
+
/**
|
|
58
|
+
* Format: uuid
|
|
59
|
+
* @description Owning organization ID.
|
|
60
|
+
*/
|
|
61
|
+
organizationId: string;
|
|
62
|
+
/** @description The platform the page belongs to (today only `linkedin` produces these exports). */
|
|
63
|
+
platform: string;
|
|
64
|
+
/** @description The page the figures describe, named as the source export names it. */
|
|
65
|
+
subject: string;
|
|
66
|
+
/**
|
|
67
|
+
* Format: date
|
|
68
|
+
* @description The day the figures describe, as an ISO calendar date.
|
|
69
|
+
*/
|
|
70
|
+
readingDate: string;
|
|
71
|
+
/** @description New followers that day from sponsored content; null when the export's cell is blank. */
|
|
72
|
+
newSponsored?: number | null;
|
|
73
|
+
/** @description New followers that day from organic content; null when the export's cell is blank. */
|
|
74
|
+
newOrganic?: number | null;
|
|
75
|
+
/** @description New followers that day from auto-invites; null when the export's cell is blank. */
|
|
76
|
+
newAutoInvited?: number | null;
|
|
77
|
+
/** @description All new followers that day; null when the export's cell is blank. */
|
|
78
|
+
newTotal?: number | null;
|
|
79
|
+
/** @description The export file the row was read from; empty when the row did not come from a file export. */
|
|
80
|
+
sourceFile?: string;
|
|
81
|
+
};
|
|
82
|
+
};
|
|
83
|
+
responses: never;
|
|
84
|
+
parameters: never;
|
|
85
|
+
requestBodies: never;
|
|
86
|
+
headers: never;
|
|
87
|
+
pathItems: never;
|
|
88
|
+
}
|
|
89
|
+
export type $defs = Record<string, never>;
|
|
90
|
+
export type operations = Record<string, never>;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
'use strict';
|
|
File without changes
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
'use strict';var e={openapi:"3.0.0",info:{title:"Follower Metrics",description:"OpenAPI schema for daily new-follower figures for a page, consumed by\nBlowhorn's analytics store. The rows have no endpoints of their own:\nthey are recorded and read back as the `metadata` of events on the\nevents service (category `blowhorn`, action `follower_metrics`; see\nthe event construct), so this file declares the components only and\nthe paths stay with the event construct.\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"}},paths:{},components:{securitySchemes:{jwt:{type:"http",scheme:"Bearer [REDACTED]",bearerFormat:"JWT"}},schemas:{FollowerMetrics:{$schema:"http://json-schema.org/draft-07/schema#",title:"Follower Metrics Schema",description:`Server-returned daily new-follower figures for one page, as recorded in
|
|
2
|
+
the \`metadata\` of an event on the events service (category \`blowhorn\`,
|
|
3
|
+
action \`follower_metrics\`); the event construct carries the envelope and
|
|
4
|
+
this construct names the metadata's own shape, which Event leaves open.
|
|
5
|
+
One row is one page on one day, keyed by (organizationId, platform,
|
|
6
|
+
subject, readingDate): the day's NEW followers split by the source that
|
|
7
|
+
produced them. The source export's "Total followers" column is a day's
|
|
8
|
+
total of new followers, not a lifetime count. Every figure is nullable:
|
|
9
|
+
a blank figure in the source export is not a zero.
|
|
10
|
+
`,type:"object",additionalProperties:false,required:["organizationId","platform","subject","readingDate"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":1},platform:{type:"string",description:"The platform the page belongs to (today only `linkedin` produces these exports).","x-oapi-codegen-extra-tags":{db:"platform"},"x-order":2},subject:{type:"string",description:"The page the figures describe, named as the source export names it.","x-oapi-codegen-extra-tags":{db:"subject"},"x-order":3},readingDate:{type:"string",format:"date",description:"The day the figures describe, as an ISO calendar date.","x-oapi-codegen-extra-tags":{db:"reading_date"},"x-order":4},newSponsored:{type:"integer",nullable:true,minimum:0,description:"New followers that day from sponsored content; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"new_sponsored"},"x-order":5},newOrganic:{type:"integer",nullable:true,minimum:0,description:"New followers that day from organic content; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"new_organic"},"x-order":6},newAutoInvited:{type:"integer",nullable:true,minimum:0,description:"New followers that day from auto-invites; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"new_auto_invited"},"x-order":7},newTotal:{type:"integer",nullable:true,minimum:0,description:"All new followers that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"new_total"},"x-order":8},sourceFile:{type:"string",description:"The export file the row was read from; empty when the row did not come from a file export.","x-oapi-codegen-extra-tags":{db:"source_file"},"x-order":9}}},FollowerMetricsPayload:{type:"object",description:`Payload for recording one day's new-follower figures for a page,
|
|
11
|
+
sent as the \`metadata\` of a create-event call. Contains only
|
|
12
|
+
client-settable fields; the row has no server-generated fields,
|
|
13
|
+
because the events service stores and returns event metadata
|
|
14
|
+
verbatim, so the payload and the recorded row (FollowerMetrics)
|
|
15
|
+
share one field set.
|
|
16
|
+
`,additionalProperties:false,required:["organizationId","platform","subject","readingDate"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},platform:{type:"string",description:"The platform the page belongs to (today only `linkedin` produces these exports)."},subject:{type:"string",description:"The page the figures describe, named as the source export names it."},readingDate:{type:"string",format:"date",description:"The day the figures describe, as an ISO calendar date."},newSponsored:{type:"integer",nullable:true,minimum:0,description:"New followers that day from sponsored content; null when the export's cell is blank."},newOrganic:{type:"integer",nullable:true,minimum:0,description:"New followers that day from organic content; null when the export's cell is blank."},newAutoInvited:{type:"integer",nullable:true,minimum:0,description:"New followers that day from auto-invites; null when the export's cell is blank."},newTotal:{type:"integer",nullable:true,minimum:0,description:"All new followers that day; null when the export's cell is blank."},sourceFile:{type:"string",description:"The export file the row was read from; empty when the row did not come from a file export."}}}}}},t=e;module.exports=t;
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
var e={openapi:"3.0.0",info:{title:"Follower Metrics",description:"OpenAPI schema for daily new-follower figures for a page, consumed by\nBlowhorn's analytics store. The rows have no endpoints of their own:\nthey are recorded and read back as the `metadata` of events on the\nevents service (category `blowhorn`, action `follower_metrics`; see\nthe event construct), so this file declares the components only and\nthe paths stay with the event construct.\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"}},paths:{},components:{securitySchemes:{jwt:{type:"http",scheme:"Bearer [REDACTED]",bearerFormat:"JWT"}},schemas:{FollowerMetrics:{$schema:"http://json-schema.org/draft-07/schema#",title:"Follower Metrics Schema",description:`Server-returned daily new-follower figures for one page, as recorded in
|
|
2
|
+
the \`metadata\` of an event on the events service (category \`blowhorn\`,
|
|
3
|
+
action \`follower_metrics\`); the event construct carries the envelope and
|
|
4
|
+
this construct names the metadata's own shape, which Event leaves open.
|
|
5
|
+
One row is one page on one day, keyed by (organizationId, platform,
|
|
6
|
+
subject, readingDate): the day's NEW followers split by the source that
|
|
7
|
+
produced them. The source export's "Total followers" column is a day's
|
|
8
|
+
total of new followers, not a lifetime count. Every figure is nullable:
|
|
9
|
+
a blank figure in the source export is not a zero.
|
|
10
|
+
`,type:"object",additionalProperties:false,required:["organizationId","platform","subject","readingDate"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"OrganizationID","x-oapi-codegen-extra-tags":{db:"organization_id"},"x-order":1},platform:{type:"string",description:"The platform the page belongs to (today only `linkedin` produces these exports).","x-oapi-codegen-extra-tags":{db:"platform"},"x-order":2},subject:{type:"string",description:"The page the figures describe, named as the source export names it.","x-oapi-codegen-extra-tags":{db:"subject"},"x-order":3},readingDate:{type:"string",format:"date",description:"The day the figures describe, as an ISO calendar date.","x-oapi-codegen-extra-tags":{db:"reading_date"},"x-order":4},newSponsored:{type:"integer",nullable:true,minimum:0,description:"New followers that day from sponsored content; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"new_sponsored"},"x-order":5},newOrganic:{type:"integer",nullable:true,minimum:0,description:"New followers that day from organic content; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"new_organic"},"x-order":6},newAutoInvited:{type:"integer",nullable:true,minimum:0,description:"New followers that day from auto-invites; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"new_auto_invited"},"x-order":7},newTotal:{type:"integer",nullable:true,minimum:0,description:"All new followers that day; null when the export's cell is blank.","x-oapi-codegen-extra-tags":{db:"new_total"},"x-order":8},sourceFile:{type:"string",description:"The export file the row was read from; empty when the row did not come from a file export.","x-oapi-codegen-extra-tags":{db:"source_file"},"x-order":9}}},FollowerMetricsPayload:{type:"object",description:`Payload for recording one day's new-follower figures for a page,
|
|
11
|
+
sent as the \`metadata\` of a create-event call. Contains only
|
|
12
|
+
client-settable fields; the row has no server-generated fields,
|
|
13
|
+
because the events service stores and returns event metadata
|
|
14
|
+
verbatim, so the payload and the recorded row (FollowerMetrics)
|
|
15
|
+
share one field set.
|
|
16
|
+
`,additionalProperties:false,required:["organizationId","platform","subject","readingDate"],properties:{organizationId:{type:"string",format:"uuid",description:"Owning organization ID.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},platform:{type:"string",description:"The platform the page belongs to (today only `linkedin` produces these exports)."},subject:{type:"string",description:"The page the figures describe, named as the source export names it."},readingDate:{type:"string",format:"date",description:"The day the figures describe, as an ISO calendar date."},newSponsored:{type:"integer",nullable:true,minimum:0,description:"New followers that day from sponsored content; null when the export's cell is blank."},newOrganic:{type:"integer",nullable:true,minimum:0,description:"New followers that day from organic content; null when the export's cell is blank."},newAutoInvited:{type:"integer",nullable:true,minimum:0,description:"New followers that day from auto-invites; null when the export's cell is blank."},newTotal:{type:"integer",nullable:true,minimum:0,description:"All new followers that day; null when the export's cell is blank."},sourceFile:{type:"string",description:"The export file the row was read from; empty when the row did not come from a file export."}}}}}},t=e;export{t as default};
|