Clarity Widget Catalog API

openapi: 3.2.0
info:
  title: Fast Widget Catalog API
  version: 0.1.0
tags:
- name: widget_catalog
paths:
  /api/v1/widget-catalog:
    get:
      tags:
      - widget_catalog
      summary: List Widgets
      description: The project's catalog, newest first (the "Custom widgets" picker).
      operationId: list_widgets_api_v1_widget_catalog_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WidgetListResponse'
      security:
      - HTTPBearer: []
  /api/v1/widget-catalog/{widget_id}:
    delete:
      tags:
      - widget_catalog
      summary: Delete Widget
      description: 'Soft-delete a catalog widget — available to whoever can SEE the catalog (same

        admin-or-flag gate as the listing). Report elements still pinning it fall back to

        the "Figure unavailable" notice; the row and bytes are kept (soft delete), so an

        accidental removal is recoverable by admins.'
      operationId: delete_widget_api_v1_widget_catalog__widget_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: widget_id
        in: path
        required: true
        schema:
          type: integer
          title: Widget Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/widget-catalog/{widget_id}/render:
    get:
      tags:
      - widget_catalog
      summary: Render Widget
      description: 'A fresh short-lived signed URL for the wrapped document — the report iframe''s src.


        Unknown/foreign/deleted ids are a uniform 404 (no existence leak across the

        sequential id space).'
      operationId: render_widget_api_v1_widget_catalog__widget_id__render_get
      security:
      - HTTPBearer: []
      parameters:
      - name: widget_id
        in: path
        required: true
        schema:
          type: integer
          title: Widget Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WidgetRenderResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    WidgetListResponse:
      properties:
        widgets:
          items:
            $ref: '#/components/schemas/WidgetResponse'
          type: array
          title: Widgets
      type: object
      required:
      - widgets
      title: WidgetListResponse
    WidgetResponse:
      properties:
        id:
          type: integer
          title: Id
        kind:
          type: string
          title: Kind
        name:
          type: string
          title: Name
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        mode:
          type: string
          title: Mode
        version:
          type: integer
          title: Version
        sha256:
          type: string
          title: Sha256
        size_bytes:
          type: integer
          title: Size Bytes
        wrapper_version:
          anyOf:
          - type: integer
          - type: 'null'
          title: Wrapper Version
        source_artifact_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Source Artifact Id
        created_by:
          anyOf:
          - type: integer
          - type: 'null'
          title: Created By
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
      - id
      - kind
      - name
      - mode
      - version
      - sha256
      - size_bytes
      - created_at
      - updated_at
      title: WidgetResponse
    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
    WidgetRenderResponse:
      properties:
        widget_id:
          type: integer
          title: Widget Id
        mode:
          type: string
          title: Mode
        version:
          type: integer
          title: Version
        sha256:
          type: string
          title: Sha256
        size_bytes:
          type: integer
          title: Size Bytes
        render_url:
          type: string
          title: Render Url
      type: object
      required:
      - widget_id
      - mode
      - version
      - sha256
      - size_bytes
      - render_url
      title: WidgetRenderResponse
      description: 'A short-lived signed URL for the wrapped document — the iframe ``src``.


        Field names mirror the copilot ``HtmlArtifactResponse`` (``render_url`` is what the

        frontend figure component consumes) so the report renderer treats both sources alike.'
    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