/** * This file was automatically generated by json-schema-to-typescript. * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file, * and run json-schema-to-typescript to regenerate this file. */ export type ViewedMessage = BaseEventMessage & { type: "com.redocly.page.viewed"; /** * @minItems 1 * @maxItems 1 */ data: [ { /** * Identifier for the view context. */ id: string; object: "page"; /** * Canonical URI of the documentation page. */ uri: string; specType?: SpecificationType; layout: "stacked" | "three-panel"; /** * Protocol variant, applicable for AsyncAPI specs. */ protocol?: string; } ]; }; /** * Injected by telemetry layer; omit when sending. */ export type SpecificationType = "openapi" | "asyncapi" | "graphql"; export interface BaseEventMessage { /** * Event ID. */ id: string; /** * Object type. */ object: "event"; /** * CloudEvents specification version. */ specversion: "1.0"; /** * Data content type. */ datacontenttype: "application/json; charset=utf-8"; /** * Context in which the event happened. Format `urn:redocly:{product}:{component}`. */ source: string; actor: null | { id: string; object: "user" | "webhook" | "cronJob"; uri: string; }; /** * Timestamp of when the event happened. */ time: string; /** * Origin of the event. */ origin: "redocUi"; /** * Telemetry signal kind: log (fire-and-forget event), trace (correlated span), or metric (reserved). */ signal?: "log" | "trace" | "metric"; /** * Session ID. */ sessionId?: string; /** * Deployment environment. */ env: string; }