@meshery/schemas 1.3.122 → 1.3.124

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.
@@ -31,7 +31,7 @@ Delete Content Item for the writes); a caller without it receives a
31
31
  a live content item of the organization, and a caller who is not a
32
32
  live member of it, receive the same 404, so the existence of another
33
33
  organization's rows is never disclosed.
34
- `,version:"v1beta3",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},security:[{jwt:[]}],tags:[{name:"contentItems",description:"Operations related to content items."}],paths:{"/api/content-items":{get:{"x-internal":["cloud"],tags:["contentItems"],summary:"List content items",operationId:"listContentItems","x-mcp":{expose:true,title:"List content items",scope:"content:read"},description:"Returns a paginated list of the live content items in the\norganization of the authenticated session, ordered by `rowNumber`\nunless `order` names another column (`rowNumber`, `createdAt`,\n`updatedAt`). `search` matches the profile or the content values,\ncase-insensitively. `threadId` returns one whole thread: the root\nitem it names and every live item whose `threadId` names it,\nordered by `threadIndex` (the root first) unless `order` names\nanother column. A `threadId` or `X-Current-Orgid` that is not a\nUUID answers 400.\n",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},{name:"pageSize",in:"query",description:"Number of items per page (canonical camelCase form).",schema:{type:"integer",minimum:1}},{name:"pagesize",in:"query",description:"Number of items per page. Deprecated alias of pageSize;\ncanonical `pageSize` wins when both are present.\n",deprecated:true,schema:{type:"integer",minimum:1}},{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},{name:"profile",in:"query",required:false,description:"Filter by owning profile subject (exact match).",schema:{type:"string"}},{name:"threadId",in:"query",required:false,description:"Return one thread: the root item this ID names and every live item\nwhose `threadId` names it.\n",schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"X-Current-Orgid",in:"header",required:false,description:"Organization the call acts in, by ID (a UUID). When present, the server resolves the session organization from it instead of the caller's selected organization, and runs its membership and permission checks there. A caller who is not a live member of the named organization receives the same 404 as an unknown resource. Omitted, the caller's selected organization applies.",schema:{type:"string",minLength:36,maxLength:36,pattern:"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}}],responses:{200:{description:"Content item page",content:{"application/json":{schema:{type:"object",description:"Paginated collection of content items.",properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1},totalCount:{type:"integer",description:"Total number of items available.",minimum:0},contentItems:{type:"array",items:{"x-go-type":"ContentItem",$schema:"http://json-schema.org/draft-07/schema#",title:"Content Item Schema",description:`Server-returned content item as persisted by the owning service.
34
+ `,version:"v1beta3",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},security:[{jwt:[]}],tags:[{name:"contentItems",description:"Operations related to content items."}],paths:{"/api/content-items":{get:{"x-internal":["cloud"],tags:["contentItems"],summary:"List content items",operationId:"listContentItems","x-mcp":{expose:true,title:"List content items",scope:"content:read",description:"Read-only. Returns a paginated list of the live content items in the organization of the authenticated session, ordered by `rowNumber` unless `order` names another column (`rowNumber`, `createdAt`, `updatedAt`). `search` matches the profile or the content values, case-insensitively. `threadId` returns one whole thread: the root item it names and every live item whose `threadId` names it, ordered by `threadIndex` (the root first) unless `order` names another column. A `threadId` or `X-Current-Orgid` that is not a UUID answers 400."},description:"Returns a paginated list of the live content items in the\norganization of the authenticated session, ordered by `rowNumber`\nunless `order` names another column (`rowNumber`, `createdAt`,\n`updatedAt`). `search` matches the profile or the content values,\ncase-insensitively. `threadId` returns one whole thread: the root\nitem it names and every live item whose `threadId` names it,\nordered by `threadIndex` (the root first) unless `order` names\nanother column. A `threadId` or `X-Current-Orgid` that is not a\nUUID answers 400.\n",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},{name:"pageSize",in:"query",description:"Number of items per page (canonical camelCase form).",schema:{type:"integer",minimum:1}},{name:"pagesize",in:"query",description:"Number of items per page. Deprecated alias of pageSize;\ncanonical `pageSize` wins when both are present.\n",deprecated:true,schema:{type:"integer",minimum:1}},{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},{name:"profile",in:"query",required:false,description:"Filter by owning profile subject (exact match).",schema:{type:"string"}},{name:"threadId",in:"query",required:false,description:"Return one thread: the root item this ID names and every live item\nwhose `threadId` names it.\n",schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"X-Current-Orgid",in:"header",required:false,description:"Organization the call acts in, by ID (a UUID). When present, the server resolves the session organization from it instead of the caller's selected organization, and runs its membership and permission checks there. A caller who is not a live member of the named organization receives the same 404 as an unknown resource. Omitted, the caller's selected organization applies.",schema:{type:"string",minLength:36,maxLength:36,pattern:"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}}],responses:{200:{description:"Content item page",content:{"application/json":{schema:{type:"object",description:"Paginated collection of content items.",properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1},totalCount:{type:"integer",description:"Total number of items available.",minimum:0},contentItems:{type:"array",items:{"x-go-type":"ContentItem",$schema:"http://json-schema.org/draft-07/schema#",title:"Content Item Schema",description:`Server-returned content item as persisted by the owning service.
35
35
  Content items carry a row number and a server-computed fingerprint over
36
36
  their canonical values; updates are conditional on the fingerprint the
37
37
  writer read, so stale writes are refused rather than silently applied.
@@ -97,7 +97,7 @@ changed; present, the item's rules read as adjusted.
97
97
  `,type:"object",additionalProperties:false,properties:{pace:{type:"string",description:"Typing and interaction pace.",enum:["slow","normal","fast"],"x-enum-varnames":["ContentItemPaceSlow","ContentItemPaceNormal","ContentItemPaceFast"]},minDelaySeconds:{type:"integer",description:"Least time, in seconds, between two public actions on one platform for one profile.",minimum:0,maximum:86400},quietHours:{description:"Local hours with no public actions.",type:"object",additionalProperties:false,required:["start","end"],properties:{start:{type:"integer",description:"Local hour the window opens.",minimum:0,maximum:23},end:{type:"integer",description:"Local hour the window closes.",minimum:0,maximum:23}}},capFraction:{type:"number",format:"double",description:"Share of each built-in daily cap the item may use, above 0 and at most 1.",minimum:0,exclusiveMinimum:true,maximum:1},noMouseMove:{type:"boolean",description:"Whether the item runs without pointer movement."}}}}},threadId:{type:"string",format:"uuid","x-go-type":"core.Uuid","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},description:`ID of the root item of the thread this item belongs to: the first post of a split thread, or the first transmission of a conversation between profiles. Omitted on a standalone item and on a root itself; a root is the item other items name here. Set on insert only.
98
98
  `,"x-go-name":"ThreadID","x-oapi-codegen-extra-tags":{db:"thread_id",json:"threadId,omitempty"},"x-order":12},replyToId:{type:"string",format:"uuid","x-go-type":"core.Uuid","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},description:"ID of the item this item answers directly: the thread root or another item of the same thread. A split thread's part names the part before it; a reply in a conversation between profiles names the transmission above it. Omitted when the item answers nothing. Never set without `threadId`. Set on insert only.\n","x-go-name":"ReplyToID","x-oapi-codegen-extra-tags":{db:"reply_to_id",json:"replyToId,omitempty"},"x-order":13},threadIndex:{type:"integer",description:"Position of the item in its thread, counting the root as 0. Present exactly when `threadId` is, unique among the live items of the thread, and greater than the position of the item named by `replyToId`. Set on insert only.\n",minimum:1,"x-oapi-codegen-extra-tags":{db:"thread_index",json:"threadIndex,omitempty"},"x-order":14},mediaAssetIds:{type:"array",uniqueItems:true,maxItems:20,"x-go-type":"pq.StringArray","x-go-type-import":{path:"github.com/lib/pq"},"x-go-type-skip-optional-pointer":true,items:{type:"string",format:"uuid",description:"ID of a media_asset in the same organization."},description:`The media assets the item posts, in posting order. Ids only, never URLs. Omitted when the item posts no file.
99
99
  `,"x-oapi-codegen-extra-tags":{db:"media_asset_ids",json:"mediaAssetIds,omitempty"},"x-order":15},approved:{type:"boolean",description:"Whether the item is approved to run. Server-set and read-only: it is not in ContentItemPayload. At insert the server sets it from the effective approval, which is resolved at insert, again at each content edit, and again when `approvalPolicy` changes: `false` with a pending `content_item_approval` request when `approvalRequired` is true, and `true` with no request when it is false. Afterwards `approveRequest` in the request construct sets it to true, and so does the one-time backfill of a row written before this field shipped (see below); that operation needs the Decide Content Item Approvals key and is never an AI app tool. A content edit that resolves to required sets it back to false. Any content edit that leaves it unapproved supersedes an open request with a fresh pending one, so after the edit an unapproved item has an open request (see updateContentItem). A change to `approvalPolicy` whose resolved result is required does the same to an approved item. The client that runs the queue reads this field. For one release after this field ships, servers mirror it into the free-form `Approved?` column in `data` for older readers, and backfill `approved` once from that column for rows written before the field shipped, so every row carries a value. A client-sent `Approved?` never approves an item. New readers read this field only. See docs/content-item-contract.md.\n",default:false,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"approved",json:"approved"},"x-order":16},createdByClient:{type:"string",description:`OAuth client ID of the AI app that created the item. Server-set from the access token, never client-settable, and never changed by an update. Empty or omitted on an item a person created.
100
- `,maxLength:255,"x-oapi-codegen-extra-tags":{db:"created_by_client",json:"createdByClient,omitempty"},"x-order":17},approvalPolicy:{description:"The item's own approval policy. Absent means inherit. An explicit `required` or `not_required` wins over every higher-level setting; `inherit` or absent inherits from higher-level settings (platform, workspace, profile), hierarchy defined in https://github.com/layer5io/meshery-cloud/issues/6365. Interim: until the upstream policies exist, `inherit` or absent resolves to `required`. Only a person with Decide Content Item Approvals may write a value that changes the stored one; an AI app never can. Changing it alone re-resolves the approval. A change whose result is required (`required`, or `inherit` or absent in the interim, which resolves to required) resets an approved item and opens its request. A change whose result is not required never changes `approved`, and any change leaves an unapproved item with an open request, whatever the result (see updateContentItem). Stored in the nullable `approval_policy` column; null means inherit, and a written `inherit` is stored as null, so reads return it absent.\n","x-oapi-codegen-extra-tags":{db:"approval_policy",json:"approvalPolicy,omitempty"},"x-order":18,type:"string",enum:["required","not_required","inherit"],"x-enum-varnames":["ApprovalPolicyRequired","ApprovalPolicyNotRequired","ApprovalPolicyInherit"]},approvalRequired:{type:"boolean",readOnly:true,description:"Server-computed and read-only: whether the item needs a person's approval, resolved at insert, again at each content edit, and again when `approvalPolicy` changes (see updateContentItem) from its `approvalPolicy` and the higher-level settings (hierarchy defined in https://github.com/layer5io/meshery-cloud/issues/6365). Stored in the `approval_required` column. Never in a payload. A change to `approvalPolicy` alone re-resolves it; a higher-level setting alone does not, and the next content edit resolves it again. Interim: until the upstream policies exist, an absent or `inherit` policy resolves to `true` (approval source `fallback`). Absent on items inserted before this field shipped.\n","x-oapi-codegen-extra-tags":{db:"approval_required",json:"approvalRequired,omitempty"},"x-order":19},approvalPolicySource:{type:"string",readOnly:true,description:"Server-computed and read-only: the level that decided `approvalRequired`, resolved at insert, again at each content edit, and again when `approvalPolicy` changes (see updateContentItem), stored in the `approval_policy_source` column. `item` when the item's own `approvalPolicy` was explicit; `fallback` when no level set a value and approval is required. The other levels name the higher level that set the value: `workspace`, `profile`, `organization` and `platform`, listed in their planned order (the hierarchy is defined in https://github.com/layer5io/meshery-cloud/issues/6365). Interim: until the upstream policies exist, only `item` and `fallback` are active (an absent or `inherit` policy resolves to `fallback`). The other four levels become active as that hierarchy lands. Never in a payload. Absent on items inserted before this field shipped.\n",enum:["item","workspace","profile","organization","platform","fallback"],"x-enum-varnames":["ApprovalPolicySourceItem","ApprovalPolicySourceWorkspace","ApprovalPolicySourceProfile","ApprovalPolicySourceOrganization","ApprovalPolicySourcePlatform","ApprovalPolicySourceFallback"],"x-oapi-codegen-extra-tags":{db:"approval_policy_source",json:"approvalPolicySource,omitempty"},"x-order":20}}}}}},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"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},409:{description:"Conflict on insert. The body's `code` says which: `row_number_taken` or `thread_index_taken` is permanent for this payload, and `idempotency_key_in_flight` is a retry whose first request with the same Idempotency-Key is still being processed. Once the first request has finished without a 5xx, a retry receives the stored response; after a 5xx, a retry is processed as new. Nothing is inserted in any case.\n",content:{"application/json":{schema:{oneOf:[{type:"object",description:"Body of an insert refused for a permanent conflict with the content. `code` is the machine-readable reason and `message` the sentence the caller is shown. The in-flight retry body is `IdempotencyKeyInFlightError` in v1beta2 core.",additionalProperties:false,required:["code","message"],properties:{code:{type:"string",description:"`row_number_taken`: a live item of the organization holds the `rowNumber`. `thread_index_taken`: a live item of the same thread holds the `threadIndex`.\n",enum:["row_number_taken","thread_index_taken"]},message:{type:"string",minLength:1,description:"The sentence the caller is shown."}}},{type:"object",description:"A retry whose Idempotency-Key is still in flight. Nothing was created by this request. Once the first request has finished without a 5xx, a retry receives the stored response; after a 5xx, a retry is processed as new.",required:["code","message"],additionalProperties:false,properties:{code:{type:"string",description:"Machine-readable reason. Always `idempotency_key_in_flight` for this body.",enum:["idempotency_key_in_flight"]},message:{type:"string",minLength:1,description:"The sentence the caller is shown."}}}]}}}},422:{description:"Unprocessable - the Idempotency-Key was already used with a different request body",content:{"text/plain":{schema:{type:"string"}}}},429:{description:"Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying.",headers:{"Retry-After":{description:"Number of seconds the caller must wait before retrying.",required:true,schema:{type:"integer",minimum:1}}},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`, `MeshkitError429`, `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"}}}}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/content-items/{contentItemId}":{get:{"x-internal":["cloud"],tags:["contentItems"],summary:"Get a content item by ID",operationId:"getContentItem","x-mcp":{expose:true,title:"Get a content item",scope:"content:read"},parameters:[{name:"contentItemId",in:"path",description:"Content item ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"X-Current-Orgid",in:"header",required:false,description:"Organization the call acts in, by ID (a UUID). When present, the server resolves the session organization from it instead of the caller's selected organization, and runs its membership and permission checks there. A caller who is not a live member of the named organization receives the same 404 as an unknown resource. Omitted, the caller's selected organization applies.",schema:{type:"string",minLength:36,maxLength:36,pattern:"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}}],responses:{200:{description:"Content item response",content:{"application/json":{schema:{$schema:"http://json-schema.org/draft-07/schema#",title:"Content Item Schema",description:`Server-returned content item as persisted by the owning service.
100
+ `,maxLength:255,"x-oapi-codegen-extra-tags":{db:"created_by_client",json:"createdByClient,omitempty"},"x-order":17},approvalPolicy:{description:"The item's own approval policy. Absent means inherit. An explicit `required` or `not_required` wins over every higher-level setting; `inherit` or absent inherits from higher-level settings (platform, workspace, profile), hierarchy defined in https://github.com/layer5io/meshery-cloud/issues/6365. Interim: until the upstream policies exist, `inherit` or absent resolves to `required`. Only a person with Decide Content Item Approvals may write a value that changes the stored one; an AI app never can. Changing it alone re-resolves the approval. A change whose result is required (`required`, or `inherit` or absent in the interim, which resolves to required) resets an approved item and opens its request. A change whose result is not required never changes `approved`, and any change leaves an unapproved item with an open request, whatever the result (see updateContentItem). Stored in the nullable `approval_policy` column; null means inherit, and a written `inherit` is stored as null, so reads return it absent.\n","x-oapi-codegen-extra-tags":{db:"approval_policy",json:"approvalPolicy,omitempty"},"x-order":18,type:"string",enum:["required","not_required","inherit"],"x-enum-varnames":["ApprovalPolicyRequired","ApprovalPolicyNotRequired","ApprovalPolicyInherit"]},approvalRequired:{type:"boolean",readOnly:true,description:"Server-computed and read-only: whether the item needs a person's approval, resolved at insert, again at each content edit, and again when `approvalPolicy` changes (see updateContentItem) from its `approvalPolicy` and the higher-level settings (hierarchy defined in https://github.com/layer5io/meshery-cloud/issues/6365). Stored in the `approval_required` column. Never in a payload. A change to `approvalPolicy` alone re-resolves it; a higher-level setting alone does not, and the next content edit resolves it again. Interim: until the upstream policies exist, an absent or `inherit` policy resolves to `true` (approval source `fallback`). Absent on items inserted before this field shipped.\n","x-oapi-codegen-extra-tags":{db:"approval_required",json:"approvalRequired,omitempty"},"x-order":19},approvalPolicySource:{type:"string",readOnly:true,description:"Server-computed and read-only: the level that decided `approvalRequired`, resolved at insert, again at each content edit, and again when `approvalPolicy` changes (see updateContentItem), stored in the `approval_policy_source` column. `item` when the item's own `approvalPolicy` was explicit; `fallback` when no level set a value and approval is required. The other levels name the higher level that set the value: `workspace`, `profile`, `organization` and `platform`, listed in their planned order (the hierarchy is defined in https://github.com/layer5io/meshery-cloud/issues/6365). Interim: until the upstream policies exist, only `item` and `fallback` are active (an absent or `inherit` policy resolves to `fallback`). The other four levels become active as that hierarchy lands. Never in a payload. Absent on items inserted before this field shipped.\n",enum:["item","workspace","profile","organization","platform","fallback"],"x-enum-varnames":["ApprovalPolicySourceItem","ApprovalPolicySourceWorkspace","ApprovalPolicySourceProfile","ApprovalPolicySourceOrganization","ApprovalPolicySourcePlatform","ApprovalPolicySourceFallback"],"x-oapi-codegen-extra-tags":{db:"approval_policy_source",json:"approvalPolicySource,omitempty"},"x-order":20}}}}}},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"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},409:{description:"Conflict on insert. The body's `code` says which: `row_number_taken` or `thread_index_taken` is permanent for this payload, and `idempotency_key_in_flight` is a retry whose first request with the same Idempotency-Key is still being processed. Once the first request has finished without a 5xx, a retry receives the stored response; after a 5xx, a retry is processed as new. Nothing is inserted in any case.\n",content:{"application/json":{schema:{oneOf:[{type:"object",description:"Body of an insert refused for a permanent conflict with the content. `code` is the machine-readable reason and `message` the sentence the caller is shown. The in-flight retry body is `IdempotencyKeyInFlightError` in v1beta2 core.",additionalProperties:false,required:["code","message"],properties:{code:{type:"string",description:"`row_number_taken`: a live item of the organization holds the `rowNumber`. `thread_index_taken`: a live item of the same thread holds the `threadIndex`.\n",enum:["row_number_taken","thread_index_taken"]},message:{type:"string",minLength:1,description:"The sentence the caller is shown."}}},{type:"object",description:"A retry whose Idempotency-Key is still in flight. Nothing was created by this request. Once the first request has finished without a 5xx, a retry receives the stored response; after a 5xx, a retry is processed as new.",required:["code","message"],additionalProperties:false,properties:{code:{type:"string",description:"Machine-readable reason. Always `idempotency_key_in_flight` for this body.",enum:["idempotency_key_in_flight"]},message:{type:"string",minLength:1,description:"The sentence the caller is shown."}}}]}}}},422:{description:"Unprocessable - the Idempotency-Key was already used with a different request body",content:{"text/plain":{schema:{type:"string"}}}},429:{description:"Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying.",headers:{"Retry-After":{description:"Number of seconds the caller must wait before retrying.",required:true,schema:{type:"integer",minimum:1}}},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`, `MeshkitError429`, `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"}}}}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/content-items/{contentItemId}":{get:{"x-internal":["cloud"],tags:["contentItems"],summary:"Get a content item by ID",operationId:"getContentItem","x-mcp":{expose:true,title:"Get a content item",scope:"content:read",description:"Read-only. Returns the content item with the given ID in the organization of the authenticated session. An `X-Current-Orgid` that is not a UUID answers 400."},parameters:[{name:"contentItemId",in:"path",description:"Content item ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"X-Current-Orgid",in:"header",required:false,description:"Organization the call acts in, by ID (a UUID). When present, the server resolves the session organization from it instead of the caller's selected organization, and runs its membership and permission checks there. A caller who is not a live member of the named organization receives the same 404 as an unknown resource. Omitted, the caller's selected organization applies.",schema:{type:"string",minLength:36,maxLength:36,pattern:"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}}],responses:{200:{description:"Content item response",content:{"application/json":{schema:{$schema:"http://json-schema.org/draft-07/schema#",title:"Content Item Schema",description:`Server-returned content item as persisted by the owning service.
101
101
  Content items carry a row number and a server-computed fingerprint over
102
102
  their canonical values; updates are conditional on the fingerprint the
103
103
  writer read, so stale writes are refused rather than silently applied.
@@ -31,7 +31,7 @@ Delete Content Item for the writes); a caller without it receives a
31
31
  a live content item of the organization, and a caller who is not a
32
32
  live member of it, receive the same 404, so the existence of another
33
33
  organization's rows is never disclosed.
34
- `,version:"v1beta3",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},security:[{jwt:[]}],tags:[{name:"contentItems",description:"Operations related to content items."}],paths:{"/api/content-items":{get:{"x-internal":["cloud"],tags:["contentItems"],summary:"List content items",operationId:"listContentItems","x-mcp":{expose:true,title:"List content items",scope:"content:read"},description:"Returns a paginated list of the live content items in the\norganization of the authenticated session, ordered by `rowNumber`\nunless `order` names another column (`rowNumber`, `createdAt`,\n`updatedAt`). `search` matches the profile or the content values,\ncase-insensitively. `threadId` returns one whole thread: the root\nitem it names and every live item whose `threadId` names it,\nordered by `threadIndex` (the root first) unless `order` names\nanother column. A `threadId` or `X-Current-Orgid` that is not a\nUUID answers 400.\n",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},{name:"pageSize",in:"query",description:"Number of items per page (canonical camelCase form).",schema:{type:"integer",minimum:1}},{name:"pagesize",in:"query",description:"Number of items per page. Deprecated alias of pageSize;\ncanonical `pageSize` wins when both are present.\n",deprecated:true,schema:{type:"integer",minimum:1}},{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},{name:"profile",in:"query",required:false,description:"Filter by owning profile subject (exact match).",schema:{type:"string"}},{name:"threadId",in:"query",required:false,description:"Return one thread: the root item this ID names and every live item\nwhose `threadId` names it.\n",schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"X-Current-Orgid",in:"header",required:false,description:"Organization the call acts in, by ID (a UUID). When present, the server resolves the session organization from it instead of the caller's selected organization, and runs its membership and permission checks there. A caller who is not a live member of the named organization receives the same 404 as an unknown resource. Omitted, the caller's selected organization applies.",schema:{type:"string",minLength:36,maxLength:36,pattern:"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}}],responses:{200:{description:"Content item page",content:{"application/json":{schema:{type:"object",description:"Paginated collection of content items.",properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1},totalCount:{type:"integer",description:"Total number of items available.",minimum:0},contentItems:{type:"array",items:{"x-go-type":"ContentItem",$schema:"http://json-schema.org/draft-07/schema#",title:"Content Item Schema",description:`Server-returned content item as persisted by the owning service.
34
+ `,version:"v1beta3",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},security:[{jwt:[]}],tags:[{name:"contentItems",description:"Operations related to content items."}],paths:{"/api/content-items":{get:{"x-internal":["cloud"],tags:["contentItems"],summary:"List content items",operationId:"listContentItems","x-mcp":{expose:true,title:"List content items",scope:"content:read",description:"Read-only. Returns a paginated list of the live content items in the organization of the authenticated session, ordered by `rowNumber` unless `order` names another column (`rowNumber`, `createdAt`, `updatedAt`). `search` matches the profile or the content values, case-insensitively. `threadId` returns one whole thread: the root item it names and every live item whose `threadId` names it, ordered by `threadIndex` (the root first) unless `order` names another column. A `threadId` or `X-Current-Orgid` that is not a UUID answers 400."},description:"Returns a paginated list of the live content items in the\norganization of the authenticated session, ordered by `rowNumber`\nunless `order` names another column (`rowNumber`, `createdAt`,\n`updatedAt`). `search` matches the profile or the content values,\ncase-insensitively. `threadId` returns one whole thread: the root\nitem it names and every live item whose `threadId` names it,\nordered by `threadIndex` (the root first) unless `order` names\nanother column. A `threadId` or `X-Current-Orgid` that is not a\nUUID answers 400.\n",parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},{name:"pageSize",in:"query",description:"Number of items per page (canonical camelCase form).",schema:{type:"integer",minimum:1}},{name:"pagesize",in:"query",description:"Number of items per page. Deprecated alias of pageSize;\ncanonical `pageSize` wins when both are present.\n",deprecated:true,schema:{type:"integer",minimum:1}},{name:"search",in:"query",description:"Get responses that match search param value",schema:{type:"string"}},{name:"order",in:"query",description:"Get ordered responses",schema:{type:"string"}},{name:"profile",in:"query",required:false,description:"Filter by owning profile subject (exact match).",schema:{type:"string"}},{name:"threadId",in:"query",required:false,description:"Return one thread: the root item this ID names and every live item\nwhose `threadId` names it.\n",schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"X-Current-Orgid",in:"header",required:false,description:"Organization the call acts in, by ID (a UUID). When present, the server resolves the session organization from it instead of the caller's selected organization, and runs its membership and permission checks there. A caller who is not a live member of the named organization receives the same 404 as an unknown resource. Omitted, the caller's selected organization applies.",schema:{type:"string",minLength:36,maxLength:36,pattern:"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}}],responses:{200:{description:"Content item page",content:{"application/json":{schema:{type:"object",description:"Paginated collection of content items.",properties:{page:{type:"integer",description:"Current page number of the result set.",minimum:0},pageSize:{type:"integer",description:"Number of items per page.",minimum:1},totalCount:{type:"integer",description:"Total number of items available.",minimum:0},contentItems:{type:"array",items:{"x-go-type":"ContentItem",$schema:"http://json-schema.org/draft-07/schema#",title:"Content Item Schema",description:`Server-returned content item as persisted by the owning service.
35
35
  Content items carry a row number and a server-computed fingerprint over
36
36
  their canonical values; updates are conditional on the fingerprint the
37
37
  writer read, so stale writes are refused rather than silently applied.
@@ -97,7 +97,7 @@ changed; present, the item's rules read as adjusted.
97
97
  `,type:"object",additionalProperties:false,properties:{pace:{type:"string",description:"Typing and interaction pace.",enum:["slow","normal","fast"],"x-enum-varnames":["ContentItemPaceSlow","ContentItemPaceNormal","ContentItemPaceFast"]},minDelaySeconds:{type:"integer",description:"Least time, in seconds, between two public actions on one platform for one profile.",minimum:0,maximum:86400},quietHours:{description:"Local hours with no public actions.",type:"object",additionalProperties:false,required:["start","end"],properties:{start:{type:"integer",description:"Local hour the window opens.",minimum:0,maximum:23},end:{type:"integer",description:"Local hour the window closes.",minimum:0,maximum:23}}},capFraction:{type:"number",format:"double",description:"Share of each built-in daily cap the item may use, above 0 and at most 1.",minimum:0,exclusiveMinimum:true,maximum:1},noMouseMove:{type:"boolean",description:"Whether the item runs without pointer movement."}}}}},threadId:{type:"string",format:"uuid","x-go-type":"core.Uuid","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},description:`ID of the root item of the thread this item belongs to: the first post of a split thread, or the first transmission of a conversation between profiles. Omitted on a standalone item and on a root itself; a root is the item other items name here. Set on insert only.
98
98
  `,"x-go-name":"ThreadID","x-oapi-codegen-extra-tags":{db:"thread_id",json:"threadId,omitempty"},"x-order":12},replyToId:{type:"string",format:"uuid","x-go-type":"core.Uuid","x-go-type-import":{path:"github.com/meshery/schemas/models/core",name:"core"},description:"ID of the item this item answers directly: the thread root or another item of the same thread. A split thread's part names the part before it; a reply in a conversation between profiles names the transmission above it. Omitted when the item answers nothing. Never set without `threadId`. Set on insert only.\n","x-go-name":"ReplyToID","x-oapi-codegen-extra-tags":{db:"reply_to_id",json:"replyToId,omitempty"},"x-order":13},threadIndex:{type:"integer",description:"Position of the item in its thread, counting the root as 0. Present exactly when `threadId` is, unique among the live items of the thread, and greater than the position of the item named by `replyToId`. Set on insert only.\n",minimum:1,"x-oapi-codegen-extra-tags":{db:"thread_index",json:"threadIndex,omitempty"},"x-order":14},mediaAssetIds:{type:"array",uniqueItems:true,maxItems:20,"x-go-type":"pq.StringArray","x-go-type-import":{path:"github.com/lib/pq"},"x-go-type-skip-optional-pointer":true,items:{type:"string",format:"uuid",description:"ID of a media_asset in the same organization."},description:`The media assets the item posts, in posting order. Ids only, never URLs. Omitted when the item posts no file.
99
99
  `,"x-oapi-codegen-extra-tags":{db:"media_asset_ids",json:"mediaAssetIds,omitempty"},"x-order":15},approved:{type:"boolean",description:"Whether the item is approved to run. Server-set and read-only: it is not in ContentItemPayload. At insert the server sets it from the effective approval, which is resolved at insert, again at each content edit, and again when `approvalPolicy` changes: `false` with a pending `content_item_approval` request when `approvalRequired` is true, and `true` with no request when it is false. Afterwards `approveRequest` in the request construct sets it to true, and so does the one-time backfill of a row written before this field shipped (see below); that operation needs the Decide Content Item Approvals key and is never an AI app tool. A content edit that resolves to required sets it back to false. Any content edit that leaves it unapproved supersedes an open request with a fresh pending one, so after the edit an unapproved item has an open request (see updateContentItem). A change to `approvalPolicy` whose resolved result is required does the same to an approved item. The client that runs the queue reads this field. For one release after this field ships, servers mirror it into the free-form `Approved?` column in `data` for older readers, and backfill `approved` once from that column for rows written before the field shipped, so every row carries a value. A client-sent `Approved?` never approves an item. New readers read this field only. See docs/content-item-contract.md.\n",default:false,"x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"approved",json:"approved"},"x-order":16},createdByClient:{type:"string",description:`OAuth client ID of the AI app that created the item. Server-set from the access token, never client-settable, and never changed by an update. Empty or omitted on an item a person created.
100
- `,maxLength:255,"x-oapi-codegen-extra-tags":{db:"created_by_client",json:"createdByClient,omitempty"},"x-order":17},approvalPolicy:{description:"The item's own approval policy. Absent means inherit. An explicit `required` or `not_required` wins over every higher-level setting; `inherit` or absent inherits from higher-level settings (platform, workspace, profile), hierarchy defined in https://github.com/layer5io/meshery-cloud/issues/6365. Interim: until the upstream policies exist, `inherit` or absent resolves to `required`. Only a person with Decide Content Item Approvals may write a value that changes the stored one; an AI app never can. Changing it alone re-resolves the approval. A change whose result is required (`required`, or `inherit` or absent in the interim, which resolves to required) resets an approved item and opens its request. A change whose result is not required never changes `approved`, and any change leaves an unapproved item with an open request, whatever the result (see updateContentItem). Stored in the nullable `approval_policy` column; null means inherit, and a written `inherit` is stored as null, so reads return it absent.\n","x-oapi-codegen-extra-tags":{db:"approval_policy",json:"approvalPolicy,omitempty"},"x-order":18,type:"string",enum:["required","not_required","inherit"],"x-enum-varnames":["ApprovalPolicyRequired","ApprovalPolicyNotRequired","ApprovalPolicyInherit"]},approvalRequired:{type:"boolean",readOnly:true,description:"Server-computed and read-only: whether the item needs a person's approval, resolved at insert, again at each content edit, and again when `approvalPolicy` changes (see updateContentItem) from its `approvalPolicy` and the higher-level settings (hierarchy defined in https://github.com/layer5io/meshery-cloud/issues/6365). Stored in the `approval_required` column. Never in a payload. A change to `approvalPolicy` alone re-resolves it; a higher-level setting alone does not, and the next content edit resolves it again. Interim: until the upstream policies exist, an absent or `inherit` policy resolves to `true` (approval source `fallback`). Absent on items inserted before this field shipped.\n","x-oapi-codegen-extra-tags":{db:"approval_required",json:"approvalRequired,omitempty"},"x-order":19},approvalPolicySource:{type:"string",readOnly:true,description:"Server-computed and read-only: the level that decided `approvalRequired`, resolved at insert, again at each content edit, and again when `approvalPolicy` changes (see updateContentItem), stored in the `approval_policy_source` column. `item` when the item's own `approvalPolicy` was explicit; `fallback` when no level set a value and approval is required. The other levels name the higher level that set the value: `workspace`, `profile`, `organization` and `platform`, listed in their planned order (the hierarchy is defined in https://github.com/layer5io/meshery-cloud/issues/6365). Interim: until the upstream policies exist, only `item` and `fallback` are active (an absent or `inherit` policy resolves to `fallback`). The other four levels become active as that hierarchy lands. Never in a payload. Absent on items inserted before this field shipped.\n",enum:["item","workspace","profile","organization","platform","fallback"],"x-enum-varnames":["ApprovalPolicySourceItem","ApprovalPolicySourceWorkspace","ApprovalPolicySourceProfile","ApprovalPolicySourceOrganization","ApprovalPolicySourcePlatform","ApprovalPolicySourceFallback"],"x-oapi-codegen-extra-tags":{db:"approval_policy_source",json:"approvalPolicySource,omitempty"},"x-order":20}}}}}},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"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},409:{description:"Conflict on insert. The body's `code` says which: `row_number_taken` or `thread_index_taken` is permanent for this payload, and `idempotency_key_in_flight` is a retry whose first request with the same Idempotency-Key is still being processed. Once the first request has finished without a 5xx, a retry receives the stored response; after a 5xx, a retry is processed as new. Nothing is inserted in any case.\n",content:{"application/json":{schema:{oneOf:[{type:"object",description:"Body of an insert refused for a permanent conflict with the content. `code` is the machine-readable reason and `message` the sentence the caller is shown. The in-flight retry body is `IdempotencyKeyInFlightError` in v1beta2 core.",additionalProperties:false,required:["code","message"],properties:{code:{type:"string",description:"`row_number_taken`: a live item of the organization holds the `rowNumber`. `thread_index_taken`: a live item of the same thread holds the `threadIndex`.\n",enum:["row_number_taken","thread_index_taken"]},message:{type:"string",minLength:1,description:"The sentence the caller is shown."}}},{type:"object",description:"A retry whose Idempotency-Key is still in flight. Nothing was created by this request. Once the first request has finished without a 5xx, a retry receives the stored response; after a 5xx, a retry is processed as new.",required:["code","message"],additionalProperties:false,properties:{code:{type:"string",description:"Machine-readable reason. Always `idempotency_key_in_flight` for this body.",enum:["idempotency_key_in_flight"]},message:{type:"string",minLength:1,description:"The sentence the caller is shown."}}}]}}}},422:{description:"Unprocessable - the Idempotency-Key was already used with a different request body",content:{"text/plain":{schema:{type:"string"}}}},429:{description:"Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying.",headers:{"Retry-After":{description:"Number of seconds the caller must wait before retrying.",required:true,schema:{type:"integer",minimum:1}}},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`, `MeshkitError429`, `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"}}}}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/content-items/{contentItemId}":{get:{"x-internal":["cloud"],tags:["contentItems"],summary:"Get a content item by ID",operationId:"getContentItem","x-mcp":{expose:true,title:"Get a content item",scope:"content:read"},parameters:[{name:"contentItemId",in:"path",description:"Content item ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"X-Current-Orgid",in:"header",required:false,description:"Organization the call acts in, by ID (a UUID). When present, the server resolves the session organization from it instead of the caller's selected organization, and runs its membership and permission checks there. A caller who is not a live member of the named organization receives the same 404 as an unknown resource. Omitted, the caller's selected organization applies.",schema:{type:"string",minLength:36,maxLength:36,pattern:"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}}],responses:{200:{description:"Content item response",content:{"application/json":{schema:{$schema:"http://json-schema.org/draft-07/schema#",title:"Content Item Schema",description:`Server-returned content item as persisted by the owning service.
100
+ `,maxLength:255,"x-oapi-codegen-extra-tags":{db:"created_by_client",json:"createdByClient,omitempty"},"x-order":17},approvalPolicy:{description:"The item's own approval policy. Absent means inherit. An explicit `required` or `not_required` wins over every higher-level setting; `inherit` or absent inherits from higher-level settings (platform, workspace, profile), hierarchy defined in https://github.com/layer5io/meshery-cloud/issues/6365. Interim: until the upstream policies exist, `inherit` or absent resolves to `required`. Only a person with Decide Content Item Approvals may write a value that changes the stored one; an AI app never can. Changing it alone re-resolves the approval. A change whose result is required (`required`, or `inherit` or absent in the interim, which resolves to required) resets an approved item and opens its request. A change whose result is not required never changes `approved`, and any change leaves an unapproved item with an open request, whatever the result (see updateContentItem). Stored in the nullable `approval_policy` column; null means inherit, and a written `inherit` is stored as null, so reads return it absent.\n","x-oapi-codegen-extra-tags":{db:"approval_policy",json:"approvalPolicy,omitempty"},"x-order":18,type:"string",enum:["required","not_required","inherit"],"x-enum-varnames":["ApprovalPolicyRequired","ApprovalPolicyNotRequired","ApprovalPolicyInherit"]},approvalRequired:{type:"boolean",readOnly:true,description:"Server-computed and read-only: whether the item needs a person's approval, resolved at insert, again at each content edit, and again when `approvalPolicy` changes (see updateContentItem) from its `approvalPolicy` and the higher-level settings (hierarchy defined in https://github.com/layer5io/meshery-cloud/issues/6365). Stored in the `approval_required` column. Never in a payload. A change to `approvalPolicy` alone re-resolves it; a higher-level setting alone does not, and the next content edit resolves it again. Interim: until the upstream policies exist, an absent or `inherit` policy resolves to `true` (approval source `fallback`). Absent on items inserted before this field shipped.\n","x-oapi-codegen-extra-tags":{db:"approval_required",json:"approvalRequired,omitempty"},"x-order":19},approvalPolicySource:{type:"string",readOnly:true,description:"Server-computed and read-only: the level that decided `approvalRequired`, resolved at insert, again at each content edit, and again when `approvalPolicy` changes (see updateContentItem), stored in the `approval_policy_source` column. `item` when the item's own `approvalPolicy` was explicit; `fallback` when no level set a value and approval is required. The other levels name the higher level that set the value: `workspace`, `profile`, `organization` and `platform`, listed in their planned order (the hierarchy is defined in https://github.com/layer5io/meshery-cloud/issues/6365). Interim: until the upstream policies exist, only `item` and `fallback` are active (an absent or `inherit` policy resolves to `fallback`). The other four levels become active as that hierarchy lands. Never in a payload. Absent on items inserted before this field shipped.\n",enum:["item","workspace","profile","organization","platform","fallback"],"x-enum-varnames":["ApprovalPolicySourceItem","ApprovalPolicySourceWorkspace","ApprovalPolicySourceProfile","ApprovalPolicySourceOrganization","ApprovalPolicySourcePlatform","ApprovalPolicySourceFallback"],"x-oapi-codegen-extra-tags":{db:"approval_policy_source",json:"approvalPolicySource,omitempty"},"x-order":20}}}}}},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"}}}},403:{description:"Forbidden",content:{"text/plain":{schema:{type:"string"}}}},404:{description:"Result not found",content:{"text/plain":{schema:{type:"string"}}}},409:{description:"Conflict on insert. The body's `code` says which: `row_number_taken` or `thread_index_taken` is permanent for this payload, and `idempotency_key_in_flight` is a retry whose first request with the same Idempotency-Key is still being processed. Once the first request has finished without a 5xx, a retry receives the stored response; after a 5xx, a retry is processed as new. Nothing is inserted in any case.\n",content:{"application/json":{schema:{oneOf:[{type:"object",description:"Body of an insert refused for a permanent conflict with the content. `code` is the machine-readable reason and `message` the sentence the caller is shown. The in-flight retry body is `IdempotencyKeyInFlightError` in v1beta2 core.",additionalProperties:false,required:["code","message"],properties:{code:{type:"string",description:"`row_number_taken`: a live item of the organization holds the `rowNumber`. `thread_index_taken`: a live item of the same thread holds the `threadIndex`.\n",enum:["row_number_taken","thread_index_taken"]},message:{type:"string",minLength:1,description:"The sentence the caller is shown."}}},{type:"object",description:"A retry whose Idempotency-Key is still in flight. Nothing was created by this request. Once the first request has finished without a 5xx, a retry receives the stored response; after a 5xx, a retry is processed as new.",required:["code","message"],additionalProperties:false,properties:{code:{type:"string",description:"Machine-readable reason. Always `idempotency_key_in_flight` for this body.",enum:["idempotency_key_in_flight"]},message:{type:"string",minLength:1,description:"The sentence the caller is shown."}}}]}}}},422:{description:"Unprocessable - the Idempotency-Key was already used with a different request body",content:{"text/plain":{schema:{type:"string"}}}},429:{description:"Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying.",headers:{"Retry-After":{description:"Number of seconds the caller must wait before retrying.",required:true,schema:{type:"integer",minimum:1}}},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`, `MeshkitError429`, `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"}}}}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/content-items/{contentItemId}":{get:{"x-internal":["cloud"],tags:["contentItems"],summary:"Get a content item by ID",operationId:"getContentItem","x-mcp":{expose:true,title:"Get a content item",scope:"content:read",description:"Read-only. Returns the content item with the given ID in the organization of the authenticated session. An `X-Current-Orgid` that is not a UUID answers 400."},parameters:[{name:"contentItemId",in:"path",description:"Content item ID",required:true,schema:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}}},{name:"X-Current-Orgid",in:"header",required:false,description:"Organization the call acts in, by ID (a UUID). When present, the server resolves the session organization from it instead of the caller's selected organization, and runs its membership and permission checks there. A caller who is not a live member of the named organization receives the same 404 as an unknown resource. Omitted, the caller's selected organization applies.",schema:{type:"string",minLength:36,maxLength:36,pattern:"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}}],responses:{200:{description:"Content item response",content:{"application/json":{schema:{$schema:"http://json-schema.org/draft-07/schema#",title:"Content Item Schema",description:`Server-returned content item as persisted by the owning service.
101
101
  Content items carry a row number and a server-computed fingerprint over
102
102
  their canonical values; updates are conditional on the fingerprint the
103
103
  writer read, so stale writes are refused rather than silently applied.
@@ -6,7 +6,7 @@
6
6
  `,readOnly:true,"x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"OrganizationID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"organization_id",json:"organizationId"}},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},avatarUrl:{type:"string",format:"uri",maxLength:500,description:"URL to the avatar image of the user associated with the event."},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"}},correlationKey:{type:"string",description:"Key of the ongoing condition the event records (see Event.correlationKey); omitted for an event that reports no condition.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"correlation_key"}},occurrenceCount:{type:"integer",description:"How many occurrences of the condition the event counts (see Event.occurrenceCount). A create without a `correlationKey`, and a call that identifies no user, stores the payload's value exactly as sent, so an omitted count stays omitted. For a call that identifies a user and carries a `correlationKey`, it is the payload's `occurrenceCount` (1 when omitted) when the event was recorded, opening a condition or inserted already resolved, growing only as later creates that do not resolve are counted. A resolving create on the open event does not add to it.\n",minimum:1,"x-oapi-codegen-extra-tags":{db:"occurrence_count"}},firstSeenAt:{type:"string",format:"date-time",description:"When the condition's first counted occurrence was seen (see Event.firstSeenAt). A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `firstSeenAt`, else its `lastSeenAt`, else the time of receipt. An already-resolved insert stores the payload's `firstSeenAt`, else `resolvedAt`. A close keeps the stored time. Omitted when the payload omitted it and the create applied no default.\n","x-oapi-codegen-extra-tags":{db:"first_seen_at"}},lastSeenAt:{type:"string",format:"date-time",description:"When the condition was last seen (see Event.lastSeenAt). A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `lastSeenAt`, else `firstSeenAt`. An already-resolved insert stores the payload's `lastSeenAt`, else `resolvedAt`. Counting an occurrence, or closing one, brings the stored time forward. Omitted when the payload omitted it and the create applied no default.\n","x-oapi-codegen-extra-tags":{db:"last_seen_at"}},resolvedAt:{type:"string",format:"date-time",description:`When the condition cleared (see Event.resolvedAt). A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user it is omitted while the condition is open.
7
7
  `,"x-oapi-codegen-extra-tags":{db:"resolved_at"}},source:{type:"string",format:"uri-reference",description:"Which surface emitted the event, for example `meshery-server` or `mesheryctl` (see Event.source).",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"source"}},type:{type:"string",description:"CloudEvents-compatible `type`, for example `io.meshery.user.signup` (see Event.type).",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"type"}},specversion:{description:"The CloudEvents specification version the event is compatible with (see Event.specversion).",type:"string",enum:["1.0"],"x-go-type":"EventSpecVersion","x-go-name":"SpecVersion","x-oapi-codegen-extra-tags":{db:"specversion"}},traceId:{type:"string",description:"W3C Trace Context `trace-id` of the operation the event belongs to (see Event.traceId).",minLength:32,maxLength:32,pattern:"^[0-9a-f]*[1-9a-f][0-9a-f]*$","x-id-format":"external","x-go-name":"TraceID","x-oapi-codegen-extra-tags":{db:"trace_id"}},parentId:{type:"string",description:"W3C Trace Context `parent-id` of the sub-operation that emitted the event (see Event.parentId).",minLength:16,maxLength:16,pattern:"^[0-9a-f]*[1-9a-f][0-9a-f]*$","x-id-format":"external","x-go-name":"ParentID","x-oapi-codegen-extra-tags":{db:"parent_id"}},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id"}},actedUpon:{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:"acted_upon"}},operationId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"OperationID","x-oapi-codegen-extra-tags":{db:"operation_id"}},severity:{type:"string",description:"Event level (see Event.severity). MeshKit's producers set one of `emergency`, `alert`, `critical`, `error`, `warning`, `informational`, `debug` or `success`. The set is not closed on the wire, 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 (see Event.status). MeshKit records new events as `unread`, and acknowledged ones become `read`; consumers must tolerate other values.\n",maxLength:255,"x-oapi-codegen-extra-tags":{db:"status"}},metadata:{type:"object",description:"Event-specific details, the same nullable free-form map as Event.metadata. `null` when the producer attached none. On an error event, `metadata.error` holds only the MeshKit error, never the design or the request that failed: an EventError (the error's code, rendered descriptions, the causes and remediations that apply, `matchedCauses` and instance `details`), except that a design validation event whose operation did not complete (`status` `error`) carries it as a DesignEventOperationError. Rows recorded before EventError carry MeshKit's Go field names instead (`Code`, `Severity` as a number, `ShortDescription`, `LongDescription`, `ProbableCause` and `SuggestedRemediation` as lists); readers fall back to those keys when `code` is absent and treat their flat lists as unpaired.\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",json:"metadata,omitempty"}},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the event was last updated (see Event.updatedAt).","x-oapi-codegen-extra-tags":{db:"updated_at"}},deletedAt:{type:"string",format:"date-time",nullable:true,description:"Timestamp when the event was soft-deleted; omitted when it was not (see Event.deletedAt).","x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"}}},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"},429:{description:"Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying.",headers:{"Retry-After":{description:"Number of seconds the caller must wait before retrying.",required:true,schema:{type:"integer",minimum:1}}},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`, `MeshkitError429`, `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"}}}}}}},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`, `MeshkitError429`, `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"}}}},429:{description:"Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying.",headers:{"Retry-After":{description:"Number of seconds the caller must wait before retrying.",required:true,schema:{type:"integer",minimum:1}}},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`, `MeshkitError429`, `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"}}}}}}},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. If visibility is absent, the event is private.",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},visibility:{description:"Who can see the event. `private` is the default; clients may set `public` for events eligible for the unauthenticated feed.","x-oapi-codegen-extra-tags":{json:"visibility,omitempty"},type:"string",enum:["private","public"],default:"private","x-go-name":"EventVisibility"},action:{type:"string",description:"The action of the event.",maxLength:500},description:{type:"string",description:"Description of the event.",maxLength:5e3},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":{json:"severity,omitempty"}},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"}},correlationKey:{type:"string",description:"Optional key naming the ongoing condition this event reports, so repeated occurrences count on one open event instead of recording one each (see createEvent). Name the condition, not the occurrence, and qualify it by the emitting source and component plus the subject, for example `meshery-server/k8s-connection/<connectionId>/unreachable`. Never use an error code alone: codes are scoped to the component that owns them. Unlike `idempotencyKey`, which makes one create safe to retry, this key spans many creates.\n",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{json:"correlationKey,omitempty"}},occurrenceCount:{type:"integer",description:"Number of occurrences this create reports, for a producer that counted repeats locally before sending. A create without a `correlationKey`, and a call that identifies no user, stores this value exactly as sent, including when it is omitted. For a call that identifies a user and carries a `correlationKey`, omitted means 1. An opening create stores that count, counting an open condition adds it, and an already-resolved insert stores it. A resolving create on that open event does not add it.\n",minimum:1,"x-oapi-codegen-extra-tags":{json:"occurrenceCount,omitempty"}},firstSeenAt:{type:"string",format:"date-time",description:"When the producer first saw the occurrences this create reports. A call that identifies no user stores this value exactly as sent. For a call that identifies a user, omitted while opening a condition means `lastSeenAt`, or the time of receipt, and omitted on a resolving create that inserts an already resolved event means `resolvedAt`. Stored when that create opens a condition or inserts one already resolved; a close of an open condition keeps the stored time.\n","x-oapi-codegen-extra-tags":{json:"firstSeenAt,omitempty"}},lastSeenAt:{type:"string",format:"date-time",description:"When the producer last saw the occurrences this create reports. A call that identifies no user stores this value exactly as sent. For a call that identifies a user, omitted while opening a condition means `firstSeenAt`; omitted while counting an open condition, or while closing one, means the time of receipt; and omitted on a resolving create that inserts an already resolved event means `resolvedAt`.\n","x-oapi-codegen-extra-tags":{json:"lastSeenAt,omitempty"}},resolvedAt:{type:"string",format:"date-time",description:"When the condition named by `correlationKey` cleared. A call that identifies no user stores this value exactly as sent and does not match an open event. For a call that identifies a user, a create that carries it is a resolution: it closes that caller's open event with that key, copying this payload's `severity` and `description` onto the event when this payload carries them (an omitted field keeps the stored value) and setting `lastSeenAt` to the later of the stored time and this payload's `lastSeenAt` (the time of receipt when omitted), so the closed condition reads as cleared and the next occurrence opens a new condition (see createEvent). Give the resolution a severity and description that say what cleared, for example severity `success` and `Connection to cluster prod-1 restored`, under the condition's category.\n","x-oapi-codegen-extra-tags":{json:"resolvedAt,omitempty"}},source:{type:"string",format:"uri-reference",description:"Which surface emitted the event, as a CloudEvents-compatible `source` (a URI reference): `meshery-server`, `meshery-ui`, `mesheryctl`, `meshery-adapter-<name>` (for example `meshery-adapter-istio`), `layer5-cloud`, or another client's name. `systemId` says which instance; `source` says which kind of client, so a failure a person caused in the UI is told apart from the same failure from the CLI. An open set: a new surface needs no schema change.\n",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{json:"source,omitempty"}},type:{type:"string",description:"CloudEvents-compatible `type`: a reverse-DNS name of the kind of occurrence, for example `io.meshery.user.signup`. It does not replace `category` and `action`, which stay two free strings; `type` is for CloudEvents-aware consumers.\n",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{json:"type,omitempty"}},specversion:{description:"The CloudEvents specification version the event's `source`, `type` and `id` are compatible with, when the producer sets them as CloudEvents attributes. A Meshery event is CloudEvents compatible; it is not a CloudEvent.\n",type:"string",enum:["1.0"],"x-go-type":"EventSpecVersion","x-go-name":"SpecVersion","x-oapi-codegen-extra-tags":{json:"specversion,omitempty"}},traceId:{type:"string",description:"W3C Trace Context `trace-id` (32 lowercase hex digits, not all zeros) of the user-level operation the event belongs to, so the event joins the OpenTelemetry trace that operation recorded. The client that starts the operation mints it, and every event of the operation and its sub-operations carries it; the server never mints one at persist time.\n",minLength:32,maxLength:32,pattern:"^[0-9a-f]*[1-9a-f][0-9a-f]*$","x-id-format":"external","x-go-name":"TraceID","x-oapi-codegen-extra-tags":{json:"traceId,omitempty"}},parentId:{type:"string",description:"W3C Trace Context `parent-id` (16 lowercase hex digits, not all zeros): the span of the sub-operation that emitted the event, so the events of one operation form its tree. Minted by the client with `traceId`, never by the server.\n",minLength:16,maxLength:16,pattern:"^[0-9a-f]*[1-9a-f][0-9a-f]*$","x-id-format":"external","x-go-name":"ParentID","x-oapi-codegen-extra-tags":{json:"parentId,omitempty"}}}}}}},description:"Records an event and answers 201 with it. The server assigns the organization from the session; clients do not send it. A server MAY answer a legacy create, one carrying neither `correlationKey` nor `idempotencyKey`, with 200 and `Event-Disposition: created`, for compatibility with released Meshery Servers that treat any non-200 answer as failure. Clients accept any 2xx and read `Event-Disposition` rather than the status code to tell created from replayed.\n\n**Retries (`idempotencyKey`).** When the payload carries an `idempotencyKey` the authenticated caller already used, nothing is recorded or changed and the answer is 200 with the event that key is bound to (`Event-Disposition: replayed`). This check runs first, so a retried create never counts an occurrence twice.\n\n**Conditions (`correlationKey`).** A payload that carries a `correlationKey` reports an occurrence of an ongoing condition. A call that identifies no user records a new event and stores the correlation fields exactly as sent: no defaults are applied and no open event is matched, whether or not the payload carries `resolvedAt` (201, `Event-Disposition: created`). The open, increment and resolution rules below apply only to a call that identifies a user. A condition is open while its event has no `resolvedAt`, and that caller (organization and user, as for `idempotencyKey`) has at most one open event per key; the server enforces that atomically. For a payload without `resolvedAt`: when that caller has an open event with the key, no event is recorded; that event's `occurrenceCount` grows by the payload's `occurrenceCount` (1 when omitted), its `lastSeenAt` becomes the later of its own and the payload's `lastSeenAt` (the time of receipt when omitted), and its `updatedAt` advances. The answer is 200 with it (`Event-Disposition: incremented`). Every other field keeps the value it was first recorded with. Otherwise a new event is recorded, which opens the condition: `occurrenceCount` defaults to 1, `firstSeenAt` to the payload's `firstSeenAt`, else its `lastSeenAt`, else the time of receipt, and `lastSeenAt` to the payload's `lastSeenAt`, else `firstSeenAt` (201, `Event-Disposition: created`).\n\n**Resolution.** Only a call that identifies a user resolves. A producer closes a condition by creating an event with the condition's `correlationKey` and a `resolvedAt` time, after the condition clears. When that caller has an open event with the key, nothing new is recorded: that event gets the `resolvedAt`, its `severity` and `description` become the payload's when the payload carries them (an omitted field keeps the stored value) so the closed condition reads as cleared, its `lastSeenAt` becomes the later of its own and the payload's `lastSeenAt` (the time of receipt when omitted), and its `updatedAt` advances. The answer is 200 with the closed event (`Event-Disposition: resolved`). Every other field keeps the value it was recorded with, so `occurrenceCount` does not grow. When none is open, the payload is recorded as a new, already resolved event, using the opening defaults: `occurrenceCount` is the payload's (1 when omitted), and `firstSeenAt` and `lastSeenAt` are the payload's, else `resolvedAt` (201, `created`). Once closed, the next occurrence opens a new condition with a new event. Send a resolution only when the condition changes from present to cleared, never on every healthy check.\n\n**Composition.** When a create that carries both keys does not replay, its `idempotencyKey` is bound to the event the create recorded, incremented or resolved, so a retry answers 200 with that event and changes nothing. Deduplication a server applies on its own, without a client key, must not swallow an occurrence of an event that carries a `correlationKey`. A call that identifies a user counts the occurrence; a call that identifies no user is recorded as a new event with the correlation fields stored exactly as sent. Whether a counted occurrence notifies anyone again is the reader's policy, not this operation's. See docs/event-correlation-contract.md.\n",responses:{200:{description:"The event the create resolved to. When no new event was recorded, that is the one already recorded under this caller's `idempotencyKey` (`replayed`, unchanged) or, for a call that identifies a user, the open event of this `correlationKey` with the occurrence counted (`incremented`), or that event closed by the payload's `resolvedAt`, with its `severity` and `description` replaced by the payload's when the payload carries them (an omitted field keeps the stored value) and its `lastSeenAt` brought forward (`resolved`). A call that identifies no user records a new event instead, with the correlation fields stored exactly as sent. A server MAY also answer a legacy create, one carrying neither `correlationKey` nor `idempotencyKey`, with 200 and `Event-Disposition: created`, returning the event it just recorded, for compatibility with released Meshery Servers that treat any non-200 answer as failure. Clients accept any 2xx and read `Event-Disposition` rather than the status code to tell created from replayed.\n",headers:{"Event-Disposition":{description:"What `createEvent` did with the payload: `created` (a new event was recorded), `replayed` (the `idempotencyKey` was already used; nothing changed), `incremented` (an occurrence of the open condition with this `correlationKey` was counted) or `resolved` (that condition was closed). `incremented` and `resolved` apply only to a call that identifies a user; a call that identifies no user is `created`, with the correlation fields stored exactly as sent. A server MAY answer a legacy create, one carrying neither `correlationKey` nor `idempotencyKey`, with 200 and `created`, for compatibility with released Meshery Servers that treat any non-200 answer as failure. Clients accept any 2xx and read this header rather than the status code to tell created from replayed. A server that implements condition correlation sends it on every 200 and 201. A server that predates correlation omits it; there 201 means created and 200 means replayed. A browser client calling a server on another origin reads it only when that server lists it in `Access-Control-Expose-Headers`.\n",required:false,schema:{type:"string",enum:["created","replayed","incremented","resolved"]}}},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","organizationId","createdAt","updatedAt","visibility"],properties:{id:{description:"Event ID.","x-oapi-codegen-extra-tags":{db:"id"},"x-order":7,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"},"x-order":1,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"},"x-order":2},category:{type:"string",description:"Resource kind the operation was invoked on, for example `pattern`.",maxLength:500,"x-oapi-codegen-extra-tags":{db:"category"},"x-order":3},description:{type:"string",description:"Human-readable summary of what happened.",maxLength:5e3,"x-oapi-codegen-extra-tags":{db:"description"},"x-order":6},metadata:{type:"object",description:"Event-specific details; the structure varies by event kind. `null` when the producer attached none. It stays a free-form map; design events fill it with a named shape: RelationshipEvaluationEventMetadata (category `relationship`, action `evaluation`), DesignValidationEventMetadata (category `pattern`, actions `validate`, `deploy`, `undeploy`, `dry-run`) and DesignSavedEventMetadata (category `pattern`, actions `create`, `update`); ScheduleCompletedEventMetadata (category `schedule`, action `completed`); DesignEventIdentity names the design. Never put design contents into event metadata - no `designFile`, `patternFile`, `components`, `relationships`, `trace`, `evaluationResponse`, the raw `summary` or `validationResult`. Meshery Server applies a 16 KB guard that drops oversized metadata down to the identity fields (`designId`, `designName`, `designVersion`, `designLink`, `viewLink`). On an error event, `metadata.error` holds only the MeshKit error, never the design or the request that failed: an EventError (the error's code, rendered descriptions, the causes and remediations that apply, `matchedCauses` and instance `details`; docs/error-definition-contract.md), except that a design validation event whose operation did not complete (`status` `error`) carries it as a DesignEventOperationError. Rows recorded before EventError carry MeshKit's Go field names instead (`Code`, `Severity` as a number, `ShortDescription`, `LongDescription`, `ProbableCause` and `SuggestedRemediation` as lists); readers fall back to those keys when `code` is absent and treat their flat lists as unpaired. Older Meshery Cloud rows may carry the legacy `design_name` and `view_link` keys; readers should fall back to them when `designName` and `viewLink` are absent.\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"},"x-order":8},operationId:{description:"ID correlating the events one operation emitted.","x-go-name":"OperationID","x-oapi-codegen-extra-tags":{db:"operation_id"},"x-order":9,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"},"x-order":12},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"},"x-order":13},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","x-order":14,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"},"x-order":10},organizationId:{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"},readOnly:true,"x-go-name":"OrganizationID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"organization_id",json:"organizationId"},"x-order":11},createdAt:{description:"Timestamp when the event was recorded.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":4,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"},"x-order":15,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},visibility:{description:"Who can see the event. Defaults to `private`.","x-oapi-codegen-extra-tags":{db:"visibility",json:"visibility"},"x-order":16,type:"string",enum:["private","public"],default:"private","x-go-name":"EventVisibility"},deletedAt:{description:"Timestamp when the event was soft-deleted; omitted when it was not.","x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":5,"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},correlationKey:{type:"string",description:`Key of the ongoing condition the event records (see EventPayload.correlationKey and createEvent); omitted for an event that reports no condition.
8
8
  `,minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"correlation_key"},"x-order":17},occurrenceCount:{type:"integer",description:"How many occurrences of the condition this event counts. A create without a `correlationKey`, and a call that identifies no user, stores the payload's value exactly as sent, so an omitted count stays omitted. For a call that identifies a user and carries a `correlationKey`, an opening create or a resolving create inserted already resolved stores the payload's `occurrenceCount` (1 when omitted). Later creates that do not resolve add their count. A resolving create on the open event does not add to it.\n",minimum:1,"x-oapi-codegen-extra-tags":{db:"occurrence_count"},"x-order":18},firstSeenAt:{type:"string",format:"date-time",description:"When the condition's first counted occurrence was seen. A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `firstSeenAt`, else its `lastSeenAt`, else the time of receipt. An already-resolved insert stores the payload's `firstSeenAt`, else `resolvedAt`. A close keeps the stored time. Omitted when the payload omitted it and the create applied no default.\n","x-oapi-codegen-extra-tags":{db:"first_seen_at"},"x-order":19},lastSeenAt:{type:"string",format:"date-time",description:"When the condition was last seen. A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `lastSeenAt`, else `firstSeenAt`. An already-resolved insert stores the payload's `lastSeenAt`, else `resolvedAt`. Counting an occurrence, or closing one, brings the stored time forward. Omitted when the payload omitted it and the create applied no default.\n","x-oapi-codegen-extra-tags":{db:"last_seen_at"},"x-order":20},resolvedAt:{type:"string",format:"date-time",description:"When the condition cleared. A call that identifies no user stores the payload's value exactly as sent and does not close another event. For a call that identifies a user it is omitted while the condition is open, and set by a resolution (see createEvent), which also replaces `severity` and `description` with the payload's when the payload carries them (an omitted field keeps the stored value) and brings `lastSeenAt` forward, after which a new occurrence opens a new event.\n","x-oapi-codegen-extra-tags":{db:"resolved_at"},"x-order":21},source:{type:"string",format:"uri-reference",description:"Which surface emitted the event (CloudEvents-compatible `source`), for example `meshery-server`, `meshery-ui`, `mesheryctl` or `meshery-adapter-istio`; see EventPayload.source. Omitted when the producer did not say.\n",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"source"},"x-order":22},type:{type:"string",description:"CloudEvents-compatible `type`, for example `io.meshery.user.signup`; see EventPayload.type. `category` and `action` stay the event's classification.\n",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"type"},"x-order":23},specversion:{description:"The CloudEvents specification version the event is compatible with; see EventPayload.specversion.",type:"string",enum:["1.0"],"x-go-type":"EventSpecVersion","x-go-name":"SpecVersion","x-oapi-codegen-extra-tags":{db:"specversion"},"x-order":24},traceId:{type:"string",description:"W3C Trace Context `trace-id` of the operation the event belongs to, as its client minted it; see EventPayload.traceId.\n",minLength:32,maxLength:32,pattern:"^[0-9a-f]*[1-9a-f][0-9a-f]*$","x-id-format":"external","x-go-name":"TraceID","x-oapi-codegen-extra-tags":{db:"trace_id"},"x-order":25},parentId:{type:"string",description:"W3C Trace Context `parent-id` of the sub-operation that emitted the event; see EventPayload.parentId.\n",minLength:16,maxLength:16,pattern:"^[0-9a-f]*[1-9a-f][0-9a-f]*$","x-id-format":"external","x-go-name":"ParentID","x-oapi-codegen-extra-tags":{db:"parent_id"},"x-order":26}}}}}},201:{description:"A new event was recorded (`Event-Disposition: created`). A call that identifies no user stores the correlation fields exactly as sent. For a call that identifies a user and carries a `correlationKey`, the event opens a condition, or records one already resolved when the payload carries `resolvedAt`. An already resolved insert uses `occurrenceCount` 1 when omitted, and `firstSeenAt` and `lastSeenAt` from the payload, else `resolvedAt`.\n",headers:{"Event-Disposition":{description:"What `createEvent` did with the payload: `created` (a new event was recorded), `replayed` (the `idempotencyKey` was already used; nothing changed), `incremented` (an occurrence of the open condition with this `correlationKey` was counted) or `resolved` (that condition was closed). `incremented` and `resolved` apply only to a call that identifies a user; a call that identifies no user is `created`, with the correlation fields stored exactly as sent. A server MAY answer a legacy create, one carrying neither `correlationKey` nor `idempotencyKey`, with 200 and `created`, for compatibility with released Meshery Servers that treat any non-200 answer as failure. Clients accept any 2xx and read this header rather than the status code to tell created from replayed. A server that implements condition correlation sends it on every 200 and 201. A server that predates correlation omits it; there 201 means created and 200 means replayed. A browser client calling a server on another origin reads it only when that server lists it in `Access-Control-Expose-Headers`.\n",required:false,schema:{type:"string",enum:["created","replayed","incremented","resolved"]}}},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","organizationId","createdAt","updatedAt","visibility"],properties:{id:{description:"Event ID.","x-oapi-codegen-extra-tags":{db:"id"},"x-order":7,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"},"x-order":1,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"},"x-order":2},category:{type:"string",description:"Resource kind the operation was invoked on, for example `pattern`.",maxLength:500,"x-oapi-codegen-extra-tags":{db:"category"},"x-order":3},description:{type:"string",description:"Human-readable summary of what happened.",maxLength:5e3,"x-oapi-codegen-extra-tags":{db:"description"},"x-order":6},metadata:{type:"object",description:"Event-specific details; the structure varies by event kind. `null` when the producer attached none. It stays a free-form map; design events fill it with a named shape: RelationshipEvaluationEventMetadata (category `relationship`, action `evaluation`), DesignValidationEventMetadata (category `pattern`, actions `validate`, `deploy`, `undeploy`, `dry-run`) and DesignSavedEventMetadata (category `pattern`, actions `create`, `update`); ScheduleCompletedEventMetadata (category `schedule`, action `completed`); DesignEventIdentity names the design. Never put design contents into event metadata - no `designFile`, `patternFile`, `components`, `relationships`, `trace`, `evaluationResponse`, the raw `summary` or `validationResult`. Meshery Server applies a 16 KB guard that drops oversized metadata down to the identity fields (`designId`, `designName`, `designVersion`, `designLink`, `viewLink`). On an error event, `metadata.error` holds only the MeshKit error, never the design or the request that failed: an EventError (the error's code, rendered descriptions, the causes and remediations that apply, `matchedCauses` and instance `details`; docs/error-definition-contract.md), except that a design validation event whose operation did not complete (`status` `error`) carries it as a DesignEventOperationError. Rows recorded before EventError carry MeshKit's Go field names instead (`Code`, `Severity` as a number, `ShortDescription`, `LongDescription`, `ProbableCause` and `SuggestedRemediation` as lists); readers fall back to those keys when `code` is absent and treat their flat lists as unpaired. Older Meshery Cloud rows may carry the legacy `design_name` and `view_link` keys; readers should fall back to them when `designName` and `viewLink` are absent.\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"},"x-order":8},operationId:{description:"ID correlating the events one operation emitted.","x-go-name":"OperationID","x-oapi-codegen-extra-tags":{db:"operation_id"},"x-order":9,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"},"x-order":12},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"},"x-order":13},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","x-order":14,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"},"x-order":10},organizationId:{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"},readOnly:true,"x-go-name":"OrganizationID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"organization_id",json:"organizationId"},"x-order":11},createdAt:{description:"Timestamp when the event was recorded.","x-oapi-codegen-extra-tags":{db:"created_at"},"x-order":4,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"},"x-order":15,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},visibility:{description:"Who can see the event. Defaults to `private`.","x-oapi-codegen-extra-tags":{db:"visibility",json:"visibility"},"x-order":16,type:"string",enum:["private","public"],default:"private","x-go-name":"EventVisibility"},deletedAt:{description:"Timestamp when the event was soft-deleted; omitted when it was not.","x-oapi-codegen-extra-tags":{db:"deleted_at"},"x-order":5,"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},correlationKey:{type:"string",description:`Key of the ongoing condition the event records (see EventPayload.correlationKey and createEvent); omitted for an event that reports no condition.
9
- `,minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"correlation_key"},"x-order":17},occurrenceCount:{type:"integer",description:"How many occurrences of the condition this event counts. A create without a `correlationKey`, and a call that identifies no user, stores the payload's value exactly as sent, so an omitted count stays omitted. For a call that identifies a user and carries a `correlationKey`, an opening create or a resolving create inserted already resolved stores the payload's `occurrenceCount` (1 when omitted). Later creates that do not resolve add their count. A resolving create on the open event does not add to it.\n",minimum:1,"x-oapi-codegen-extra-tags":{db:"occurrence_count"},"x-order":18},firstSeenAt:{type:"string",format:"date-time",description:"When the condition's first counted occurrence was seen. A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `firstSeenAt`, else its `lastSeenAt`, else the time of receipt. An already-resolved insert stores the payload's `firstSeenAt`, else `resolvedAt`. A close keeps the stored time. Omitted when the payload omitted it and the create applied no default.\n","x-oapi-codegen-extra-tags":{db:"first_seen_at"},"x-order":19},lastSeenAt:{type:"string",format:"date-time",description:"When the condition was last seen. A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `lastSeenAt`, else `firstSeenAt`. An already-resolved insert stores the payload's `lastSeenAt`, else `resolvedAt`. Counting an occurrence, or closing one, brings the stored time forward. Omitted when the payload omitted it and the create applied no default.\n","x-oapi-codegen-extra-tags":{db:"last_seen_at"},"x-order":20},resolvedAt:{type:"string",format:"date-time",description:"When the condition cleared. A call that identifies no user stores the payload's value exactly as sent and does not close another event. For a call that identifies a user it is omitted while the condition is open, and set by a resolution (see createEvent), which also replaces `severity` and `description` with the payload's when the payload carries them (an omitted field keeps the stored value) and brings `lastSeenAt` forward, after which a new occurrence opens a new event.\n","x-oapi-codegen-extra-tags":{db:"resolved_at"},"x-order":21},source:{type:"string",format:"uri-reference",description:"Which surface emitted the event (CloudEvents-compatible `source`), for example `meshery-server`, `meshery-ui`, `mesheryctl` or `meshery-adapter-istio`; see EventPayload.source. Omitted when the producer did not say.\n",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"source"},"x-order":22},type:{type:"string",description:"CloudEvents-compatible `type`, for example `io.meshery.user.signup`; see EventPayload.type. `category` and `action` stay the event's classification.\n",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"type"},"x-order":23},specversion:{description:"The CloudEvents specification version the event is compatible with; see EventPayload.specversion.",type:"string",enum:["1.0"],"x-go-type":"EventSpecVersion","x-go-name":"SpecVersion","x-oapi-codegen-extra-tags":{db:"specversion"},"x-order":24},traceId:{type:"string",description:"W3C Trace Context `trace-id` of the operation the event belongs to, as its client minted it; see EventPayload.traceId.\n",minLength:32,maxLength:32,pattern:"^[0-9a-f]*[1-9a-f][0-9a-f]*$","x-id-format":"external","x-go-name":"TraceID","x-oapi-codegen-extra-tags":{db:"trace_id"},"x-order":25},parentId:{type:"string",description:"W3C Trace Context `parent-id` of the sub-operation that emitted the event; see EventPayload.parentId.\n",minLength:16,maxLength:16,pattern:"^[0-9a-f]*[1-9a-f][0-9a-f]*$","x-id-format":"external","x-go-name":"ParentID","x-oapi-codegen-extra-tags":{db:"parent_id"},"x-order":26}}}}}},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"}}}},429:{description:"Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying.",headers:{"Retry-After":{description:"Number of seconds the caller must wait before retrying.",required:true,schema:{type:"integer",minimum:1}}},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`, `MeshkitError429`, `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"}}}}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/events/list":{get:{"x-internal":["cloud"],tags:["events"],operationId:"getEvents","x-mcp":{expose:true,title:"Get events",scope:"events:read"},summary:"Get events list",description:"Returns a page of events. An `X-Current-Orgid` that is not a UUID answers 400.\n",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"}},{name:"scope",in:"query",required:false,description:"Which events are returned. `user` (default): only the caller's own events (unchanged behavior). `organization`: every member's events in the caller's session organization. Requires organization administration permission in the session organization; callers without it get 403.\n",schema:{type:"string",enum:["user","organization"],default:"user"}},{name:"X-Current-Orgid",in:"header",required:false,description:"Organization the call acts in, by ID (a UUID). When present, the server resolves the session organization from it instead of the caller's selected organization, and runs its membership and permission checks there. A caller who is not a live member of the named organization receives the same 404 as an unknown resource. Omitted, the caller's selected organization applies.",schema:{type:"string",minLength:36,maxLength:36,pattern:"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}}],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:{visibility:{type:"string",description:"Who can see the event. `private` (the default, set by Layer5 Cloud) means visible only inside the event's organization. `public` means the event may appear on the unauthenticated event feed, subject to the owner's `shareActivityPublicly` preference at read time.",enum:["private","public"],default:"private","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"visibility",json:"visibility"}},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.
9
+ `,minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"correlation_key"},"x-order":17},occurrenceCount:{type:"integer",description:"How many occurrences of the condition this event counts. A create without a `correlationKey`, and a call that identifies no user, stores the payload's value exactly as sent, so an omitted count stays omitted. For a call that identifies a user and carries a `correlationKey`, an opening create or a resolving create inserted already resolved stores the payload's `occurrenceCount` (1 when omitted). Later creates that do not resolve add their count. A resolving create on the open event does not add to it.\n",minimum:1,"x-oapi-codegen-extra-tags":{db:"occurrence_count"},"x-order":18},firstSeenAt:{type:"string",format:"date-time",description:"When the condition's first counted occurrence was seen. A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `firstSeenAt`, else its `lastSeenAt`, else the time of receipt. An already-resolved insert stores the payload's `firstSeenAt`, else `resolvedAt`. A close keeps the stored time. Omitted when the payload omitted it and the create applied no default.\n","x-oapi-codegen-extra-tags":{db:"first_seen_at"},"x-order":19},lastSeenAt:{type:"string",format:"date-time",description:"When the condition was last seen. A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `lastSeenAt`, else `firstSeenAt`. An already-resolved insert stores the payload's `lastSeenAt`, else `resolvedAt`. Counting an occurrence, or closing one, brings the stored time forward. Omitted when the payload omitted it and the create applied no default.\n","x-oapi-codegen-extra-tags":{db:"last_seen_at"},"x-order":20},resolvedAt:{type:"string",format:"date-time",description:"When the condition cleared. A call that identifies no user stores the payload's value exactly as sent and does not close another event. For a call that identifies a user it is omitted while the condition is open, and set by a resolution (see createEvent), which also replaces `severity` and `description` with the payload's when the payload carries them (an omitted field keeps the stored value) and brings `lastSeenAt` forward, after which a new occurrence opens a new event.\n","x-oapi-codegen-extra-tags":{db:"resolved_at"},"x-order":21},source:{type:"string",format:"uri-reference",description:"Which surface emitted the event (CloudEvents-compatible `source`), for example `meshery-server`, `meshery-ui`, `mesheryctl` or `meshery-adapter-istio`; see EventPayload.source. Omitted when the producer did not say.\n",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"source"},"x-order":22},type:{type:"string",description:"CloudEvents-compatible `type`, for example `io.meshery.user.signup`; see EventPayload.type. `category` and `action` stay the event's classification.\n",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"type"},"x-order":23},specversion:{description:"The CloudEvents specification version the event is compatible with; see EventPayload.specversion.",type:"string",enum:["1.0"],"x-go-type":"EventSpecVersion","x-go-name":"SpecVersion","x-oapi-codegen-extra-tags":{db:"specversion"},"x-order":24},traceId:{type:"string",description:"W3C Trace Context `trace-id` of the operation the event belongs to, as its client minted it; see EventPayload.traceId.\n",minLength:32,maxLength:32,pattern:"^[0-9a-f]*[1-9a-f][0-9a-f]*$","x-id-format":"external","x-go-name":"TraceID","x-oapi-codegen-extra-tags":{db:"trace_id"},"x-order":25},parentId:{type:"string",description:"W3C Trace Context `parent-id` of the sub-operation that emitted the event; see EventPayload.parentId.\n",minLength:16,maxLength:16,pattern:"^[0-9a-f]*[1-9a-f][0-9a-f]*$","x-id-format":"external","x-go-name":"ParentID","x-oapi-codegen-extra-tags":{db:"parent_id"},"x-order":26}}}}}},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"}}}},429:{description:"Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying.",headers:{"Retry-After":{description:"Number of seconds the caller must wait before retrying.",required:true,schema:{type:"integer",minimum:1}}},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`, `MeshkitError429`, `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"}}}}}}},500:{description:"Internal server error",content:{"text/plain":{schema:{type:"string"}}}}}}},"/api/events/list":{get:{"x-internal":["cloud"],tags:["events"],operationId:"getEvents","x-mcp":{expose:true,title:"Get events",scope:"events:read",description:"Read-only. Returns a page of events. An `X-Current-Orgid` that is not a UUID answers 400."},summary:"Get events list",description:"Returns a page of events. An `X-Current-Orgid` that is not a UUID answers 400.\n",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"}},{name:"scope",in:"query",required:false,description:"Which events are returned. `user` (default): only the caller's own events (unchanged behavior). `organization`: every member's events in the caller's session organization. Requires organization administration permission in the session organization; callers without it get 403.\n",schema:{type:"string",enum:["user","organization"],default:"user"}},{name:"X-Current-Orgid",in:"header",required:false,description:"Organization the call acts in, by ID (a UUID). When present, the server resolves the session organization from it instead of the caller's selected organization, and runs its membership and permission checks there. A caller who is not a live member of the named organization receives the same 404 as an unknown resource. Omitted, the caller's selected organization applies.",schema:{type:"string",minLength:36,maxLength:36,pattern:"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"}}],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:{visibility:{type:"string",description:"Who can see the event. `private` (the default, set by Layer5 Cloud) means visible only inside the event's organization. `public` means the event may appear on the unauthenticated event feed, subject to the owner's `shareActivityPublicly` preference at read time.",enum:["private","public"],default:"private","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"visibility",json:"visibility"}},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.
10
10
  `,maxLength:255,"x-id-format":"external","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"system_id",json:"systemId"}},organizationId:{type:"string",format:"uuid",description:`The organization the event belongs to (see Event.organizationId). Set by the server; lets an organization-scope listing show each row's tenant.
11
11
  `,readOnly:true,"x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"OrganizationID","x-go-type-skip-optional-pointer":true,"x-oapi-codegen-extra-tags":{db:"organization_id",json:"organizationId"}},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},avatarUrl:{type:"string",format:"uri",maxLength:500,description:"URL to the avatar image of the user associated with the event."},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"}},correlationKey:{type:"string",description:"Key of the ongoing condition the event records (see Event.correlationKey); omitted for an event that reports no condition.",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"correlation_key"}},occurrenceCount:{type:"integer",description:"How many occurrences of the condition the event counts (see Event.occurrenceCount). A create without a `correlationKey`, and a call that identifies no user, stores the payload's value exactly as sent, so an omitted count stays omitted. For a call that identifies a user and carries a `correlationKey`, it is the payload's `occurrenceCount` (1 when omitted) when the event was recorded, opening a condition or inserted already resolved, growing only as later creates that do not resolve are counted. A resolving create on the open event does not add to it.\n",minimum:1,"x-oapi-codegen-extra-tags":{db:"occurrence_count"}},firstSeenAt:{type:"string",format:"date-time",description:"When the condition's first counted occurrence was seen (see Event.firstSeenAt). A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `firstSeenAt`, else its `lastSeenAt`, else the time of receipt. An already-resolved insert stores the payload's `firstSeenAt`, else `resolvedAt`. A close keeps the stored time. Omitted when the payload omitted it and the create applied no default.\n","x-oapi-codegen-extra-tags":{db:"first_seen_at"}},lastSeenAt:{type:"string",format:"date-time",description:"When the condition was last seen (see Event.lastSeenAt). A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user, an opening create stores the payload's `lastSeenAt`, else `firstSeenAt`. An already-resolved insert stores the payload's `lastSeenAt`, else `resolvedAt`. Counting an occurrence, or closing one, brings the stored time forward. Omitted when the payload omitted it and the create applied no default.\n","x-oapi-codegen-extra-tags":{db:"last_seen_at"}},resolvedAt:{type:"string",format:"date-time",description:`When the condition cleared (see Event.resolvedAt). A call that identifies no user stores the payload's value exactly as sent. For a call that identifies a user it is omitted while the condition is open.
12
12
  `,"x-oapi-codegen-extra-tags":{db:"resolved_at"}},source:{type:"string",format:"uri-reference",description:"Which surface emitted the event, for example `meshery-server` or `mesheryctl` (see Event.source).",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"source"}},type:{type:"string",description:"CloudEvents-compatible `type`, for example `io.meshery.user.signup` (see Event.type).",minLength:1,maxLength:255,"x-oapi-codegen-extra-tags":{db:"type"}},specversion:{description:"The CloudEvents specification version the event is compatible with (see Event.specversion).",type:"string",enum:["1.0"],"x-go-type":"EventSpecVersion","x-go-name":"SpecVersion","x-oapi-codegen-extra-tags":{db:"specversion"}},traceId:{type:"string",description:"W3C Trace Context `trace-id` of the operation the event belongs to (see Event.traceId).",minLength:32,maxLength:32,pattern:"^[0-9a-f]*[1-9a-f][0-9a-f]*$","x-id-format":"external","x-go-name":"TraceID","x-oapi-codegen-extra-tags":{db:"trace_id"}},parentId:{type:"string",description:"W3C Trace Context `parent-id` of the sub-operation that emitted the event (see Event.parentId).",minLength:16,maxLength:16,pattern:"^[0-9a-f]*[1-9a-f][0-9a-f]*$","x-id-format":"external","x-go-name":"ParentID","x-oapi-codegen-extra-tags":{db:"parent_id"}},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{db:"id"}},actedUpon:{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:"acted_upon"}},operationId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-name":"OperationID","x-oapi-codegen-extra-tags":{db:"operation_id"}},severity:{type:"string",description:"Event level (see Event.severity). MeshKit's producers set one of `emergency`, `alert`, `critical`, `error`, `warning`, `informational`, `debug` or `success`. The set is not closed on the wire, 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 (see Event.status). MeshKit records new events as `unread`, and acknowledged ones become `read`; consumers must tolerate other values.\n",maxLength:255,"x-oapi-codegen-extra-tags":{db:"status"}},metadata:{type:"object",description:"Event-specific details, the same nullable free-form map as Event.metadata. `null` when the producer attached none. On an error event, `metadata.error` holds only the MeshKit error, never the design or the request that failed: an EventError (the error's code, rendered descriptions, the causes and remediations that apply, `matchedCauses` and instance `details`), except that a design validation event whose operation did not complete (`status` `error`) carries it as a DesignEventOperationError. Rows recorded before EventError carry MeshKit's Go field names instead (`Code`, `Severity` as a number, `ShortDescription`, `LongDescription`, `ProbableCause` and `SuggestedRemediation` as lists); readers fall back to those keys when `code` is absent and treat their flat lists as unpaired.\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",json:"metadata,omitempty"}},updatedAt:{type:"string",format:"date-time",description:"Timestamp when the event was last updated (see Event.updatedAt).","x-oapi-codegen-extra-tags":{db:"updated_at"}},deletedAt:{type:"string",format:"date-time",nullable:true,description:"Timestamp when the event was soft-deleted; omitted when it was not (see Event.deletedAt).","x-oapi-codegen-extra-tags":{db:"deleted_at",json:"deletedAt,omitempty"}}},required:["owner","category","action"]},description:"The events returned on the current page."}}}}}},400:{description:"Invalid request body or request param",content:{"text/plain":{schema:{type:"string"}}}},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`, `MeshkitError429`, `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"},429:{description:"Too many requests - the caller exceeded the server's per-user request rate for this route family. Wait the number of seconds in `Retry-After` before retrying.",headers:{"Retry-After":{description:"Number of seconds the caller must wait before retrying.",required:true,schema:{type:"integer",minimum:1}}},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`, `MeshkitError429`, `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"}}}}}}},500:{description:"Server error"}}}},"/api/events/feed":{get:{"x-internal":["cloud"],tags:["events"],operationId:"getEventFeed",summary:"Get event feed",description:"Generic, unauthenticated feed of events whose visibility is `public`\nand whose owner's `shareActivityPublicly` preference is on at read\ntime. Results are ordered newest first by `createdAt` and can be\nfiltered by category and action. Rate limited per client IP; an\nover-limit client receives 429 with `Retry-After`. Responses carry\n`Cache-Control: public, max-age=N` where N is at most 30 seconds.\nSee docs/event-feed-contract.md.\n",security:[],parameters:[{name:"page",in:"query",description:"Get responses by page",schema:{type:"integer",minimum:0}},{name:"pagesize",in:"query",required:false,description:"Number of feed items per page.",schema:{type:"integer",minimum:1,maximum:50,default:20}},{name:"category",in:"query",required:false,description:"Optional event category filter.",schema:{type:"string",maxLength:500}},{name:"action",in:"query",required:false,description:"Optional event action filter.",schema:{type:"string",maxLength:500}}],responses:{200:{description:"Event feed page",headers:{"Cache-Control":{description:"`public, max-age=N` with N from 0 to 30; max-age never exceeds 30 seconds.",required:true,schema:{type:"string",pattern:"^public, max-age=([0-9]|[12][0-9]|30)$"}}},content:{"application/json":{schema:{type:"object",additionalProperties:false,description:"One page of event feed items, newest first.",required:["page","pageSize","totalCount","data"],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,maximum:50},totalCount:{type:"integer",description:"Total number of matching feed events.",minimum:0},data:{type:"array",maxItems:50,items:{type:"object",additionalProperties:false,description:"An event projected into the public feed. It never includes email,\nfirstName, lastName, description, provider or raw metadata.\n`platform`, `role`, `line` and `networks` are projected from\nScheduleCompletedEventMetadata; events without valid required\nmetadata are skipped. Public profile fields are resolved by Cloud at\nread time for every served owner (live, active, and\nshareActivityPublicly on).\n",required:["id","userId","category","action","createdAt","visibility","platform","role","line"],properties:{id:{description:"Event ID.","x-go-name":"ID","x-order":1,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},userId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":2},category:{type:"string",description:"Event category.",maxLength:500,"x-order":3},action:{type:"string",description:"Event action.",maxLength:500,"x-order":4},createdAt:{description:"Event creation time; the feed is ordered newest first.","x-order":5,type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},visibility:{description:"Always `public` in the feed.","x-order":6,type:"string",enum:["private","public"],default:"private","x-go-name":"EventVisibility"},platform:{type:"string",description:"Platform from ScheduleCompletedEventMetadata.",enum:["linkedin","x","reddit","hacker-news","slack","bluesky","github"],"x-order":7},role:{type:"string",description:"Role from ScheduleCompletedEventMetadata.",minLength:3,maxLength:40,"x-order":8},line:{type:"string",description:"One-line result from ScheduleCompletedEventMetadata.",minLength:10,maxLength:120,"x-order":9},networks:{type:"array",description:"Networks from ScheduleCompletedEventMetadata, when present.",minItems:1,maxItems:20,items:{type:"string",minLength:1,maxLength:255},"x-oapi-codegen-extra-tags":{json:"networks,omitempty"},"x-order":10},displayName:{type:"string",description:`The same value PublicUser.username carries for the owner. Never email. Resolved for every served owner; omitted when empty.