> ## Documentation Index
> Fetch the complete documentation index at: https://developers.askparable.com/llms.txt
> Use this file to discover all available pages before exploring further.

# providerAnnotations



## OpenAPI

````yaml /api-reference/openapi.json get /api/v2/catalog/provider-annotations
openapi: 3.0.3
info:
  title: Parable API
  description: >-
    The REST API for your Parable workspace: manage connectors and taps, explore
    your data catalog, upload artifacts, and administer users and roles.
  version: v1
servers:
  - url: https://api.askparable.com
    description: Production
security: []
paths:
  /api/v2/catalog/provider-annotations:
    get:
      tags:
        - catalog-v2
      summary: providerAnnotations
      operationId: CatalogV2ProviderAnnotationsHandler
      parameters:
        - description: >-
            Workspace slug. Overrides subdomain-based workspace resolution when
            provided.
          in: header
          name: X-Tenant
          required: false
          schema:
            example: acme
            type: string
        - description: Optional request correlation ID echoed back in the response.
          in: header
          name: X-Request-ID
          required: false
          schema:
            example: 550e8400-e29b-41d4-a716-446655440000
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/ProviderCatalogAnnotationsResponse'
                  links:
                    $ref: '#/components/schemas/ResponseLinks'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                  - data
                  - meta
                type: object
          description: Successful response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Bad request
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Internal server error
      security:
        - bearerAuth: []
components:
  schemas:
    ProviderCatalogAnnotationsResponse:
      properties:
        entries:
          additionalProperties:
            $ref: '#/components/schemas/ProviderCatalogAnnotationEntry'
          type: object
      required:
        - entries
      type: object
    ResponseLinks:
      properties:
        first:
          nullable: true
          type: string
        last:
          nullable: true
          type: string
        next:
          nullable: true
          type: string
        prev:
          nullable: true
          type: string
      type: object
    ResponseMeta:
      properties:
        requestId:
          description: Unique identifier for the request
          type: string
        totalCount:
          description: Total count of items for paginated responses
          nullable: true
          type: integer
      required:
        - requestId
      type: object
    Error:
      properties:
        error:
          type: string
      type: object
    ProviderCatalogAnnotationEntry:
      properties:
        computedAt:
          description: ISO8601 datetime string
          type: string
        health:
          $ref: '#/components/schemas/TransformationDatasetHealthState'
          description: >-
            Deploy query-layer consumers before web-api producers when adding

            TransformationDatasetHealthState values; generated enum decoding is
            strict.
        healthReason:
          type: string
        materialized:
          type: boolean
        statsRowCount:
          description: >-
            Signed 64-bit integer; range bounded by JavaScript's safe-integer
            ceiling.
          format: int64
          type: integer
        tenantConnectorTapId:
          description: >-
            Null for the synthetic providers.identity family, which is derived
            from

            multiple configured input taps rather than owned by one workspace
            tap.
          type: string
        validationRates:
          additionalProperties:
            $ref: '#/components/schemas/ValidationRateAnnotation'
          type: object
        watermark:
          description: ISO8601 datetime string
          type: string
        watermarkStale:
          type: boolean
      required:
        - validationRates
      type: object
    TransformationDatasetHealthState:
      description: Class-aware health state projected for pipeline diagnostics.
      enum:
        - healthy
        - degraded
        - failed
        - stale_but_valid
        - insufficient_data
      type: string
    ValidationRateAnnotation:
      properties:
        invalid_count:
          description: >-
            Signed 64-bit integer; range bounded by JavaScript's safe-integer
            ceiling.
          format: int64
          type: integer
        invalid_rate:
          description: Probability value from 0.0 to 1.0 inclusive
          format: double
          type: number
        total_count:
          description: >-
            Signed 64-bit integer; range bounded by JavaScript's safe-integer
            ceiling.
          format: int64
          type: integer
      required:
        - invalid_count
        - total_count
        - invalid_rate
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http

````