sketchxflow-com Public Audit API

openapi: 3.2.0
info:
  title: SketchXFlow Public Audit API
  version: 0.1.0
tags:
- name: public-audit
paths:
  /api/public/audit/quota:
    get:
      tags:
      - public-audit
      summary: Public Audit Quota
      description: 'Free audits left for this visitor. Also plants the visitor cookie, so

        the audit call that follows (through the streaming proxy, which does not

        pass Set-Cookie back) is counted against it.'
      operationId: public_audit_quota_api_public_audit_quota_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/public/audit/tiers:
    get:
      tags:
      - public-audit
      summary: Public Audit Tiers
      operationId: public_audit_tiers_api_public_audit_tiers_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/public/audit:
    post:
      tags:
      - public-audit
      summary: Public Audit
      description: 'Run the free one-page audit; ``display_name`` (optional) is printed on

        the certificate it issues. SSE: agent_start/agent_done progress, then

        ``certificate_ready`` {token, score, certified, remaining, cached}, or

        ``error``; always ``done`` last. Refusals before the run are plain JSON:

        400 ``unsafe_url``, 429 ``public_audit_limit`` / ``public_audit_daily_cap``.'
      operationId: public_audit_api_public_audit_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicAuditRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/public/audit/stats:
    get:
      tags:
      - public-audit
      summary: Public Audit Stats
      description: 'How many different sites have been audited and certified (by domain).

        The home page shows the audited count once it reaches 100.'
      operationId: public_audit_stats_api_public_audit_stats_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/public/certified-sites:
    get:
      tags:
      - public-audit
      summary: Certified Sites
      description: 'The wall: certified sites whose owners chose to be listed.'
      operationId: certified_sites_api_public_certified_sites_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/public/audit-certificate/{token}/wall:
    get:
      tags:
      - public-audit
      summary: Certificate Wall State
      description: 'Whether this certificate is on the wall, and whether this viewer (the

        person who ran the audit) may change that.'
      operationId: certificate_wall_state_api_public_audit_certificate__token__wall_get
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
          title: Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - public-audit
      summary: Certificate Wall Set
      operationId: certificate_wall_set_api_public_audit_certificate__token__wall_put
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
          title: Token
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WallRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/public/audit-certificate/{token}:
    get:
      tags:
      - public-audit
      summary: Public Audit Certificate
      description: The public certificate. Never carries owner ids, emails or the dossier.
      operationId: public_audit_certificate_api_public_audit_certificate__token__get
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
          title: Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/public/audit-report/{token}:
    get:
      tags:
      - public-audit
      summary: Open Audit Report
      description: 'The full report of a PAID audit, for its certificate page. 403

        ``report_gated`` for a free audit, whose report is sent by email.'
      operationId: open_audit_report_api_public_audit_report__token__get
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
          title: Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/public/audit-report/{token}/email:
    post:
      tags:
      - public-audit
      summary: Email Audit Report
      description: 'Send the full report to ``email`` now (HTML + the PDF attached).

        ``{sent, email, already_sent}``; 422 ``invalid_email``, 429

        ``report_email_limit``, 502 ``report_email_failed``, 404.'
      operationId: email_audit_report_api_public_audit_report__token__email_post
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
          title: Token
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportEmailRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/audit-report/{token}/pdf:
    get:
      tags:
      - public-audit
      summary: Audit Report Pdf
      description: 'The full report as a PDF: for a signed-in (non-guest) account, or for

        anyone when the audit was a paid one (its report is open).'
      operationId: audit_report_pdf_api_audit_report__token__pdf_get
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
          title: Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    PublicAuditRequest:
      properties:
        url:
          type: string
          maxLength: 2048
          minLength: 3
          title: Url
        display_name:
          anyOf:
          - type: string
            maxLength: 300
          - type: 'null'
          title: Display Name
      type: object
      required:
      - url
      title: PublicAuditRequest
    WallRequest:
      properties:
        listed:
          type: boolean
          title: Listed
      type: object
      required:
      - listed
      title: WallRequest
    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
    ReportEmailRequest:
      properties:
        email:
          type: string
          maxLength: 320
          title: Email
        updates_opt_in:
          type: boolean
          title: Updates Opt In
          default: false
      type: object
      required:
      - email
      title: ReportEmailRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError