@ancplua/qyl-api-schema 11.5.0 → 11.6.0

package/generated/ts-runtime/schemas.js

@@ -1,5 +1,12 @@
 /** The same names at runtime, so a consumer can prove the published surface is covered. */
 export const contractDefinitionKeys = [
+    "Annotations.Annotation",
+    "Annotations.AnnotationCreateRequest",
+    "Annotations.AnnotationTarget",
+    "Annotations.AnnotationUpdateRequest",
+    "Annotations.SessionAnnotationTarget",
+    "Annotations.SpanAnnotationTarget",
+    "Annotations.TraceAnnotationTarget",
     "Common.Attribute",
     "Common.AttributeBytesValue",
     "Common.AttributeDouble",
@@ -11,13 +18,16 @@ export const contractDefinitionKeys = [
     "Common.AttributeValue",
     "Common.Attributes",
     "Common.ByteSize",
+    "Common.CollectorKeyRole",
     "Common.ContentType",
     "Common.ContractRevision",
     "Common.CostUsd",
     "Common.Count",
+    "Common.Cursor",
     "Common.DurationMs",
     "Common.DurationNs",
     "Common.DurationS",
+    "Common.ETag",
     "Common.EntityAttributeKey",
     "Common.EntityRef",
     "Common.Errors.ApiError",
@@ -26,6 +36,8 @@ export const contractDefinitionKeys = [
     "Common.Errors.ForbiddenError",
     "Common.Errors.InternalServerError",
     "Common.Errors.NotFoundError",
+    "Common.Errors.PreconditionFailedError",
+    "Common.Errors.PreconditionRequiredError",
     "Common.Errors.ProblemDetails",
     "Common.Errors.RateLimitError",
     "Common.Errors.ServiceUnavailableError",
@@ -50,6 +62,8 @@ export const contractDefinitionKeys = [
     "Common.Percentage",
     "Common.Port",
     "Common.Ratio",
+    "Common.ResourceBase",
+    "Common.ResourceId",
     "Common.SemVer",
     "Common.SessionId",
     "Common.Sha256Hash",
@@ -79,20 +93,36 @@ export const contractDefinitionKeys = [
     "Health.HealthCheckEntry",
     "Health.HealthReport",
     "Health.HealthStatus",
+    "Mcp.Tools.AnnotationOutput",
     "Mcp.Tools.CiLogInput",
     "Mcp.Tools.CiLogOutput",
     "Mcp.Tools.CiPhase",
     "Mcp.Tools.CiPhaseStatus",
     "Mcp.Tools.CiRunSummary",
+    "Mcp.Tools.CreateAnnotationInput",
+    "Mcp.Tools.CreateSavedQueryInput",
+    "Mcp.Tools.DeletableKind",
+    "Mcp.Tools.DeleteInput",
+    "Mcp.Tools.DeleteOutput",
     "Mcp.Tools.DisplayMcpDashboardInput",
     "Mcp.Tools.DisplayMcpDashboardOutput",
     "Mcp.Tools.DisplayTracesInput",
     "Mcp.Tools.DisplayTracesOutput",
     "Mcp.Tools.FetchTelemetryInput",
+    "Mcp.Tools.FetchTelemetryLogsInput",
+    "Mcp.Tools.FetchTelemetryMcpStatsInput",
     "Mcp.Tools.FetchTelemetryOutput",
+    "Mcp.Tools.FetchTelemetryTraceInput",
+    "Mcp.Tools.FetchTelemetryTracesInput",
     "Mcp.Tools.FetchTelemetryView",
+    "Mcp.Tools.GetMetricSeriesInput",
+    "Mcp.Tools.GetMetricSeriesOutput",
     "Mcp.Tools.GetTraceInput",
     "Mcp.Tools.GetTraceOutput",
+    "Mcp.Tools.ListMetricsInput",
+    "Mcp.Tools.ListMetricsOutput",
+    "Mcp.Tools.ListSavedQueriesInput",
+    "Mcp.Tools.ListSavedQueriesOutput",
     "Mcp.Tools.ListSessionsInput",
     "Mcp.Tools.ListSessionsOutput",
     "Mcp.Tools.ListTracesInput",
@@ -103,9 +133,21 @@ export const contractDefinitionKeys = [
     "Mcp.Tools.McpDashboardWindow",
     "Mcp.Tools.McpDataMode",
     "Mcp.Tools.McpNameRequestCount",
+    "Mcp.Tools.McpScope",
     "Mcp.Tools.McpToolStats",
+    "Mcp.Tools.QueryMetricInput",
+    "Mcp.Tools.QueryMetricOutput",
+    "Mcp.Tools.RunSavedQueryInput",
+    "Mcp.Tools.RunSavedQueryOutput",
+    "Mcp.Tools.SavedQueryOutput",
     "Mcp.Tools.SearchLogsInput",
     "Mcp.Tools.SearchLogsOutput",
+    "Mcp.Tools.ToolError",
+    "Mcp.Tools.ToolErrorCode",
+    "Mcp.Tools.ToolPage",
+    "Mcp.Tools.ToolTimeRange",
+    "Mcp.Tools.UpdateAnnotationInput",
+    "Mcp.Tools.UpdateSavedQueryInput",
     "OTel.Enums.ErrorType",
     "OTel.Enums.EventDomain",
     "OTel.Enums.SeverityNumber",
@@ -117,9 +159,11 @@ export const contractDefinitionKeys = [
     "OTel.Logs.LogRecord",
     "OTel.Logs.LogTemplate",
     "OTel.Metrics.MetricAggregation",
+    "OTel.Metrics.MetricAttributeMatcher",
     "OTel.Metrics.MetricBucket",
     "OTel.Metrics.MetricDescriptor",
     "OTel.Metrics.MetricKind",
+    "OTel.Metrics.MetricMatcherOp",
     "OTel.Metrics.MetricQueryResult",
     "OTel.Metrics.MetricSeries",
     "OTel.Metrics.MetricSeriesResult",
@@ -137,6 +181,37 @@ export const contractDefinitionKeys = [
     "OTel.Traces.SpanStatus",
     "OTel.Traces.Trace",
     "OTel.Traces.TraceSummary",
+    "Operations.AnnotationsApi_create.Request",
+    "Operations.AnnotationsApi_create.Response.201",
+    "Operations.AnnotationsApi_create.Response.400",
+    "Operations.AnnotationsApi_create.Response.401",
+    "Operations.AnnotationsApi_create.Response.403",
+    "Operations.AnnotationsApi_create.Response.404",
+    "Operations.AnnotationsApi_create.Response.409",
+    "Operations.AnnotationsApi_create.Response.500",
+    "Operations.AnnotationsApi_delete.Response.401",
+    "Operations.AnnotationsApi_delete.Response.403",
+    "Operations.AnnotationsApi_delete.Response.404",
+    "Operations.AnnotationsApi_delete.Response.412",
+    "Operations.AnnotationsApi_delete.Response.428",
+    "Operations.AnnotationsApi_delete.Response.500",
+    "Operations.AnnotationsApi_get.Response.200",
+    "Operations.AnnotationsApi_get.Response.401",
+    "Operations.AnnotationsApi_get.Response.404",
+    "Operations.AnnotationsApi_get.Response.500",
+    "Operations.AnnotationsApi_list.Response.200",
+    "Operations.AnnotationsApi_list.Response.400",
+    "Operations.AnnotationsApi_list.Response.401",
+    "Operations.AnnotationsApi_list.Response.500",
+    "Operations.AnnotationsApi_update.Request",
+    "Operations.AnnotationsApi_update.Response.200",
+    "Operations.AnnotationsApi_update.Response.400",
+    "Operations.AnnotationsApi_update.Response.401",
+    "Operations.AnnotationsApi_update.Response.403",
+    "Operations.AnnotationsApi_update.Response.404",
+    "Operations.AnnotationsApi_update.Response.412",
+    "Operations.AnnotationsApi_update.Response.428",
+    "Operations.AnnotationsApi_update.Response.500",
     "Operations.LogsApi_list.Response.200",
     "Operations.LogsApi_list.Response.400",
     "Operations.LogsApi_list.Response.401",
@@ -181,6 +256,43 @@ export const contractDefinitionKeys = [
     "Operations.RunnerResourcesApi_streamLogs.Response.404",
     "Operations.RunnerResourcesApi_streamLogs.Response.500",
     "Operations.RunnerResourcesApi_streamLogs.Response.503",
+    "Operations.SavedQueriesApi_create.Request",
+    "Operations.SavedQueriesApi_create.Response.201",
+    "Operations.SavedQueriesApi_create.Response.400",
+    "Operations.SavedQueriesApi_create.Response.401",
+    "Operations.SavedQueriesApi_create.Response.403",
+    "Operations.SavedQueriesApi_create.Response.409",
+    "Operations.SavedQueriesApi_create.Response.500",
+    "Operations.SavedQueriesApi_delete.Response.401",
+    "Operations.SavedQueriesApi_delete.Response.403",
+    "Operations.SavedQueriesApi_delete.Response.404",
+    "Operations.SavedQueriesApi_delete.Response.412",
+    "Operations.SavedQueriesApi_delete.Response.428",
+    "Operations.SavedQueriesApi_delete.Response.500",
+    "Operations.SavedQueriesApi_get.Response.200",
+    "Operations.SavedQueriesApi_get.Response.401",
+    "Operations.SavedQueriesApi_get.Response.404",
+    "Operations.SavedQueriesApi_get.Response.500",
+    "Operations.SavedQueriesApi_list.Response.200",
+    "Operations.SavedQueriesApi_list.Response.400",
+    "Operations.SavedQueriesApi_list.Response.401",
+    "Operations.SavedQueriesApi_list.Response.500",
+    "Operations.SavedQueriesApi_run.Request",
+    "Operations.SavedQueriesApi_run.Response.200",
+    "Operations.SavedQueriesApi_run.Response.400",
+    "Operations.SavedQueriesApi_run.Response.401",
+    "Operations.SavedQueriesApi_run.Response.404",
+    "Operations.SavedQueriesApi_run.Response.500",
+    "Operations.SavedQueriesApi_update.Request",
+    "Operations.SavedQueriesApi_update.Response.200",
+    "Operations.SavedQueriesApi_update.Response.400",
+    "Operations.SavedQueriesApi_update.Response.401",
+    "Operations.SavedQueriesApi_update.Response.403",
+    "Operations.SavedQueriesApi_update.Response.404",
+    "Operations.SavedQueriesApi_update.Response.409",
+    "Operations.SavedQueriesApi_update.Response.412",
+    "Operations.SavedQueriesApi_update.Response.428",
+    "Operations.SavedQueriesApi_update.Response.500",
     "Operations.SessionsApi_get.Response.200",
     "Operations.SessionsApi_get.Response.401",
     "Operations.SessionsApi_get.Response.404",
@@ -190,6 +302,7 @@ export const contractDefinitionKeys = [
     "Operations.SessionsApi_getStats.Response.401",
     "Operations.SessionsApi_getStats.Response.500",
     "Operations.SessionsApi_getTraces.Response.200",
+    "Operations.SessionsApi_getTraces.Response.400",
     "Operations.SessionsApi_getTraces.Response.401",
     "Operations.SessionsApi_getTraces.Response.404",
     "Operations.SessionsApi_getTraces.Response.500",
@@ -206,6 +319,7 @@ export const contractDefinitionKeys = [
     "Operations.TracesApi_get.Response.404",
     "Operations.TracesApi_get.Response.500",
     "Operations.TracesApi_getSpans.Response.200",
+    "Operations.TracesApi_getSpans.Response.400",
     "Operations.TracesApi_getSpans.Response.401",
     "Operations.TracesApi_getSpans.Response.404",
     "Operations.TracesApi_getSpans.Response.500",
@@ -549,6 +663,20 @@ export const contractDefinitionKeys = [
     "Runner.RunnerResourceKind",
     "Runner.RunnerResourceLifecycle",
     "Runner.RunnerResourceState",
+    "SavedQueries.SavedLogQueryFilter",
+    "SavedQueries.SavedLogQueryRun",
+    "SavedQueries.SavedMetricQueryFilter",
+    "SavedQueries.SavedMetricQueryRun",
+    "SavedQueries.SavedQuery",
+    "SavedQueries.SavedQueryCreateRequest",
+    "SavedQueries.SavedQueryFilter",
+    "SavedQueries.SavedQueryRunRequest",
+    "SavedQueries.SavedQueryRunResult",
+    "SavedQueries.SavedQuerySignal",
+    "SavedQueries.SavedQueryUpdateRequest",
+    "SavedQueries.SavedQueryWindow",
+    "SavedQueries.SavedTraceQueryFilter",
+    "SavedQueries.SavedTraceQueryRun",
     "Streaming.HeartbeatEvent",
     "Streaming.LogEvents",
     "Streaming.LogStreamEvent",

package/models/annotations.tsp

@@ -0,0 +1,83 @@
+// =============================================================================
+// Annotations: user notes on a trace, span or session
+// =============================================================================
+// A note the user writes inside the verified subject's qyl project. It never
+// changes the telemetry it points at. get_trace and list_sessions read
+// annotations back, so there is no annotation listing tool.
+// =============================================================================
+
+import "@typespec/http";
+import "@typespec/openapi";
+import "../common/types.tsp";
+import "../common/resource.tsp";
+
+using TypeSpec.OpenAPI;
+using Qyl.Api.Contracts.Common;
+
+namespace Qyl.Api.Contracts.Annotations;
+
+@doc("An annotation on one whole trace.")
+model TraceAnnotationTarget {
+  kind: "trace";
+
+  @encodedName("application/json", "trace_id")
+  traceId: TraceId;
+}
+
+@doc("An annotation on one span of a trace.")
+model SpanAnnotationTarget {
+  kind: "span";
+
+  @encodedName("application/json", "trace_id")
+  traceId: TraceId;
+
+  @encodedName("application/json", "span_id")
+  spanId: SpanId;
+}
+
+@doc("An annotation on one session.")
+model SessionAnnotationTarget {
+  kind: "session";
+
+  @encodedName("application/json", "session_id")
+  sessionId: SessionId;
+}
+
+@doc("Exactly one telemetry object an annotation is attached to.")
+@oneOf
+union AnnotationTarget {
+  trace: TraceAnnotationTarget,
+  span: SpanAnnotationTarget,
+  session: SessionAnnotationTarget,
+}
+
+@doc("A user note attached to a trace, span or session.")
+model Annotation extends ResourceBase {
+  @doc("What the note is attached to. Fixed at creation.")
+  @visibility(Lifecycle.Read, Lifecycle.Create)
+  target: AnnotationTarget;
+
+  @doc("The note, plain text, at most 2000 characters.")
+  @minLength(1)
+  @maxLength(2000)
+  text: string;
+}
+
+@doc("Body of POST /api/v1/annotations: the `Lifecycle.Create` members of Annotation.")
+model AnnotationCreateRequest {
+  @doc("What the note is attached to. Fixed at creation.")
+  target: AnnotationTarget;
+
+  @doc("The note, plain text, at most 2000 characters.")
+  @minLength(1)
+  @maxLength(2000)
+  text: string;
+}
+
+@doc("Body of PATCH /api/v1/annotations/{annotation_id}: the `Lifecycle.Update` members of Annotation.")
+model AnnotationUpdateRequest {
+  @doc("The new note, plain text, at most 2000 characters.")
+  @minLength(1)
+  @maxLength(2000)
+  text: string;
+}