@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.
@@ -6,7 +6,7 @@ var e={openapi:"3.0.0",info:{title:"Events",description:"OpenAPI schema for Mesh
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.
@@ -123,10 +123,14 @@ export interface components {
123
123
  *
124
124
  * The request belongs to the one signed-in user it was issued for. Only that
125
125
  * user may read it or decide it, and a challenge is single use: once accepted
126
- * or rejected it can no longer be read or decided. `client.verified` is
127
- * derived only from the client's redirect targets, never from its name or ID.
128
- * It marks trust and never blocks: an unverified client is shown as such, and
129
- * the user may still allow it.
126
+ * or rejected it can no longer be read or decided. `client.verified` marks
127
+ * trust and never blocks. For a dynamically registered client it is true only
128
+ * when every redirect URI matches one operator-listed known-client entry; for
129
+ * an operator-managed client it is true when the operator set the verified
130
+ * mark in the client's identity-provider metadata (admin-only; a client can
131
+ * never set or clear it). It is never derived from a self-asserted name or
132
+ * from the client ID. An unverified client is shown as such, and the user may
133
+ * still allow it.
130
134
  */
131
135
  OauthConsentRequest: {
132
136
  /** @description Opaque challenge the identity provider issued for this consent request, echoed unchanged. Send it back in OauthConsentDecisionPayload to allow or deny the request. */
@@ -135,30 +139,40 @@ export interface components {
135
139
  client: {
136
140
  /** @description OAuth client ID. An identifier issued by the identity provider, not a UUID. */
137
141
  clientId: string;
138
- /** @description Display name the client registered. Empty when it registered none. Self-asserted by the client; only `verified` marks trust. */
142
+ /** @description Display name the client registered. Empty when it registered none. Self-asserted by a dynamically registered client; set by the operator for an operator-managed client. Only `verified` marks trust. */
139
143
  clientName: string;
140
- /** @description The network hosts the client can send the user to after the decision: the host of each https redirect URI (for example `app.example.com`) and of each loopback redirect URI (`127.0.0.1` or `[::1]`), without duplicates. Only redirect URIs whose scheme is `https`, or `http` on a loopback IP literal, are listed here; the `localhost` hostname is never registered (RFC 8252 section 8.3), and a private-use app redirect is listed in `appSchemes` instead. Lowercase ASCII, with no scheme, port or path; an internationalized hostname is sent in IDNA A-label (punycode) form. Empty when the client registered only app redirects; `redirectHosts` and `appSchemes` are never both empty. */
144
+ /** @description The network hosts the client can send the user to after the decision: the host of each http or https redirect URI, with its port when the redirect has one, without duplicates. For a dynamically registered client, registration policy limits these to `https` hosts and loopback http hosts (`127.0.0.1` or `[::1]`), and never `localhost` (RFC 8252 section 8.3). For an operator-managed client any http or https redirect is listed, so a host may also be a single-label name such as `localhost`. A redirect URI of any other scheme is listed in `appSchemes` instead. Empty when the client registered only app redirects; `redirectHosts` and `appSchemes` are never both empty. */
141
145
  redirectHosts: string[];
142
- /** @description The private-use URI schemes (RFC 8252 section 7.1) of the client's app redirect URIs, without duplicates, for example `vscode` or `com.example.app`: the app that claims the scheme on the user's device receives the user after the decision. Registration accepts a private-use scheme only when it is on the server-side app-scheme allowlist read from configuration (defaults `vscode` and `cursor`), so only allowlisted schemes appear here. A reverse-domain scheme such as `com.example.app` names an app, not a host, and must not be shown as one. Empty when the client registered only https and loopback redirects; `redirectHosts` and `appSchemes` are never both empty. */
146
+ /** @description The URI schemes of the client's app redirect URIs (any scheme other than http and https), without duplicates, for example `vscode` or `com.example.app`: the app that claims the scheme on the user's device receives the user after the decision. For a dynamically registered client, registration accepts a private-use scheme (RFC 8252 section 7.1) only when it is on the server-side app-scheme allowlist read from configuration (defaults `vscode` and `cursor`), so only allowlisted schemes appear here. For an operator-managed client any other scheme is listed, as registered. A reverse-domain scheme such as `com.example.app` names an app, not a host, and must not be shown as one. Empty when every redirect URI of the client is http or https; `redirectHosts` and `appSchemes` are never both empty. */
143
147
  appSchemes: string[];
144
- /** @description Derived only from the client's redirect targets, never from `clientName` or `clientId`: true only when every redirect URI of the client matches one operator-listed known-client entry (that entry's https hosts or its app schemes). Marks trust and never blocks: a false value is shown as an unverified client, and the user may still allow it. */
148
+ /** @description Marks trust and never blocks. For a dynamically registered client it is true only when every redirect URI of the client matches one operator-listed known-client entry (that entry's https hosts or its app schemes). For an operator-managed client it is true when the operator set the verified mark in the client's identity-provider metadata, which only the admin API can write; a client can never set or clear it. It is never derived from a self-asserted name or from the client ID. A false value is shown as an unverified client, and the user may still allow it. */
145
149
  verified: boolean;
150
+ /**
151
+ * Format: uri
152
+ * @description An https URL of the client's logo image. Sent only for an operator-managed client whose operator set one; never sent for a dynamically registered client, whose self-asserted logo is not shown. Omitted when there is none.
153
+ */
154
+ logoUri?: string;
146
155
  };
147
156
  /** @description Scopes the client asks for, as the identity provider recorded them. An accept grants only what the client requested, never more: these scopes, and any audience the client asked the identity provider for. Empty when the client asks for none. */
148
157
  requestedScopes: string[];
149
158
  };
150
- /** @description The OAuth client that asks for consent, as the consent page names it: its ID and registered name, where it can send the user afterwards (`redirectHosts` for https and loopback redirects, `appSchemes` for private-use app redirects), and the `verified` mark. `verified` marks trust and never blocks: it is true only when every redirect URI of the client matches one operator-listed known-client entry, and an unverified client may still be allowed. The server classifies each registered redirect URI by its scheme into exactly one of the two lists, and at least one of them is non-empty. */
159
+ /** @description The OAuth client that asks for consent, as the consent page names it: its ID and registered name, where it can send the user afterwards (`redirectHosts` for http and https redirects, `appSchemes` for any other scheme), an optional `logoUri`, and the `verified` mark. The client is one of two kinds. A dynamically registered client registered itself (RFC 7591), so its name is self-asserted. An operator-managed client was created by an operator through the identity provider's admin API, never through dynamic registration; it still gets the consent page, is not first-party and is not auto-accepted, and its name and logo are operator-set. `verified` marks trust and never blocks: for a dynamically registered client it is true only when every redirect URI matches one operator-listed known-client entry; for an operator-managed client it is true when the operator set the verified mark in the client's identity-provider metadata (admin-only; a client can never set or clear it). It is never derived from a self-asserted name or from the client ID, and an unverified client may still be allowed. The server classifies each registered redirect URI by its scheme into exactly one of the two lists, and at least one of them is non-empty. For a dynamically registered client the registration policy limits what can appear: https and loopback http redirects, and allowlisted private-use schemes. For an operator-managed client there is no extra constraint (the identity provider's exact-match redirect check is the only gate): an http or https redirect is listed in `redirectHosts`, any other scheme in `appSchemes`. This is display only, so the page never shows an app as a host. */
151
160
  OauthConsentClient: {
152
161
  /** @description OAuth client ID. An identifier issued by the identity provider, not a UUID. */
153
162
  clientId: string;
154
- /** @description Display name the client registered. Empty when it registered none. Self-asserted by the client; only `verified` marks trust. */
163
+ /** @description Display name the client registered. Empty when it registered none. Self-asserted by a dynamically registered client; set by the operator for an operator-managed client. Only `verified` marks trust. */
155
164
  clientName: string;
156
- /** @description The network hosts the client can send the user to after the decision: the host of each https redirect URI (for example `app.example.com`) and of each loopback redirect URI (`127.0.0.1` or `[::1]`), without duplicates. Only redirect URIs whose scheme is `https`, or `http` on a loopback IP literal, are listed here; the `localhost` hostname is never registered (RFC 8252 section 8.3), and a private-use app redirect is listed in `appSchemes` instead. Lowercase ASCII, with no scheme, port or path; an internationalized hostname is sent in IDNA A-label (punycode) form. Empty when the client registered only app redirects; `redirectHosts` and `appSchemes` are never both empty. */
165
+ /** @description The network hosts the client can send the user to after the decision: the host of each http or https redirect URI, with its port when the redirect has one, without duplicates. For a dynamically registered client, registration policy limits these to `https` hosts and loopback http hosts (`127.0.0.1` or `[::1]`), and never `localhost` (RFC 8252 section 8.3). For an operator-managed client any http or https redirect is listed, so a host may also be a single-label name such as `localhost`. A redirect URI of any other scheme is listed in `appSchemes` instead. Empty when the client registered only app redirects; `redirectHosts` and `appSchemes` are never both empty. */
157
166
  redirectHosts: string[];
158
- /** @description The private-use URI schemes (RFC 8252 section 7.1) of the client's app redirect URIs, without duplicates, for example `vscode` or `com.example.app`: the app that claims the scheme on the user's device receives the user after the decision. Registration accepts a private-use scheme only when it is on the server-side app-scheme allowlist read from configuration (defaults `vscode` and `cursor`), so only allowlisted schemes appear here. A reverse-domain scheme such as `com.example.app` names an app, not a host, and must not be shown as one. Empty when the client registered only https and loopback redirects; `redirectHosts` and `appSchemes` are never both empty. */
167
+ /** @description The URI schemes of the client's app redirect URIs (any scheme other than http and https), without duplicates, for example `vscode` or `com.example.app`: the app that claims the scheme on the user's device receives the user after the decision. For a dynamically registered client, registration accepts a private-use scheme (RFC 8252 section 7.1) only when it is on the server-side app-scheme allowlist read from configuration (defaults `vscode` and `cursor`), so only allowlisted schemes appear here. For an operator-managed client any other scheme is listed, as registered. A reverse-domain scheme such as `com.example.app` names an app, not a host, and must not be shown as one. Empty when every redirect URI of the client is http or https; `redirectHosts` and `appSchemes` are never both empty. */
159
168
  appSchemes: string[];
160
- /** @description Derived only from the client's redirect targets, never from `clientName` or `clientId`: true only when every redirect URI of the client matches one operator-listed known-client entry (that entry's https hosts or its app schemes). Marks trust and never blocks: a false value is shown as an unverified client, and the user may still allow it. */
169
+ /** @description Marks trust and never blocks. For a dynamically registered client it is true only when every redirect URI of the client matches one operator-listed known-client entry (that entry's https hosts or its app schemes). For an operator-managed client it is true when the operator set the verified mark in the client's identity-provider metadata, which only the admin API can write; a client can never set or clear it. It is never derived from a self-asserted name or from the client ID. A false value is shown as an unverified client, and the user may still allow it. */
161
170
  verified: boolean;
171
+ /**
172
+ * Format: uri
173
+ * @description An https URL of the client's logo image. Sent only for an operator-managed client whose operator set one; never sent for a dynamically registered client, whose self-asserted logo is not shown. Omitted when there is none.
174
+ */
175
+ logoUri?: string;
162
176
  };
163
177
  /** @description Names the pending consent request to allow (acceptOauthConsentRequest) or deny (rejectOauthConsentRequest). The grant is always what the client requested, so the body carries no scopes. */
164
178
  OauthConsentDecisionPayload: {
@@ -340,14 +354,19 @@ export interface operations {
340
354
  client: {
341
355
  /** @description OAuth client ID. An identifier issued by the identity provider, not a UUID. */
342
356
  clientId: string;
343
- /** @description Display name the client registered. Empty when it registered none. Self-asserted by the client; only `verified` marks trust. */
357
+ /** @description Display name the client registered. Empty when it registered none. Self-asserted by a dynamically registered client; set by the operator for an operator-managed client. Only `verified` marks trust. */
344
358
  clientName: string;
345
- /** @description The network hosts the client can send the user to after the decision: the host of each https redirect URI (for example `app.example.com`) and of each loopback redirect URI (`127.0.0.1` or `[::1]`), without duplicates. Only redirect URIs whose scheme is `https`, or `http` on a loopback IP literal, are listed here; the `localhost` hostname is never registered (RFC 8252 section 8.3), and a private-use app redirect is listed in `appSchemes` instead. Lowercase ASCII, with no scheme, port or path; an internationalized hostname is sent in IDNA A-label (punycode) form. Empty when the client registered only app redirects; `redirectHosts` and `appSchemes` are never both empty. */
359
+ /** @description The network hosts the client can send the user to after the decision: the host of each http or https redirect URI, with its port when the redirect has one, without duplicates. For a dynamically registered client, registration policy limits these to `https` hosts and loopback http hosts (`127.0.0.1` or `[::1]`), and never `localhost` (RFC 8252 section 8.3). For an operator-managed client any http or https redirect is listed, so a host may also be a single-label name such as `localhost`. A redirect URI of any other scheme is listed in `appSchemes` instead. Empty when the client registered only app redirects; `redirectHosts` and `appSchemes` are never both empty. */
346
360
  redirectHosts: string[];
347
- /** @description The private-use URI schemes (RFC 8252 section 7.1) of the client's app redirect URIs, without duplicates, for example `vscode` or `com.example.app`: the app that claims the scheme on the user's device receives the user after the decision. Registration accepts a private-use scheme only when it is on the server-side app-scheme allowlist read from configuration (defaults `vscode` and `cursor`), so only allowlisted schemes appear here. A reverse-domain scheme such as `com.example.app` names an app, not a host, and must not be shown as one. Empty when the client registered only https and loopback redirects; `redirectHosts` and `appSchemes` are never both empty. */
361
+ /** @description The URI schemes of the client's app redirect URIs (any scheme other than http and https), without duplicates, for example `vscode` or `com.example.app`: the app that claims the scheme on the user's device receives the user after the decision. For a dynamically registered client, registration accepts a private-use scheme (RFC 8252 section 7.1) only when it is on the server-side app-scheme allowlist read from configuration (defaults `vscode` and `cursor`), so only allowlisted schemes appear here. For an operator-managed client any other scheme is listed, as registered. A reverse-domain scheme such as `com.example.app` names an app, not a host, and must not be shown as one. Empty when every redirect URI of the client is http or https; `redirectHosts` and `appSchemes` are never both empty. */
348
362
  appSchemes: string[];
349
- /** @description Derived only from the client's redirect targets, never from `clientName` or `clientId`: true only when every redirect URI of the client matches one operator-listed known-client entry (that entry's https hosts or its app schemes). Marks trust and never blocks: a false value is shown as an unverified client, and the user may still allow it. */
363
+ /** @description Marks trust and never blocks. For a dynamically registered client it is true only when every redirect URI of the client matches one operator-listed known-client entry (that entry's https hosts or its app schemes). For an operator-managed client it is true when the operator set the verified mark in the client's identity-provider metadata, which only the admin API can write; a client can never set or clear it. It is never derived from a self-asserted name or from the client ID. A false value is shown as an unverified client, and the user may still allow it. */
350
364
  verified: boolean;
365
+ /**
366
+ * Format: uri
367
+ * @description An https URL of the client's logo image. Sent only for an operator-managed client whose operator set one; never sent for a dynamically registered client, whose self-asserted logo is not shown. Omitted when there is none.
368
+ */
369
+ logoUri?: string;
351
370
  };
352
371
  /** @description Scopes the client asks for, as the identity provider recorded them. An accept grants only what the client requested, never more: these scopes, and any audience the client asked the identity provider for. Empty when the client asks for none. */
353
372
  requestedScopes: string[];
@@ -18,11 +18,15 @@ The rules every operation enforces:
18
18
  - An accept grants only what the client requested, never more: the
19
19
  scopes in \`requestedScopes\`, and any audience the client asked the
20
20
  identity provider for. The decision body cannot widen or narrow it.
21
- - \`client.verified\` marks trust and never blocks. It is derived only
22
- from the client's redirect targets, never from \`clientName\` or
23
- \`clientId\`: true only when every redirect URI of the client matches one
24
- operator-listed known-client entry. An unverified client is shown as
25
- unverified and the user may still allow it.
21
+ - \`client.verified\` marks trust and never blocks. For a dynamically
22
+ registered client it is true only when every redirect URI of the client
23
+ matches one operator-listed known-client entry. For an operator-managed
24
+ client (pre-registered by an operator through the identity provider's
25
+ admin API) it is true when the operator set the verified mark in the
26
+ client's identity-provider metadata, which only the admin API can write:
27
+ a client can never set or clear it. It is never derived from a
28
+ self-asserted name or from the client ID. An unverified client is shown
29
+ as unverified and the user may still allow it.
26
30
 
27
31
  The server stores nothing of its own for a pending request: it reads the
28
32
  request from the identity provider on every call, so a 503 means the
@@ -54,11 +58,15 @@ stores no row of its own, so the schema has no \`id\` or timestamps.
54
58
 
55
59
  The request belongs to the one signed-in user it was issued for. Only that
56
60
  user may read it or decide it, and a challenge is single use: once accepted
57
- or rejected it can no longer be read or decided. \`client.verified\` is
58
- derived only from the client's redirect targets, never from its name or ID.
59
- It marks trust and never blocks: an unverified client is shown as such, and
60
- the user may still allow it.
61
- `,type:"object",additionalProperties:false,required:["consentChallenge","client","requestedScopes"],properties:{consentChallenge:{type:"string",description:"Opaque challenge the identity provider issued for this consent request, echoed unchanged. Send it back in OauthConsentDecisionPayload to allow or deny the request.",minLength:1,maxLength:8192,pattern:"^[\\x21-\\x7E]+$","x-order":1},client:{description:"The OAuth client that asks for consent.","x-order":2,type:"object",additionalProperties:false,required:["clientId","clientName","redirectHosts","appSchemes","verified"],properties:{clientId:{type:"string",description:"OAuth client ID. An identifier issued by the identity provider, not a UUID.",minLength:1,maxLength:255,"x-id-format":"external","x-go-name":"ClientID","x-order":1},clientName:{type:"string",description:"Display name the client registered. Empty when it registered none. Self-asserted by the client; only `verified` marks trust.",maxLength:255,"x-order":2},redirectHosts:{type:"array",description:"The network hosts the client can send the user to after the decision: the host of each https redirect URI (for example `app.example.com`) and of each loopback redirect URI (`127.0.0.1` or `[::1]`), without duplicates. Only redirect URIs whose scheme is `https`, or `http` on a loopback IP literal, are listed here; the `localhost` hostname is never registered (RFC 8252 section 8.3), and a private-use app redirect is listed in `appSchemes` instead. Lowercase ASCII, with no scheme, port or path; an internationalized hostname is sent in IDNA A-label (punycode) form. Empty when the client registered only app redirects; `redirectHosts` and `appSchemes` are never both empty.",maxItems:100,uniqueItems:true,items:{type:"string",description:"One network host: a DNS hostname of at least two labels whose last label starts with a letter, in IDNA A-label (punycode) form when internationalized, a dotted-decimal IPv4 literal, or a bracketed hexadecimal IPv6 literal. A colon appears only inside IPv6 brackets, so no entry carries a port, and a bare single-label name such as `localhost` or an app scheme (`vscode`) is not a host.",minLength:1,maxLength:253,pattern:"^(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]*[a-z0-9])?|(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])\\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])|\\[[0-9a-f]{0,4}(?::[0-9a-f]{0,4}){2,7}\\])$"},"x-order":3},appSchemes:{type:"array",description:"The private-use URI schemes (RFC 8252 section 7.1) of the client's app redirect URIs, without duplicates, for example `vscode` or `com.example.app`: the app that claims the scheme on the user's device receives the user after the decision. Registration accepts a private-use scheme only when it is on the server-side app-scheme allowlist read from configuration (defaults `vscode` and `cursor`), so only allowlisted schemes appear here. A reverse-domain scheme such as `com.example.app` names an app, not a host, and must not be shown as one. Empty when the client registered only https and loopback redirects; `redirectHosts` and `appSchemes` are never both empty.",maxItems:100,uniqueItems:true,items:{type:"string",description:"One private-use scheme in lowercase RFC 3986 scheme form, with no `:` or `//`. Never `http` or `https`, whose redirects are listed in `redirectHosts`.",minLength:1,maxLength:255,pattern:"^[a-z][a-z0-9+.-]*$",not:{enum:["http","https"]}},"x-order":4},verified:{type:"boolean",description:"Derived only from the client's redirect targets, never from `clientName` or `clientId`: true only when every redirect URI of the client matches one operator-listed known-client entry (that entry's https hosts or its app schemes). Marks trust and never blocks: a false value is shown as an unverified client, and the user may still allow it.","x-order":5}}},requestedScopes:{type:"array",description:"Scopes the client asks for, as the identity provider recorded them. An accept grants only what the client requested, never more: these scopes, and any audience the client asked the identity provider for. Empty when the client asks for none.",items:{type:"string",description:"One OAuth scope token (RFC 6749 section 3.3).",minLength:1,maxLength:255,pattern:"^[\\x21\\x23-\\x5B\\x5D-\\x7E]+$"},maxItems:100,uniqueItems:true,"x-order":3}}}}}},400:{description:"Invalid request body or request param",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"}}}}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},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:"Result not found",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:{"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"}}}}}}},503:{description:"Service unavailable - the identity provider could not be reached or did not answer. On getOauthConsentRequest nothing was read and the call may be retried. On acceptOauthConsentRequest and rejectOauthConsentRequest the outcome is unknown: the request may already have been decided. The caller may retry; a retry that answers 404 means the challenge was already decided, and the user should restart sign-in from the client.",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"}}}}}}}}}},"/api/identity/oauth/consent-requests/accept":{post:{"x-internal":["cloud"],tags:["oauthConsentDecisions"],summary:"Allow a pending OAuth consent request",operationId:"acceptOauthConsentRequest",description:`Allows the pending consent request named by \`consentChallenge\` in
61
+ or rejected it can no longer be read or decided. \`client.verified\` marks
62
+ trust and never blocks. For a dynamically registered client it is true only
63
+ when every redirect URI matches one operator-listed known-client entry; for
64
+ an operator-managed client it is true when the operator set the verified
65
+ mark in the client's identity-provider metadata (admin-only; a client can
66
+ never set or clear it). It is never derived from a self-asserted name or
67
+ from the client ID. An unverified client is shown as such, and the user may
68
+ still allow it.
69
+ `,type:"object",additionalProperties:false,required:["consentChallenge","client","requestedScopes"],properties:{consentChallenge:{type:"string",description:"Opaque challenge the identity provider issued for this consent request, echoed unchanged. Send it back in OauthConsentDecisionPayload to allow or deny the request.",minLength:1,maxLength:8192,pattern:"^[\\x21-\\x7E]+$","x-order":1},client:{description:"The OAuth client that asks for consent.","x-order":2,type:"object",additionalProperties:false,required:["clientId","clientName","redirectHosts","appSchemes","verified"],properties:{clientId:{type:"string",description:"OAuth client ID. An identifier issued by the identity provider, not a UUID.",minLength:1,maxLength:255,"x-id-format":"external","x-go-name":"ClientID","x-order":1},clientName:{type:"string",description:"Display name the client registered. Empty when it registered none. Self-asserted by a dynamically registered client; set by the operator for an operator-managed client. Only `verified` marks trust.",maxLength:255,"x-order":2},redirectHosts:{type:"array",description:"The network hosts the client can send the user to after the decision: the host of each http or https redirect URI, with its port when the redirect has one, without duplicates. For a dynamically registered client, registration policy limits these to `https` hosts and loopback http hosts (`127.0.0.1` or `[::1]`), and never `localhost` (RFC 8252 section 8.3). For an operator-managed client any http or https redirect is listed, so a host may also be a single-label name such as `localhost`. A redirect URI of any other scheme is listed in `appSchemes` instead. Empty when the client registered only app redirects; `redirectHosts` and `appSchemes` are never both empty.",maxItems:100,uniqueItems:true,items:{type:"string",description:"One network host as the server sends it for a registered redirect URI: a hostname or single label, an IPv4 literal, or a bracketed IPv6 literal, with an optional `:port`. No scheme, path, userinfo or whitespace. The pattern checks only that shape, not case or character set. Dynamic registration's own policy limits what a dynamically registered client can have, server-side.",minLength:1,maxLength:259,pattern:"^(?:[^\\s/?#@:\\[\\]]+|\\[[^\\s/?#@\\[\\]]+\\])(?::[0-9]{1,5})?$"},"x-order":3},appSchemes:{type:"array",description:"The URI schemes of the client's app redirect URIs (any scheme other than http and https), without duplicates, for example `vscode` or `com.example.app`: the app that claims the scheme on the user's device receives the user after the decision. For a dynamically registered client, registration accepts a private-use scheme (RFC 8252 section 7.1) only when it is on the server-side app-scheme allowlist read from configuration (defaults `vscode` and `cursor`), so only allowlisted schemes appear here. For an operator-managed client any other scheme is listed, as registered. A reverse-domain scheme such as `com.example.app` names an app, not a host, and must not be shown as one. Empty when every redirect URI of the client is http or https; `redirectHosts` and `appSchemes` are never both empty.",maxItems:100,uniqueItems:true,items:{type:"string",description:"One URI scheme in lowercase RFC 3986 scheme form, with no `:` or `//`. Never `http` or `https`, whose redirects are listed in `redirectHosts`.",minLength:1,maxLength:255,pattern:"^[a-z][a-z0-9+.-]*$",not:{enum:["http","https"]}},"x-order":4},verified:{type:"boolean",description:"Marks trust and never blocks. For a dynamically registered client it is true only when every redirect URI of the client matches one operator-listed known-client entry (that entry's https hosts or its app schemes). For an operator-managed client it is true when the operator set the verified mark in the client's identity-provider metadata, which only the admin API can write; a client can never set or clear it. It is never derived from a self-asserted name or from the client ID. A false value is shown as an unverified client, and the user may still allow it.","x-order":5},logoUri:{type:"string",format:"uri",description:"An https URL of the client's logo image. Sent only for an operator-managed client whose operator set one; never sent for a dynamically registered client, whose self-asserted logo is not shown. Omitted when there is none.",maxLength:2048,pattern:"^https://","x-order":6}}},requestedScopes:{type:"array",description:"Scopes the client asks for, as the identity provider recorded them. An accept grants only what the client requested, never more: these scopes, and any audience the client asked the identity provider for. Empty when the client asks for none.",items:{type:"string",description:"One OAuth scope token (RFC 6749 section 3.3).",minLength:1,maxLength:255,pattern:"^[\\x21\\x23-\\x5B\\x5D-\\x7E]+$"},maxItems:100,uniqueItems:true,"x-order":3}}}}}},400:{description:"Invalid request body or request param",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"}}}}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},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:"Result not found",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:{"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"}}}}}}},503:{description:"Service unavailable - the identity provider could not be reached or did not answer. On getOauthConsentRequest nothing was read and the call may be retried. On acceptOauthConsentRequest and rejectOauthConsentRequest the outcome is unknown: the request may already have been decided. The caller may retry; a retry that answers 404 means the challenge was already decided, and the user should restart sign-in from the client.",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"}}}}}}}}}},"/api/identity/oauth/consent-requests/accept":{post:{"x-internal":["cloud"],tags:["oauthConsentDecisions"],summary:"Allow a pending OAuth consent request",operationId:"acceptOauthConsentRequest",description:`Allows the pending consent request named by \`consentChallenge\` in
62
70
  the body, on behalf of the signed-in user. The grant holds only what
63
71
  the client requested, never more: the \`requestedScopes\` of
64
72
  getOauthConsentRequest, and any audience the client asked the
@@ -102,9 +110,13 @@ stores no row of its own, so the schema has no \`id\` or timestamps.
102
110
 
103
111
  The request belongs to the one signed-in user it was issued for. Only that
104
112
  user may read it or decide it, and a challenge is single use: once accepted
105
- or rejected it can no longer be read or decided. \`client.verified\` is
106
- derived only from the client's redirect targets, never from its name or ID.
107
- It marks trust and never blocks: an unverified client is shown as such, and
108
- the user may still allow it.
109
- `,type:"object",additionalProperties:false,required:["consentChallenge","client","requestedScopes"],properties:{consentChallenge:{type:"string",description:"Opaque challenge the identity provider issued for this consent request, echoed unchanged. Send it back in OauthConsentDecisionPayload to allow or deny the request.",minLength:1,maxLength:8192,pattern:"^[\\x21-\\x7E]+$","x-order":1},client:{description:"The OAuth client that asks for consent.","x-order":2,type:"object",additionalProperties:false,required:["clientId","clientName","redirectHosts","appSchemes","verified"],properties:{clientId:{type:"string",description:"OAuth client ID. An identifier issued by the identity provider, not a UUID.",minLength:1,maxLength:255,"x-id-format":"external","x-go-name":"ClientID","x-order":1},clientName:{type:"string",description:"Display name the client registered. Empty when it registered none. Self-asserted by the client; only `verified` marks trust.",maxLength:255,"x-order":2},redirectHosts:{type:"array",description:"The network hosts the client can send the user to after the decision: the host of each https redirect URI (for example `app.example.com`) and of each loopback redirect URI (`127.0.0.1` or `[::1]`), without duplicates. Only redirect URIs whose scheme is `https`, or `http` on a loopback IP literal, are listed here; the `localhost` hostname is never registered (RFC 8252 section 8.3), and a private-use app redirect is listed in `appSchemes` instead. Lowercase ASCII, with no scheme, port or path; an internationalized hostname is sent in IDNA A-label (punycode) form. Empty when the client registered only app redirects; `redirectHosts` and `appSchemes` are never both empty.",maxItems:100,uniqueItems:true,items:{type:"string",description:"One network host: a DNS hostname of at least two labels whose last label starts with a letter, in IDNA A-label (punycode) form when internationalized, a dotted-decimal IPv4 literal, or a bracketed hexadecimal IPv6 literal. A colon appears only inside IPv6 brackets, so no entry carries a port, and a bare single-label name such as `localhost` or an app scheme (`vscode`) is not a host.",minLength:1,maxLength:253,pattern:"^(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]*[a-z0-9])?|(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])\\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])|\\[[0-9a-f]{0,4}(?::[0-9a-f]{0,4}){2,7}\\])$"},"x-order":3},appSchemes:{type:"array",description:"The private-use URI schemes (RFC 8252 section 7.1) of the client's app redirect URIs, without duplicates, for example `vscode` or `com.example.app`: the app that claims the scheme on the user's device receives the user after the decision. Registration accepts a private-use scheme only when it is on the server-side app-scheme allowlist read from configuration (defaults `vscode` and `cursor`), so only allowlisted schemes appear here. A reverse-domain scheme such as `com.example.app` names an app, not a host, and must not be shown as one. Empty when the client registered only https and loopback redirects; `redirectHosts` and `appSchemes` are never both empty.",maxItems:100,uniqueItems:true,items:{type:"string",description:"One private-use scheme in lowercase RFC 3986 scheme form, with no `:` or `//`. Never `http` or `https`, whose redirects are listed in `redirectHosts`.",minLength:1,maxLength:255,pattern:"^[a-z][a-z0-9+.-]*$",not:{enum:["http","https"]}},"x-order":4},verified:{type:"boolean",description:"Derived only from the client's redirect targets, never from `clientName` or `clientId`: true only when every redirect URI of the client matches one operator-listed known-client entry (that entry's https hosts or its app schemes). Marks trust and never blocks: a false value is shown as an unverified client, and the user may still allow it.","x-order":5}}},requestedScopes:{type:"array",description:"Scopes the client asks for, as the identity provider recorded them. An accept grants only what the client requested, never more: these scopes, and any audience the client asked the identity provider for. Empty when the client asks for none.",items:{type:"string",description:"One OAuth scope token (RFC 6749 section 3.3).",minLength:1,maxLength:255,pattern:"^[\\x21\\x23-\\x5B\\x5D-\\x7E]+$"},maxItems:100,uniqueItems:true,"x-order":3}}},OauthConsentClient:{type:"object",additionalProperties:false,description:"The OAuth client that asks for consent, as the consent page names it: its ID and registered name, where it can send the user afterwards (`redirectHosts` for https and loopback redirects, `appSchemes` for private-use app redirects), and the `verified` mark. `verified` marks trust and never blocks: it is true only when every redirect URI of the client matches one operator-listed known-client entry, and an unverified client may still be allowed. The server classifies each registered redirect URI by its scheme into exactly one of the two lists, and at least one of them is non-empty.",required:["clientId","clientName","redirectHosts","appSchemes","verified"],properties:{clientId:{type:"string",description:"OAuth client ID. An identifier issued by the identity provider, not a UUID.",minLength:1,maxLength:255,"x-id-format":"external","x-go-name":"ClientID","x-order":1},clientName:{type:"string",description:"Display name the client registered. Empty when it registered none. Self-asserted by the client; only `verified` marks trust.",maxLength:255,"x-order":2},redirectHosts:{type:"array",description:"The network hosts the client can send the user to after the decision: the host of each https redirect URI (for example `app.example.com`) and of each loopback redirect URI (`127.0.0.1` or `[::1]`), without duplicates. Only redirect URIs whose scheme is `https`, or `http` on a loopback IP literal, are listed here; the `localhost` hostname is never registered (RFC 8252 section 8.3), and a private-use app redirect is listed in `appSchemes` instead. Lowercase ASCII, with no scheme, port or path; an internationalized hostname is sent in IDNA A-label (punycode) form. Empty when the client registered only app redirects; `redirectHosts` and `appSchemes` are never both empty.",maxItems:100,uniqueItems:true,items:{type:"string",description:"One network host: a DNS hostname of at least two labels whose last label starts with a letter, in IDNA A-label (punycode) form when internationalized, a dotted-decimal IPv4 literal, or a bracketed hexadecimal IPv6 literal. A colon appears only inside IPv6 brackets, so no entry carries a port, and a bare single-label name such as `localhost` or an app scheme (`vscode`) is not a host.",minLength:1,maxLength:253,pattern:"^(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]*[a-z0-9])?|(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])\\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])|\\[[0-9a-f]{0,4}(?::[0-9a-f]{0,4}){2,7}\\])$"},"x-order":3},appSchemes:{type:"array",description:"The private-use URI schemes (RFC 8252 section 7.1) of the client's app redirect URIs, without duplicates, for example `vscode` or `com.example.app`: the app that claims the scheme on the user's device receives the user after the decision. Registration accepts a private-use scheme only when it is on the server-side app-scheme allowlist read from configuration (defaults `vscode` and `cursor`), so only allowlisted schemes appear here. A reverse-domain scheme such as `com.example.app` names an app, not a host, and must not be shown as one. Empty when the client registered only https and loopback redirects; `redirectHosts` and `appSchemes` are never both empty.",maxItems:100,uniqueItems:true,items:{type:"string",description:"One private-use scheme in lowercase RFC 3986 scheme form, with no `:` or `//`. Never `http` or `https`, whose redirects are listed in `redirectHosts`.",minLength:1,maxLength:255,pattern:"^[a-z][a-z0-9+.-]*$",not:{enum:["http","https"]}},"x-order":4},verified:{type:"boolean",description:"Derived only from the client's redirect targets, never from `clientName` or `clientId`: true only when every redirect URI of the client matches one operator-listed known-client entry (that entry's https hosts or its app schemes). Marks trust and never blocks: a false value is shown as an unverified client, and the user may still allow it.","x-order":5}}},OauthConsentDecisionPayload:{type:"object",additionalProperties:false,description:"Names the pending consent request to allow (acceptOauthConsentRequest) or deny (rejectOauthConsentRequest). The grant is always what the client requested, so the body carries no scopes.",required:["consentChallenge"],properties:{consentChallenge:{type:"string",description:"The challenge of the request being decided, as getOauthConsentRequest returned it. A blank value answers 400.",minLength:1,maxLength:8192,pattern:"^[\\x21-\\x7E]+$","x-order":1},remember:{type:"boolean",description:"On accept, true asks the identity provider to remember the grant, so a later request from the same client for the same scopes is not shown again while the grant is remembered. False or omitted grants this request only. Ignored on reject.",default:false,"x-order":2}}},OauthConsentRedirect:{type:"object",additionalProperties:false,description:"Where the browser goes after a consent decision. The consent page must navigate the browser to `redirectTo`; the authorization does not finish until it does.",required:["redirectTo"],properties:{redirectTo:{type:"string",format:"uri",description:"Absolute URL the browser must navigate to next, issued by the identity provider. It continues the authorization and returns the user to the client.",maxLength:16384,"x-order":1}}}}}},t=e;
113
+ or rejected it can no longer be read or decided. \`client.verified\` marks
114
+ trust and never blocks. For a dynamically registered client it is true only
115
+ when every redirect URI matches one operator-listed known-client entry; for
116
+ an operator-managed client it is true when the operator set the verified
117
+ mark in the client's identity-provider metadata (admin-only; a client can
118
+ never set or clear it). It is never derived from a self-asserted name or
119
+ from the client ID. An unverified client is shown as such, and the user may
120
+ still allow it.
121
+ `,type:"object",additionalProperties:false,required:["consentChallenge","client","requestedScopes"],properties:{consentChallenge:{type:"string",description:"Opaque challenge the identity provider issued for this consent request, echoed unchanged. Send it back in OauthConsentDecisionPayload to allow or deny the request.",minLength:1,maxLength:8192,pattern:"^[\\x21-\\x7E]+$","x-order":1},client:{description:"The OAuth client that asks for consent.","x-order":2,type:"object",additionalProperties:false,required:["clientId","clientName","redirectHosts","appSchemes","verified"],properties:{clientId:{type:"string",description:"OAuth client ID. An identifier issued by the identity provider, not a UUID.",minLength:1,maxLength:255,"x-id-format":"external","x-go-name":"ClientID","x-order":1},clientName:{type:"string",description:"Display name the client registered. Empty when it registered none. Self-asserted by a dynamically registered client; set by the operator for an operator-managed client. Only `verified` marks trust.",maxLength:255,"x-order":2},redirectHosts:{type:"array",description:"The network hosts the client can send the user to after the decision: the host of each http or https redirect URI, with its port when the redirect has one, without duplicates. For a dynamically registered client, registration policy limits these to `https` hosts and loopback http hosts (`127.0.0.1` or `[::1]`), and never `localhost` (RFC 8252 section 8.3). For an operator-managed client any http or https redirect is listed, so a host may also be a single-label name such as `localhost`. A redirect URI of any other scheme is listed in `appSchemes` instead. Empty when the client registered only app redirects; `redirectHosts` and `appSchemes` are never both empty.",maxItems:100,uniqueItems:true,items:{type:"string",description:"One network host as the server sends it for a registered redirect URI: a hostname or single label, an IPv4 literal, or a bracketed IPv6 literal, with an optional `:port`. No scheme, path, userinfo or whitespace. The pattern checks only that shape, not case or character set. Dynamic registration's own policy limits what a dynamically registered client can have, server-side.",minLength:1,maxLength:259,pattern:"^(?:[^\\s/?#@:\\[\\]]+|\\[[^\\s/?#@\\[\\]]+\\])(?::[0-9]{1,5})?$"},"x-order":3},appSchemes:{type:"array",description:"The URI schemes of the client's app redirect URIs (any scheme other than http and https), without duplicates, for example `vscode` or `com.example.app`: the app that claims the scheme on the user's device receives the user after the decision. For a dynamically registered client, registration accepts a private-use scheme (RFC 8252 section 7.1) only when it is on the server-side app-scheme allowlist read from configuration (defaults `vscode` and `cursor`), so only allowlisted schemes appear here. For an operator-managed client any other scheme is listed, as registered. A reverse-domain scheme such as `com.example.app` names an app, not a host, and must not be shown as one. Empty when every redirect URI of the client is http or https; `redirectHosts` and `appSchemes` are never both empty.",maxItems:100,uniqueItems:true,items:{type:"string",description:"One URI scheme in lowercase RFC 3986 scheme form, with no `:` or `//`. Never `http` or `https`, whose redirects are listed in `redirectHosts`.",minLength:1,maxLength:255,pattern:"^[a-z][a-z0-9+.-]*$",not:{enum:["http","https"]}},"x-order":4},verified:{type:"boolean",description:"Marks trust and never blocks. For a dynamically registered client it is true only when every redirect URI of the client matches one operator-listed known-client entry (that entry's https hosts or its app schemes). For an operator-managed client it is true when the operator set the verified mark in the client's identity-provider metadata, which only the admin API can write; a client can never set or clear it. It is never derived from a self-asserted name or from the client ID. A false value is shown as an unverified client, and the user may still allow it.","x-order":5},logoUri:{type:"string",format:"uri",description:"An https URL of the client's logo image. Sent only for an operator-managed client whose operator set one; never sent for a dynamically registered client, whose self-asserted logo is not shown. Omitted when there is none.",maxLength:2048,pattern:"^https://","x-order":6}}},requestedScopes:{type:"array",description:"Scopes the client asks for, as the identity provider recorded them. An accept grants only what the client requested, never more: these scopes, and any audience the client asked the identity provider for. Empty when the client asks for none.",items:{type:"string",description:"One OAuth scope token (RFC 6749 section 3.3).",minLength:1,maxLength:255,pattern:"^[\\x21\\x23-\\x5B\\x5D-\\x7E]+$"},maxItems:100,uniqueItems:true,"x-order":3}}},OauthConsentClient:{type:"object",additionalProperties:false,description:"The OAuth client that asks for consent, as the consent page names it: its ID and registered name, where it can send the user afterwards (`redirectHosts` for http and https redirects, `appSchemes` for any other scheme), an optional `logoUri`, and the `verified` mark. The client is one of two kinds. A dynamically registered client registered itself (RFC 7591), so its name is self-asserted. An operator-managed client was created by an operator through the identity provider's admin API, never through dynamic registration; it still gets the consent page, is not first-party and is not auto-accepted, and its name and logo are operator-set. `verified` marks trust and never blocks: for a dynamically registered client it is true only when every redirect URI matches one operator-listed known-client entry; for an operator-managed client it is true when the operator set the verified mark in the client's identity-provider metadata (admin-only; a client can never set or clear it). It is never derived from a self-asserted name or from the client ID, and an unverified client may still be allowed. The server classifies each registered redirect URI by its scheme into exactly one of the two lists, and at least one of them is non-empty. For a dynamically registered client the registration policy limits what can appear: https and loopback http redirects, and allowlisted private-use schemes. For an operator-managed client there is no extra constraint (the identity provider's exact-match redirect check is the only gate): an http or https redirect is listed in `redirectHosts`, any other scheme in `appSchemes`. This is display only, so the page never shows an app as a host.",required:["clientId","clientName","redirectHosts","appSchemes","verified"],properties:{clientId:{type:"string",description:"OAuth client ID. An identifier issued by the identity provider, not a UUID.",minLength:1,maxLength:255,"x-id-format":"external","x-go-name":"ClientID","x-order":1},clientName:{type:"string",description:"Display name the client registered. Empty when it registered none. Self-asserted by a dynamically registered client; set by the operator for an operator-managed client. Only `verified` marks trust.",maxLength:255,"x-order":2},redirectHosts:{type:"array",description:"The network hosts the client can send the user to after the decision: the host of each http or https redirect URI, with its port when the redirect has one, without duplicates. For a dynamically registered client, registration policy limits these to `https` hosts and loopback http hosts (`127.0.0.1` or `[::1]`), and never `localhost` (RFC 8252 section 8.3). For an operator-managed client any http or https redirect is listed, so a host may also be a single-label name such as `localhost`. A redirect URI of any other scheme is listed in `appSchemes` instead. Empty when the client registered only app redirects; `redirectHosts` and `appSchemes` are never both empty.",maxItems:100,uniqueItems:true,items:{type:"string",description:"One network host as the server sends it for a registered redirect URI: a hostname or single label, an IPv4 literal, or a bracketed IPv6 literal, with an optional `:port`. No scheme, path, userinfo or whitespace. The pattern checks only that shape, not case or character set. Dynamic registration's own policy limits what a dynamically registered client can have, server-side.",minLength:1,maxLength:259,pattern:"^(?:[^\\s/?#@:\\[\\]]+|\\[[^\\s/?#@\\[\\]]+\\])(?::[0-9]{1,5})?$"},"x-order":3},appSchemes:{type:"array",description:"The URI schemes of the client's app redirect URIs (any scheme other than http and https), without duplicates, for example `vscode` or `com.example.app`: the app that claims the scheme on the user's device receives the user after the decision. For a dynamically registered client, registration accepts a private-use scheme (RFC 8252 section 7.1) only when it is on the server-side app-scheme allowlist read from configuration (defaults `vscode` and `cursor`), so only allowlisted schemes appear here. For an operator-managed client any other scheme is listed, as registered. A reverse-domain scheme such as `com.example.app` names an app, not a host, and must not be shown as one. Empty when every redirect URI of the client is http or https; `redirectHosts` and `appSchemes` are never both empty.",maxItems:100,uniqueItems:true,items:{type:"string",description:"One URI scheme in lowercase RFC 3986 scheme form, with no `:` or `//`. Never `http` or `https`, whose redirects are listed in `redirectHosts`.",minLength:1,maxLength:255,pattern:"^[a-z][a-z0-9+.-]*$",not:{enum:["http","https"]}},"x-order":4},verified:{type:"boolean",description:"Marks trust and never blocks. For a dynamically registered client it is true only when every redirect URI of the client matches one operator-listed known-client entry (that entry's https hosts or its app schemes). For an operator-managed client it is true when the operator set the verified mark in the client's identity-provider metadata, which only the admin API can write; a client can never set or clear it. It is never derived from a self-asserted name or from the client ID. A false value is shown as an unverified client, and the user may still allow it.","x-order":5},logoUri:{type:"string",format:"uri",description:"An https URL of the client's logo image. Sent only for an operator-managed client whose operator set one; never sent for a dynamically registered client, whose self-asserted logo is not shown. Omitted when there is none.",maxLength:2048,pattern:"^https://","x-order":6}}},OauthConsentDecisionPayload:{type:"object",additionalProperties:false,description:"Names the pending consent request to allow (acceptOauthConsentRequest) or deny (rejectOauthConsentRequest). The grant is always what the client requested, so the body carries no scopes.",required:["consentChallenge"],properties:{consentChallenge:{type:"string",description:"The challenge of the request being decided, as getOauthConsentRequest returned it. A blank value answers 400.",minLength:1,maxLength:8192,pattern:"^[\\x21-\\x7E]+$","x-order":1},remember:{type:"boolean",description:"On accept, true asks the identity provider to remember the grant, so a later request from the same client for the same scopes is not shown again while the grant is remembered. False or omitted grants this request only. Ignored on reject.",default:false,"x-order":2}}},OauthConsentRedirect:{type:"object",additionalProperties:false,description:"Where the browser goes after a consent decision. The consent page must navigate the browser to `redirectTo`; the authorization does not finish until it does.",required:["redirectTo"],properties:{redirectTo:{type:"string",format:"uri",description:"Absolute URL the browser must navigate to next, issued by the identity provider. It continues the authorization and returns the user to the client.",maxLength:16384,"x-order":1}}}}}},t=e;
110
122
  module.exports=t;