dataStores.yaml

openapi: 3.0.0
components:
  schemas:
    DataStoreList:
      type: object
      properties:
        count:
          type: integer
        items:
          type: array
          items:
            $ref: "#/components/schemas/DataStoreResource"
    DataStoreResource:
      type: object
      description: "Represents a data store structured into the Resources format."
      properties:
        type:
          type: string
          description: "Represents the type of this resource. It should always be set as 'DataStore'."
          enum:
            - DataStore
        spec:
          $ref: "#/components/schemas/DataStore"
    DataStore:
      type: object
      required:
        - name
        - type
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
        type:
          $ref: "#/components/schemas/SupportedDataStores"
        default:
          type: boolean
        jaeger:
          $ref: "#/components/schemas/GRPCClientSettings"
        tempo:
          $ref: "#/components/schemas/BaseClient"
        opensearch:
          $ref: "#/components/schemas/ElasticSearch"
        elasticapm:
          $ref: "#/components/schemas/ElasticSearch"
        signalfx:
          $ref: "#/components/schemas/SignalFX"
        awsxray:
          $ref: "#/components/schemas/AwsXRay"
        azureappinsights:
          $ref: "#/components/schemas/AzureAppInsights"
        createdAt:
          type: string
          format: date-time
    BaseClient:
      type: object
      properties:
        type:
          $ref: "#/components/schemas/SupportedClients"
        http:
          $ref: "#/components/schemas/HTTPClientSettings"
        grpc:
          $ref: "#/components/schemas/GRPCClientSettings"
    ElasticSearch:
      type: object
      properties:
        addresses:
          type: array
          items:
            type: string
        username:
          type: string
        password:
          type: string
        index:
          type: string
        certificate:
          type: string
        insecureSkipVerify:
          type: boolean
    SignalFX:
      type: object
      properties:
        realm:
          type: string
        token:
          type: string
    AzureAppInsights:
      type: object
      properties:
        useAzureActiveDirectoryAuth:
          type: boolean
        accessToken:
          type: string
        connectionType:
          $ref: "#/components/schemas/SupportedConnectionTypes"
        resourceArmId:
          type: string
    AwsXRay:
      type: object
      properties:
        region:
          type: string
        accessKeyId:
          type: string
        secretAccessKey:
          type: string
        sessionToken:
          type: string
        useDefaultAuth:
          type: boolean
    HTTPClientSettings:
      type: object
      properties:
        url:
          type: string
        headers:
          type: object
          additionalProperties:
            type: string
        tls:
          $ref: "#/components/schemas/TLS"
        auth:
          $ref: "./http.yaml#/components/schemas/HTTPAuth"
    GRPCClientSettings:
      type: object
      properties:
        endpoint:
          type: string
        readBufferSize:
          type: number
        writeBufferSize:
          type: number
        waitForReady:
          type: boolean
        headers:
          type: object
          additionalProperties:
            type: string
        balancerName:
          type: string
        compression:
          type: string
          enum:
            - "gzip"
            - "zlib"
            - "deflate"
            - "snappy"
            - "zstd"
            - "none"
            - ""
        tls:
          $ref: "#/components/schemas/TLS"
        auth:
          $ref: "./http.yaml#/components/schemas/HTTPAuth"
    TLS:
      type: object
      properties:
        insecure:
          type: boolean
        insecureSkipVerify:
          type: boolean
        serverName:
          type: string
        settings:
          $ref: "#/components/schemas/TLSSetting"
    TLSSetting:
      type: object
      properties:
        cAFile:
          type: string
        certFile:
          type: string
        keyFile:
          type: string
        minVersion:
          type: string
        maxVersion:
          type: string
    SupportedDataStores:
      type: string
      enum:
        [
          jaeger,
          opensearch,
          tempo,
          signalfx,
          otlp,
          elasticapm,
          newrelic,
          lightstep,
          datadog,
          awsxray,
          honeycomb,
          azureappinsights,
          signoz
        ]
    SupportedClients:
      type: string
      enum: [http, grpc]
    SupportedConnectionTypes:
      type: string
      enum: [direct, collector]