Clarity Examples Admin API

openapi: 3.2.0
info:
  title: Fast Examples Admin API
  version: 0.1.0
tags:
- name: examples_admin
paths:
  /api/admin/v1/examples:
    get:
      tags:
      - examples_admin
      summary: Search Examples
      description: 'Ranked example cards over the live corpus: relevance-dominant with a query, config

        recency + staff-highlight boost without one. A kind-less query also returns the app

        solutions that match well, in their own ``solutions`` list.'
      operationId: search_examples_api_admin_v1_examples_get
      security:
      - HTTPBearer: []
      parameters:
      - name: q
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 500
          - type: 'null'
          description: Keyword query; empty means browse
          title: Q
        description: Keyword query; empty means browse
      - name: entity_type
        in: query
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/ExampleKindFilter'
          - type: 'null'
          description: One kind, or tv_dashboard for TV boards
          title: Entity Type
        description: One kind, or tv_dashboard for TV boards
      - name: project
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 9223372036854775807
            exclusiveMinimum: 0
          - type: 'null'
          description: Narrow to one project
          title: Project
        description: Narrow to one project
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 50
          minimum: 1
          default: 10
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExampleSearchResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/admin/v1/examples/{entity_type}/{entity_id}:
    get:
      tags:
      - examples_admin
      summary: Get Example
      description: 'One example''s liftable payload, its project-bound ``dependencies`` (adapt before

        lifting), its files manifest, and its highlight provenance.'
      operationId: get_example_api_admin_v1_examples__entity_type___entity_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: entity_type
        in: path
        required: true
        schema:
          type: string
          title: Entity Type
      - name: entity_id
        in: path
        required: true
        schema:
          type: integer
          title: Entity Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExampleDetailResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/admin/v1/examples/{entity_type}/{entity_id}/files/{file_id}:
    get:
      tags:
      - examples_admin
      summary: Get Example File
      description: 'One manifest file, redacted and inline: HTML is read from storage, scrubbed and served as

        ``text/plain``; the canvas JSON as ``application/json``. Always a download

        (``Content-Disposition: attachment``, ``nosniff``), never a document to render. Solutions

        have no files.'
      operationId: get_example_file_api_admin_v1_examples__entity_type___entity_id__files__file_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: entity_type
        in: path
        required: true
        schema:
          type: string
          title: Entity Type
      - name: entity_id
        in: path
        required: true
        schema:
          type: integer
          title: Entity Id
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          title: File Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/admin/projects/{project_id}/examples:
    get:
      tags:
      - examples_admin
      summary: Search Examples
      description: 'Ranked example cards over the live corpus, across every project; a kind-less query also

        returns the app solutions this tenant may see that match well.'
      operationId: search_examples_api_v1_admin_projects__project_id__examples_get
      security:
      - HTTPBearer: []
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: integer
          title: Project Id
      - name: q
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 500
          - type: 'null'
          title: Q
      - name: entity_type
        in: query
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/ExampleKindFilter'
          - type: 'null'
          title: Entity Type
      - name: project
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 9223372036854775807
            exclusiveMinimum: 0
          - type: 'null'
          title: Project
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 50
          minimum: 1
          default: 10
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExampleSearchResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/admin/projects/{project_id}/examples/{entity_type}/{entity_id}:
    get:
      tags:
      - examples_admin
      summary: Get Example
      description: One example's payload, dependencies, files manifest and highlight provenance.
      operationId: get_example_api_v1_admin_projects__project_id__examples__entity_type___entity_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: integer
          title: Project Id
      - name: entity_type
        in: path
        required: true
        schema:
          type: string
          title: Entity Type
      - name: entity_id
        in: path
        required: true
        schema:
          type: integer
          title: Entity Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExampleDetailResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/admin/projects/{project_id}/examples/{entity_type}/{entity_id}/files/{file_id}:
    get:
      tags:
      - examples_admin
      summary: Get Example File
      description: One manifest file, redacted and inline (HTML as ``text/plain``, the canvas as JSON).
      operationId: get_example_file_api_v1_admin_projects__project_id__examples__entity_type___entity_id__files__file_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: integer
          title: Project Id
      - name: entity_type
        in: path
        required: true
        schema:
          type: string
          title: Entity Type
      - name: entity_id
        in: path
        required: true
        schema:
          type: integer
          title: Entity Id
      - name: file_id
        in: path
        required: true
        schema:
          type: string
          title: File Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ExampleSearchResponse:
      properties:
        results:
          items:
            $ref: '#/components/schemas/ExampleCardResponse'
          type: array
          title: Results
        solutions:
          items:
            $ref: '#/components/schemas/ExampleCardResponse'
          type: array
          title: Solutions
          description: Published solutions that match a kind-less query well — whole use cases, shown before results
        meta:
          additionalProperties: true
          type: object
          title: Meta
      type: object
      required:
      - results
      - meta
      title: ExampleSearchResponse
    ExampleKind:
      type: string
      enum:
      - dashboard
      - copilot_conversation
      - mini_app
      - widget
      - collection
      - operator
      - routine
      - source
      - notification_v1
      - notification_v2
      - survey
      - solution
      title: ExampleKind
      description: 'Which table an example lives in — the same values as ``HighlightEntityType`` (see the

        module docstring). Path segments and card ``entity_type`` values.'
    ExampleDetailResponse:
      properties:
        entity_type:
          $ref: '#/components/schemas/ExampleKind'
        id:
          type: string
          title: Id
        variant:
          anyOf:
          - type: string
          - type: 'null'
          title: Variant
        title:
          type: string
          title: Title
        subtitle:
          anyOf:
          - type: string
          - type: 'null'
          title: Subtitle
        project:
          $ref: '#/components/schemas/ProjectRefResponse'
        timestamp:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Timestamp
        timestamp_kind:
          type: string
          title: Timestamp Kind
        highlight_count:
          type: integer
          title: Highlight Count
          description: Distinct staff admins who highlighted this entity
        payload:
          additionalProperties: true
          type: object
          title: Payload
        dependencies:
          additionalProperties: true
          type: object
          title: Dependencies
          description: Project-bound references to adapt before lifting the payload
        files:
          items:
            $ref: '#/components/schemas/ExampleFileEntryResponse'
          type: array
          title: Files
      type: object
      required:
      - entity_type
      - id
      - title
      - project
      - timestamp_kind
      - highlight_count
      - payload
      title: ExampleDetailResponse
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ExampleKindFilter:
      type: string
      enum:
      - dashboard
      - copilot_conversation
      - mini_app
      - widget
      - collection
      - operator
      - routine
      - source
      - notification_v1
      - notification_v2
      - survey
      - solution
      - tv_dashboard
      title: ExampleKindFilter
    ExampleCardResponse:
      properties:
        entity_type:
          $ref: '#/components/schemas/ExampleKind'
        id:
          type: string
          title: Id
          description: Canonical numeric id as text (a mini-app's slug is preview metadata)
        variant:
          anyOf:
          - type: string
          - type: 'null'
          title: Variant
          description: '"tv" for TV boards'
        title:
          type: string
          title: Title
        subtitle:
          anyOf:
          - type: string
          - type: 'null'
          title: Subtitle
        project:
          $ref: '#/components/schemas/ProjectRefResponse'
        timestamp:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Timestamp
          description: The config time timestamp_kind names; null when the row has none (legacy rows)
        timestamp_kind:
          type: string
          title: Timestamp Kind
          description: 'Which column timestamp is: created_at | updated_at | canvas_created_at | published_at'
        highlight_count:
          type: integer
          title: Highlight Count
          description: Distinct staff admins who highlighted this entity
        score:
          type: number
          title: Score
        matched:
          items:
            type: string
          type: array
          title: Matched
          description: Why it ranked, e.g. 'title[churn]'
        preview:
          additionalProperties: true
          type: object
          title: Preview
        detail_path:
          type: string
          title: Detail Path
          description: '''{type}/{id}'', relative to the examples base the caller used'
      type: object
      required:
      - entity_type
      - id
      - title
      - project
      - timestamp_kind
      - highlight_count
      - score
      - detail_path
      title: ExampleCardResponse
    ExampleFileEntryResponse:
      properties:
        file_id:
          type: string
          title: File Id
        name:
          type: string
          title: Name
        kind:
          type: string
          title: Kind
          description: source_html | rendered_html | artifact_html | canvas_json | memory_doc
        content_type:
          type: string
          title: Content Type
          description: 'What path serves: application/json for the canvas, text/plain for HTML and memory docs'
        size_bytes:
          anyOf:
          - type: integer
          - type: 'null'
          title: Size Bytes
          description: Stored size; HTML is redacted on download, so it can differ by a few bytes
        sha256:
          anyOf:
          - type: string
          - type: 'null'
          title: Sha256
          description: sha256 of exactly the bytes path serves (the canvas); null for HTML, redacted on download
        path:
          type: string
          title: Path
          description: '''{type}/{id}/files/{file_id}'', relative like detail_path'
      type: object
      required:
      - file_id
      - name
      - kind
      - content_type
      - path
      title: ExampleFileEntryResponse
    ProjectRefResponse:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
      type: object
      required:
      - id
      - name
      title: ProjectRefResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
    HTTPBasic:
      type: http
      scheme: basic