sketchxflow-com Publish API

openapi: 3.2.0
info:
  title: SketchXFlow Publish API
  version: 0.1.0
tags:
- name: Publish
paths:
  /api/publish/status:
    get:
      summary: Get Publish Status
      description: Publish is always available — served directly from MongoDB via Cloud Run.
      operationId: get_publish_status_api_publish_status_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Publish
  /api/publish/check-subdomain:
    get:
      summary: Check Subdomain Availability
      description: 'Live availability check for a user-chosen subdomain.


        Validates shape (length, charset, reserved words) AND uniqueness across

        all projects in Mongo. Excludes the requesting project so users

        re-checking their own current subdomain see "available".


        Returns ``{"available": bool, "reason"?: str, "subdomain": str}``.

        Frontend hits this on every keystroke (debounced) to render the

        "✓ available" / "✗ taken" hint inline.'
      operationId: check_subdomain_availability_api_publish_check_subdomain_get
      parameters:
      - name: name
        in: query
        required: true
        schema:
          type: string
          title: Name
      - name: project_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Publish
  /api/projects/{project_id}/publish/check:
    get:
      tags:
      - Publish
      summary: Publish Check
      operationId: publish_check_api_projects__project_id__publish_check_get
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/projects/{project_id}/publish/check/ignore:
    post:
      tags:
      - Publish
      summary: Publish Check Ignore
      operationId: publish_check_ignore_api_projects__project_id__publish_check_ignore_post
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IgnoreRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/projects/{project_id}/publish/fix:
    post:
      tags:
      - Publish
      summary: Publish Fix
      description: 'Fill in (or remove) one flagged placeholder on every page. A normal

        saved edit: it is on the live site at once and Undo takes it back.'
      operationId: publish_fix_api_projects__project_id__publish_fix_post
      parameters:
      - name: project_id
        in: path
        required: true
        schema:
          type: string
          title: Project Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FixRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    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
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    FixRequest:
      properties:
        key:
          type: string
          maxLength: 80
          minLength: 3
          title: Key
        value:
          type: string
          maxLength: 200
          title: Value
          default: ''
      type: object
      required:
      - key
      title: FixRequest
    IgnoreRequest:
      properties:
        key:
          type: string
          maxLength: 80
          minLength: 3
          title: Key
      type: object
      required:
      - key
      title: IgnoreRequest