sketchxflow-com Community API

openapi: 3.2.0
info:
  title: SketchXFlow Community API
  version: 0.1.0
tags:
- name: Community
paths:
  /api/community/designs:
    get:
      summary: Community Designs
      description: 'List recent free-tier designs (prompt + screenshot) for the public

        community gallery. Newest first, paginated. Optional `platform` filter

        ("web" | "mobile") — older projects with a missing platform are treated

        as web.


        Each design carries `screenshot_url` (the full capture, unchanged) and

        `preview_url` (a small thumbnail when one exists, else the same capture).

        Designs whose current screenshot was found blank or missing are left out;

        unchecked ones are queued for a background check. See

        services/community_gallery.py.'
      operationId: community_designs_api_community_designs_get
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 24
          title: Limit
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Offset
      - name: platform
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Platform
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Community
  /api/community/count:
    get:
      summary: Community Count
      description: 'How many designs the public community gallery shows — the live figure

        behind the homepage''s "N+ designs shared" badge. Same visibility rules as

        the list (community_gallery.visible_stages); cached 5 minutes.'
      operationId: community_count_api_community_count_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Community
  /api/community/covers/{slug}:
    get:
      summary: Community Design Cover
      description: 'A public design''s poster cover (services/project_cover) — made on the

        first request after each save, then a redirect to the stored image. Same

        visibility rule as the design itself. Not under /designs/{slug}/…, whose

        {page} route would take "cover" for a page name.'
      operationId: community_design_cover_api_community_covers__slug__get
      parameters:
      - name: slug
        in: path
        required: true
        schema:
          type: string
          title: Slug
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Community
  /api/community/designs/{slug}:
    get:
      summary: Community Design View
      description: 'Entry point for a community design — redirect to its home page so the

        design''s RELATIVE nav links (href="menu", href="story" …) resolve under

        /api/community/designs/{slug}/ and inter-page navigation works.'
      operationId: community_design_view_api_community_designs__slug__get
      parameters:
      - name: slug
        in: path
        required: true
        schema:
          type: string
          title: Slug
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Community
  /api/community/designs/{slug}/{page}:
    get:
      summary: Community Design Page
      description: 'Serve ONE page of a community design. Because every page is served under

        the same /api/community/designs/{slug}/ path, the generated relative nav

        (href="menu" etc.) resolves to sibling pages here — so all pages of the

        project are browsable, not just the home page.'
      operationId: community_design_page_api_community_designs__slug___page__get
      parameters:
      - name: slug
        in: path
        required: true
        schema:
          type: string
          title: Slug
      - name: page
        in: path
        required: true
        schema:
          type: string
          title: Page
      responses:
        '200':
          description: Successful Response
          content:
            text/html:
              schema:
                type: string
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Community
  /api/community/visibility:
    get:
      summary: Get Community Visibility
      description: Current user's community-gallery visibility state (for the account toggle).
      operationId: get_community_visibility_api_community_visibility_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      tags:
      - Community
    post:
      summary: Set Community Visibility
      description: 'Set the persistent opt-out flag.


        Going PRIVATE (opt_out=true) requires an active paid plan — that''s the

        paywall. But once set, the flag PERSISTS: when the subscription later ends

        and the user drops back to free, their designs stay private. Going back

        PUBLIC (opt_out=false) is always free.'
      operationId: set_community_visibility_api_community_visibility_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommunityVisibilityRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Community
  /api/community/design-info/{slug}:
    get:
      tags:
      - Community
      summary: Community Design Info
      operationId: community_design_info_api_community_design_info__slug__get
      parameters:
      - name: slug
        in: path
        required: true
        schema:
          type: string
          title: Slug
      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
    CommunityVisibilityRequest:
      properties:
        opt_out:
          type: boolean
          title: Opt Out
      type: object
      required:
      - opt_out
      title: CommunityVisibilityRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError