@ancplua/qyl-api-schema 1.0.2 → 1.0.4

package/README.md

@@ -4,6 +4,10 @@ The TypeSpec source of truth for Qyl's client-visible product API. This reposito
 emits the public schema and contract artifacts; it does not implement the server,
 storage engine, or OTLP receiver.
 
+Qyl stores and exposes traces and logs. Metrics are accepted and discarded only by
+the collector's OTLP wire-compatibility handlers, so this product contract exposes
+no metric DTOs or routes. Profiles are not supported.
+
 ## Contract pipeline
 
 ```text

package/api/routes.tsp

@@ -6,11 +6,8 @@ import "../common/errors.tsp";
 import "../common/pagination.tsp";
 import "../otel/span.tsp";
 import "../otel/logs.tsp";
-import "../otel/metrics.tsp";
-import "../otel/profiles.tsp";
 import "../models/session.tsp";
 import "../models/health.tsp";
-import "../models/cost-etl-audit.tsp";
 
 using TypeSpec.Http;
 using TypeSpec.OpenAPI;
@@ -20,12 +17,9 @@ using Qyl.Api.Contracts.Common.Errors;
 using Qyl.Api.Contracts.Common.Pagination;
 using Qyl.Api.Contracts.OTel.Traces;
 using Qyl.Api.Contracts.OTel.Logs;
-using Qyl.Api.Contracts.OTel.Metrics;
 using Qyl.Api.Contracts.OTel.Enums;
-using Qyl.Api.Contracts.OTel.Profiles;
 using Qyl.Api.Contracts.Domains.Observe.Session;
 using Qyl.Api.Contracts.Health;
-using Qyl.Api.Contracts.Cost;
 
 @service(#{ title: "qyl API" })
 namespace Qyl.Api.Contracts;
@@ -110,92 +104,6 @@ interface LogsApi {
     | InternalServerError;
 }
 
-// -----------------------------------------------------------------------------
-// Metrics
-// -----------------------------------------------------------------------------
-
-@route("/api/v1/metrics")
-@tag("Metrics")
-@useAuth(QylApiKeyHeaderAuth)
-interface MetricsApi {
-  @doc("List persisted OTLP metric data points without re-aggregating producer values.")
-  @get
-  list(
-    ...ProjectScopeHeader,
-    @query name?: string,
-    @query type?: MetricType,
-    @query serviceName?: string,
-    @query startTime?: utcDateTime,
-    @query endTime?: utcDateTime,
-
-    @query
-    @minValue(1)
-    @maxValue(1000)
-    limit?: int32 = 100,
-
-    @query cursor?: string,
-  ):
-    | CursorPage<MetricPoint>
-    | ValidationError
-    | UnauthorizedError
-    | InternalServerError;
-}
-
-// -----------------------------------------------------------------------------
-// Profiles (OpenTelemetry development signal)
-// -----------------------------------------------------------------------------
-
-@route("/api/v1/profiles")
-@tag("Profiles")
-@useAuth(QylApiKeyHeaderAuth)
-interface ProfilesApi {
-  @get
-  list(
-    ...ProjectScopeHeader,
-    @query sessionId?: SessionId,
-    @query traceId?: TraceId,
-    @query serviceName?: string,
-    @query sampleType?: string,
-
-    @query
-    @minValue(1)
-    @maxValue(1000)
-    limit?: int32 = 100,
-  ): Profile[] | ValidationError | UnauthorizedError | InternalServerError;
-
-  @get
-  @route("/{profileId}")
-  get(...ProjectScopeHeader, @path profileId: string):
-    | Profile
-    | NotFoundError
-    | UnauthorizedError
-    | InternalServerError;
-
-  @get
-  @route("/by-trace/{traceId}")
-  getByTrace(
-    ...ProjectScopeHeader,
-    @path traceId: TraceId,
-
-    @query
-    @minValue(1)
-    @maxValue(1000)
-    limit?: int32 = 100,
-  ): Profile[] | ValidationError | UnauthorizedError | InternalServerError;
-
-  @get
-  @route("/by-span/{spanId}")
-  getBySpan(
-    ...ProjectScopeHeader,
-    @path spanId: SpanId,
-
-    @query
-    @minValue(1)
-    @maxValue(1000)
-    limit?: int32 = 100,
-  ): Profile[] | ValidationError | UnauthorizedError | InternalServerError;
-}
-
 // -----------------------------------------------------------------------------
 // Sessions
 // -----------------------------------------------------------------------------
@@ -248,57 +156,6 @@ interface SessionsApi {
   ): SessionStats | ValidationError | UnauthorizedError | InternalServerError;
 }
 
-// -----------------------------------------------------------------------------
-// GenAI cost and ETL audit
-// -----------------------------------------------------------------------------
-
-@route("/api/v1/cost/etl-audit")
-@tag("GenAI cost")
-@useAuth(QylApiKeyHeaderAuth)
-interface GenAiEtlAuditApi {
-  @get
-  report(
-    ...ProjectScopeHeader,
-
-    @doc("Optional audit-period start. Omitted dates select the previous 30 completed UTC days; an explicit range may not exceed 180 days.")
-    @query
-    startTime?: utcDateTime,
-
-    @doc("Optional audit-period end. Omitted dates select the previous 30 completed UTC days; an explicit range may not exceed 180 days.")
-    @query
-    endTime?: utcDateTime,
-
-    @query
-    @minValue(1)
-    @maxValue(100)
-    limit?: int32 = 25,
-  ):
-    | GenAiEtlAuditReport
-    | ValidationError
-    | UnauthorizedError
-    | InternalServerError;
-
-  @post
-  @route("/evaluate")
-  evaluate(
-    ...ProjectScopeHeader,
-
-    @doc("Optional audit-period start. Omitted dates select the previous 30 completed UTC days; an explicit range may not exceed 180 days.")
-    @query
-    startTime?: utcDateTime,
-
-    @doc("Optional audit-period end. Omitted dates select the previous 30 completed UTC days; an explicit range may not exceed 180 days.")
-    @query
-    endTime?: utcDateTime,
-
-    @body request: GenAiEtlAuditEvaluationRequest,
-  ):
-    | GenAiEtlAuditEvaluationResponse
-    | ValidationError
-    | UnauthorizedError
-    | InternalServerError;
-}
-
 // -----------------------------------------------------------------------------
 // Health
 // -----------------------------------------------------------------------------