bazaar.yaml

openapi: 3.0.3
info:
  title: Bazaar APIs
  contact:
    email: info@paziresh24.com
  version: 1.0.0
servers:
  - url: https://bazaar.paziresh24.com/api/v1
tags:
  - name: Apps
    description: Everything about Apps
  - name: Installation
    description: Managing app installations
paths:
  /apps:
    get:
      tags:
        - Apps
      summary: Get all apps
      parameters:
        - in: query
          name: tag
          example: 10
          schema:
            type: integer
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  oneOf:
                     - $ref: '#/components/schemas/App'
  /apps/{app_id}:
    get:
      tags:
        - Apps
      summary: Find app by ID
      parameters:
        - name: app_id
          in: path
          description: ID of app to return
          required: true
          example: 10
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/App'
  /installations:
    post:
        tags:
          - Installation
        summary: Create a new installation record.
        description: Create Installation
        requestBody:
          required: true
          content:
            application/json:
              schema:
                type: object
                properties:
                  app_id:
                    type: string
                  user_id:
                    type: string
        responses:
          "201":
            description: "Installation created"
          "400":
            description: "Invalid input"
    get:
      tags:
          - Installation
      summary: "List all installations"
      parameters:
        - in: query
          name: user_id
          required: true
          schema:
            type: string
        - in: query
          name: app_id
          schema:
            type: string
      responses:
        "200":
          description: "A list of installations"
  /installations/{installation_id}:
    get:
      tags:
          - Installation
      summary: "Retrieve details of a specific installation"
      parameters:
        - in: path
          name: installation_id
          required: true
          schema:
            type: string
      responses:
        "200":
          description: "Installation details"
        "404":
          description: "Installation not found"

    delete:
      tags:
          - Installation
      summary: "Remove a specific installation record"
      parameters:
        - in: path
          name: installation_id
          required: true
          schema:
            type: string
      responses:
        "200":
          description: "Installation deleted"
        "404":
          description: "Installation not found"
components:
  schemas:
    App:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 10
        name:
          type: string
          example: نسخه نویسی پذیرش24
        description:
          type: string
          example: <p>...</p>
        short_description:
          type: string
          example: <p>...</p>
        price:
          type: string
          example: '100000'
        rating_count:
          type: number
          example: 10
        average_rating:
          type: string
          example: '4.5'
        published_at:
          type: string
          example: "2023-12-04T09:56:32"
        developer:
          type: string
          example: "تیم پذیرش24"
        logo:
          $ref: '#/components/schemas/Photo'
        gallery:
          type: array
          items:
            $ref: '#/components/schemas/Photo'
        tags:
          type: array
          xml:
            wrapped: true
          items:
            $ref: '#/components/schemas/Tag'
    Tag:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 10
        name:
          type: string    
          example: "نسخه نویسی"
    Photo:
      type: object
      properties:
        src:
          type: string
          example: "https://bazaar.paziresh24.com/.../photo.png"
        alt:
          type: string
          example: ""