# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for TextQL Metrics Export Service API
  version: 1.0.0
extends: openapi/textql-metricsexportservice-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/textql.rpc.public.metrics_export.MetricsExportService/ConfigureMetricsExport'].post
  update:
    x-apievangelist-phrasing:
      intent: Configure metrics export
      effect: write
      questions:
      - Can I send TextQL metrics to my own OpenTelemetry collector?
      - Is a Prometheus scrape endpoint available for metrics?
      - How often are metrics pushed to an OTLP endpoint?
      instructions:
      - text: Export metrics over OTLP to {otlp_endpoint} using protocol {otlp_protocol}.
        slots:
          otlp_endpoint: requestBody.otlpEndpoint
          otlp_protocol: requestBody.otlpProtocol
      - text: Push metrics every {push_interval_seconds} seconds.
        slots:
          push_interval_seconds: requestBody.pushIntervalSeconds
      - text: 'Turn Prometheus metrics export on: {prometheus_enabled}.'
        slots:
          prometheus_enabled: requestBody.prometheusEnabled
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.metrics_export.MetricsExportService/DeleteMetricsExportConfig'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete the metrics export configuration
      effect: destructive
      questions:
      - How do I stop exporting metrics entirely?
      - Can I wipe the metrics export settings?
      instructions:
      - text: Delete our metrics export configuration.
      - text: Remove the metrics export setup, timing out after {timeout_ms} ms.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.metrics_export.MetricsExportService/GetMetricsExportConfig'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the metrics export configuration
      effect: read
      questions:
      - Where are our metrics currently being exported?
      - What OTLP endpoint and push interval are configured?
      instructions:
      - text: Show our metrics export configuration.
      - text: Get the current metrics export settings with a {timeout_ms} ms timeout.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.metrics_export.MetricsExportService/TestMetricsExportConnection'].post
  update:
    x-apievangelist-phrasing:
      intent: Test an OTLP metrics export connection
      effect: read
      questions:
      - Can I verify my OTLP collector is reachable before saving?
      - Will these OTLP headers authenticate against my endpoint?
      instructions:
      - text: Test the OTLP connection to {otlp_endpoint}.
        slots:
          otlp_endpoint: requestBody.otlpEndpoint
      - text: Check {otlp_endpoint} over {otlp_protocol} with headers {otlp_headers}.
        slots:
          otlp_endpoint: requestBody.otlpEndpoint
          otlp_protocol: requestBody.otlpProtocol
          otlp_headers: requestBody.otlpHeaders
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.metrics_export.MetricsExportService/TriggerMetricsPush'].post
  update:
    x-apievangelist-phrasing:
      intent: Push metrics immediately
      effect: write
      questions:
      - Can I force a metrics push right now instead of waiting for the interval?
      - How do I send metrics to the collector on demand?
      instructions:
      - text: Push metrics to the configured endpoint now.
      - text: Trigger an immediate metrics push with a {timeout_ms} ms timeout.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'