Revyl Async Test Report API

openapi: 3.2.0
info:
  description: Revyl API
  title: Revyl Async Test Report API
  version: 1.0.0
servers:
- description: Production
  url: https://backend.revyl.ai
tags:
- name: Async Test Report
paths:
  /api/v1/report/async-run/generate_shareable_report_link_by_session:
    post:
      description: 'Generate a shareable report link for a device session.


        Validates org ownership via device_sessions, then upserts into

        shareable_session_reports and returns a token-only public URL.


        Concurrent first creates for the same session use

        ``insert_session_if_absent`` (ON CONFLICT DO NOTHING). The losing writer

        reselects the winner''s live token and extends its expiry instead of

        raising a unique-violation 500.


        Refreshing with a temporary ``expiration_hours`` never shortens an

        existing longer-lived expiry (for example after proof-media publish

        promoted the token). Explicit delete remains the revoke path.


        Args:

        payload: Contains session_id, optional origin and expiration_hours.

        request: The incoming HTTP request.

        auth_info: Authenticated caller context.


        Returns:

        ShareableReportResponse with the generated link.


        Raises:

        HTTPException: 400 if session_id missing, 404 if session not found.'
      operationId: generate_shareable_report_link_by_session_api_v1_report_async_run_generate_shareable_report_link_by_session_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShareableReportBySessionModel'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShareableReportResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - HTTPBearer: []
      summary: Generate Shareable Report Link By Session
      tags:
      - Async Test Report
  /api/v1/report/async-run/generate_shareable_report_link_by_task:
    post:
      description: 'Generate a shareable report link using only a task_id.

        Looks up the corresponding test_id for the provided task_id and creates

        a tokenized public link identical in behavior to generate_shareable_report_link.


        The lookup-then-upsert runs inside a single transaction (get_db_tx_conn) so

        a concurrent generate can''t race between the existing-token read and the

        delete/update/insert that follows.'
      operationId: generate_shareable_report_link_by_task_api_v1_report_async_run_generate_shareable_report_link_by_task_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShareableReportByTaskModel'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShareableReportResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - HTTPBearer: []
      summary: Generate Shareable Report Link By Task
      tags:
      - Async Test Report
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ShareableReportBySessionModel:
      description: Request model for generating a shareable report link by session_id.
      properties:
        expiration_hours:
          anyOf:
          - type: integer
          - type: 'null'
          description: Hours until the link expires. None means never (100 years).
          title: Expiration Hours
        origin:
          anyOf:
          - type: string
          - type: 'null'
          default: https://app.revyl.ai
          description: Origin URL for constructing the shareable link
          title: Origin
        session_id:
          description: Device session UUID
          format: uuid
          title: Session Id
          type: string
      required:
      - session_id
      title: ShareableReportBySessionModel
      type: object
    ShareableReportByTaskModel:
      properties:
        expiration_hours:
          anyOf:
          - type: integer
          - type: 'null'
          title: Expiration Hours
        origin:
          anyOf:
          - type: string
          - type: 'null'
          default: https://app.revyl.ai
          title: Origin
        task_id:
          title: Task Id
          type: string
      required:
      - task_id
      title: ShareableReportByTaskModel
      type: object
    ShareableReportResponse:
      description: Response model for generate_shareable_report_link endpoint.
      example:
        shareable_link: https://app.revyl.ai/tests/report?token=uuid-token-here
      properties:
        shareable_link:
          description: Generated shareable link for the report
          title: Shareable Link
          type: string
      required:
      - shareable_link
      title: ShareableReportResponse
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
      - loc
      - msg
      - type
      title: ValidationError
      type: object
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http