damdafa-com Catalog API

openapi: 3.2.0
info:
  title: Damdafa Com Catalog API
  version: 1.0.0
  description: 'Operations tagged Catalog across 2 of this provider''s published API definitions: mockupper-damdafa-com-openapi.json, mockupper-damdafa-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /mockupper
tags:
- name: Catalog
paths:
  /api/v1/catalog/devices:
    get:
      tags:
      - Catalog
      summary: Get Device Catalog
      description: 'Get the device catalog with supported platforms, models, and frame assets.

        Supports filtering by search query and platform.'
      operationId: get_device_catalog_api_v1_catalog_devices_get
      parameters:
      - name: q
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Q
      - name: platform
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Platform
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceCatalog'
        '500':
          description: Internal Server Error
          content:
            application/json:
              example:
                error: Internal server error
                error_code: internal_error
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: /mockupper
  /api/v1/catalog/design-styles:
    get:
      tags:
      - Catalog
      summary: Get Design Styles
      description: Get available design styles with preview SVG URLs.
      operationId: get_design_styles_api_v1_catalog_design_styles_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DesignStyleListResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
              example:
                error: Internal server error
                error_code: internal_error
    servers:
    - url: /mockupper
components:
  schemas:
    DesignStyleItem:
      properties:
        id:
          type: string
          title: Id
        previewSvgUrl:
          anyOf:
          - type: string
          - type: 'null'
          title: Previewsvgurl
      type: object
      required:
      - id
      title: DesignStyleItem
      description: A single design style option returned by the backend.
    DeviceCatalog:
      properties:
        version:
          type: string
          title: Version
        platforms:
          additionalProperties:
            $ref: '#/components/schemas/DevicePlatform'
          propertyNames:
            $ref: '#/components/schemas/DeviceCatalogPlatformId'
          type: object
          title: Platforms
      type: object
      required:
      - version
      - platforms
      title: DeviceCatalog
      description: The full device catalog structure.
    DeviceModel:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        width:
          type: integer
          title: Width
        height:
          type: integer
          title: Height
        screenSize:
          anyOf:
          - type: string
          - type: 'null'
          title: Screensize
        colors:
          anyOf:
          - items:
              $ref: '#/components/schemas/DeviceColor'
            type: array
          - type: 'null'
          title: Colors
      type: object
      required:
      - id
      - name
      - width
      - height
      title: DeviceModel
      description: Represents a specific device model (e.g., iPhone 14 Pro Max).
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
    ErrorResponseSchema:
      properties:
        error:
          type: string
          title: Error
          description: Human-readable error message
        error_code:
          type: string
          enum:
          - internal_error
          - unauthorized
          - forbidden
          - authentication_failed
          - access_denied
          - not_found
          - conflict
          - job_in_progress
          - rate_limit_exceeded
          - validation_error
          - quota_exceeded
          - premium_required
          - insufficient_balance
          - timeout
          - service_unavailable
          - external_service_error
          - auth_required
          - invalid_token
          - auth_failed
          - auth_or_device_required
          - verification_failed
          - signature_content_mismatch
          - cancelled
          - email_not_verified
          title: Error Code
          description: Machine-readable error code
        details:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Details
          description: Additional error details
      type: object
      required:
      - error
      - error_code
      title: ErrorResponseSchema
      description: Standard error response schema for OpenAPI documentation
    DeviceColor:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        frameUrl:
          anyOf:
          - type: string
          - type: 'null'
          title: Frameurl
        frameUrlSvg:
          anyOf:
          - type: string
          - type: 'null'
          title: Frameurlsvg
        frameUrlWebp:
          anyOf:
          - type: string
          - type: 'null'
          title: Frameurlwebp
      type: object
      required:
      - id
      - name
      title: DeviceColor
      description: Represents a specific color variant of a device model.
    DevicePlatform:
      properties:
        label:
          type: string
          title: Label
        models:
          items:
            $ref: '#/components/schemas/DeviceModel'
          type: array
          title: Models
        width:
          anyOf:
          - type: integer
          - type: 'null'
          title: Width
        height:
          anyOf:
          - type: integer
          - type: 'null'
          title: Height
      type: object
      required:
      - label
      - models
      title: DevicePlatform
      description: Represents a platform category (e.g., iPhone, Android Phone).
    DesignStyleListResponse:
      properties:
        styles:
          items:
            $ref: '#/components/schemas/DesignStyleItem'
          type: array
          title: Styles
      type: object
      required:
      - styles
      title: DesignStyleListResponse
      description: Response wrapper for listing design styles.
    DeviceCatalogPlatformId:
      type: string
      enum:
      - iphone
      - ipad
      - androidPhone
      - androidTablet
      title: DeviceCatalogPlatformId
      description: Exact platform keys used in `apps/mockupper/data/device_catalog.json`.
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- mockupper-damdafa-com-openapi.json
- mockupper-damdafa-com-openapi.json