Apache Zipkin autocomplete API

Tag key/value autocompletion

OpenAPI Specification

apache-zipkin-autocomplete-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Zipkin autocomplete API
  description: Zipkin's HTTP API for querying and ingesting distributed tracing data. The API exposes span ingestion and trace, dependency, and autocomplete lookup operations under the `/api/v2` base. Authentication is typically handled by a reverse proxy in front of Zipkin and is not part of the core API.
  version: '2.0'
  license:
    name: Apache License 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  contact:
    name: OpenZipkin
    url: https://zipkin.io/zipkin-api/
servers:
- url: http://{host}:{port}/api/v2
  description: Zipkin server (v2 API base)
  variables:
    host:
      default: localhost
    port:
      default: '9411'
tags:
- name: autocomplete
  description: Tag key/value autocompletion
paths:
  /autocompleteKeys:
    get:
      tags:
      - autocomplete
      summary: List tag keys eligible for autocompletion
      operationId: getAutocompleteKeys
      responses:
        '200':
          description: Array of autocomplete keys
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
  /autocompleteValues:
    get:
      tags:
      - autocomplete
      summary: List known values for an autocomplete key
      operationId: getAutocompleteValues
      parameters:
      - name: key
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Array of autocomplete values
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string