apis.yaml

openapi: 3.0.1
info:
  title: Hibat App API
  description: This API is designed for both Web and Mobile app.
  version: 1.0.0

servers:
  - url: https://staging.hibatapp.com/api/v1/
  - url: https://localhost/hibat-app/api/v1/

tags:
  - name: home

paths:
  /home:
    get:
      tags:
        - home
      summary: Get home page data
      parameters:
        - name: lang
          in: query
          schema:
            type: string
            maxLength: 2
            example: en
            default: en
            pattern: ^[a-z]{2}$
      responses:
        200:
          description: Successful response
          content:
            application/json:
              schema:
                additionalProperties: false
                type: object
                properties:
                  sliders:
                    maxItems: 5
                    type: array
                    items:
                      additionalProperties: false
                      anyOf:
                        - $ref: "#/components/schemas/slider"
  /user:
    put:
      security:
        - bearerAuth: []
      tags:
        - user
      summary: Update user info
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
                - fullName
              properties:
                fullName:
                  type: string
                  maxLength: 50
                  pattern: ^.{3,50}$
              example:
                fullName: "John Doe"
              additionalProperties: false
      responses:
        200:
          description: Success
        400:
          description: Missing data
        401:
          description: This request need's a valid user token
    get:
      security:
        - bearerAuth: []
      tags:
        - user
      summary: Get user info
      responses:
        200:
          description: Successful response
          content:
            application/json:
              schema:
                type: object
        401:
          description: Wrong login info
    post:
      tags:
        - user
      summary: User sign up
      operationId: userSingUp
      requestBody:
        required: true
        content:
          "application/x-www-form-urlencoded":
            schema:
              additionalProperties: false
              type: object
              properties:
                fullName:
                  type: string
                  maxLength: 50
                  pattern: ^.{1,50}$
                  example: John Doe
                countryId:
                  type: integer
                  format: int32
                  minimum: 1
                  maximum: 200
                  example: 10
                mobile:
                  type: string
                  maxLength: 14
                  pattern: ^[0-9]{8,14}$
                  example: "00111222000000"
                password:
                  type: string
                  minLength: 8
                  maxLength: 50
                  pattern: ^.{8,50}$
                  example: "Ab@123*/"
              required:
                - fullName
                - countryId
                - mobile
                - password
      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                additionalProperties: false
                type: object
                properties:
                  otpToken:
                    type: string
                    pattern: ^[0-9a-z]{32}$
                    maxLength: 32
                    example: "a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1a1"
        400:
          description: missing data
        422:
          description: mobile number already exists
        452:
          description: this app is not available in this country yet
    patch:
      tags:
        - user
      description: Signin a user
      summary: User sign in
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: false
              required:
                - countryId
                - mobile
                - password
              properties:
                countryId:
                  type: integer
                  minimum: 1
                  maximum: 200
                  format: int32
                mobile:
                  type: string
                  minLength: 8
                  maxLength: 32
                  pattern: ^[\+]?[(]?[0-9]{3}[)]?[-\s\.]?[0-9]{3}[-\s\.]?[0-9]{4,6}$
                password:
                  type: string
                  minLength: 8
                  maxLength: 250
                  pattern: ^.{8,50}$
              example:
                countryId: 1
                mobile: "096123456789"
                password: "12345678test"

      responses:
        200:
          description: Success
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  token:
                    maxLength: 32
                    type: string
                    pattern: ^[0-9a-z]{32}$
        400:
          description: Missing data

        401:
          description: Wrong login info

        422:
          description: This account has been disabled
          
  /Products:
    get:
      tags:
      - Products 
      summary: Returns Products
      description: Returns a map of Products
      operationId: getProducts
      parameters:
        - name: categoryId
          in: query
          description: pass an optional category Id for looking up Products
          required: false
          schema:
            type: integer
            minimum: 1
            format: int32
            maximum: 50
            example: 3
        - name: q
          in: query
          required: false
          description: 'pass an optional search string for looking up Product'
          schema:
            type: string
            maxLength: 50
            pattern: ^[A-Za-z0-9]{3,50}$
            example: bicycle
        - name: page
          in: query
          description: the amount of Products returned in page
          required: false
          schema:
            type: integer
            maximum: 50
            minimum: 1
            default: 10
            format: int32
            example: 20
        - name: pageLimit
          in: query
          description: the amount of pages returned
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            default: 1
            format: int32
            example: 3
        - name: sortby
          in: query
          required: false
          schema:
            type: string
            enum:
              - alpha
              - recent
          description: >
            sortby order:
              * alpha - alphabetically, from A to Z.
              * recent - Descending createdAt, from latest to oldest.          
          example: recent

      responses:
        200:
          description: success
          content:
            application/json:
              schema:
                type: array
                maxItems: 100
                items:
                  $ref: "#/components/schemas/Product"
  
  /product/{productId}:
    get:
      tags:
        - product
      summary: Find Product by ID
      description: Returns a single Product
      operationId: getProductById
      parameters:
        - name: productId
          in: path
          description: product ID
          required: true
          schema:
            type: integer
            format: int64 
      responses:
        200:
          description: success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Product"
        404:
          description: No such Product
  /wishlist:
    get:
      security:
        - bearerAuth: []
      tags:
        - wishlist
      summary: view my Wishlist
      description: view user Wishlist
      responses:
        200:
          description: success
          content:
            application/json:
              schema:
                type: array
                maxItems: 100
                items:
                  $ref: "#/components/schemas/Product"
        401:
          description: This request need a valid user token


  /wishlist/{productId}:
    delete:
      security:
        - bearerAuth: []
      tags:
        - wishlist
      summary: Deletes a from Wishlist
      description: "Delete from Wishlist"
      parameters:
        - name: "productId"
          in: path
          required: true
          schema:
            type: integer
            maximum: 999999
            minimum: 0
            format: int32
      responses:
        "200":
          description: "success"
        "401":
          description: "This request need's a valid user token"
        "404":
          description: "No such item"
  
  /request:
    post:
      security:
        - bearerAuth: []
      tags:
        - request
      summary: Add request for a product
      description: request product
      operationId: requestProduct
      requestBody:
        required: true
        content:
          "application/x-www-form-urlencoded":
            schema:
              $ref: "#/components/schemas/Request"
      responses:
        200:
          description: success
        401:
          description: This request need a valid user token
        404:
          description: No such item
          content:
            application/json:
              schema:
                $ref: "#/components/responses/notFound"

  /request/{requestId}:
    delete:
      security:
        - bearerAuth: []
      tags:
        - request
      summary: Cancel request for a product
      parameters:
        - name: requestId
          in: path
          required: true
          schema:
            type: integer
            format: int32
            minimum: 0
            maximum: 999999
      responses:
        200:
          description: Success
        401:
          description: This request need a valid user token
        404:
          description: No such item

  /requests:
    get:
      security:
        - bearerAuth: []
      tags:
        - request
      summary: get the recipient requests
      description: Returns all recipient requests
      operationId: getRequests
      responses:
        200:
          description: success
          content:
            application/json:
              schema:
                type: array
                maxItems: 100
                items:
                  $ref: "#/components/schemas/Request"
        401:
          description: This request need a valid user token

  /requests/{requestId}:
    get:
      security:
        - bearerAuth: []
      tags:
        - request
      summary: Find request by ID
      description: Returns a single request
      operationId: getRequestById
      parameters:
        - name: requestId
          in: path
          description: ID of request to return
          required: true
          schema:
            type: integer
            format: int64
      responses:
        200:
          description: success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Request"
        401:
          description: This request need a valid user token
        404:
          description: No such item

components:
  responses:
    notFound:
      description: Item not found
      content:
        application/json:
          schema:
            additionalProperties: false
            type: object
            properties:
              code:
                type: integer
                example: 404
                format: int32
                maximum: 404
                minimum: 404
              message:
                type: string
                example: Item not found
                maxLength: 250
                pattern: ^[0-9A-Za-z\. ]+$

  schemas:
    slider:
      additionalProperties: false
      type: object
      properties:
        picUrl:
          type: string
          example: "https://www.domain.com/path/photo.png"
          pattern: ^[0-9a-z:/\.]+$
          maxLength: 250
    User:
      additionalProperties: false
      type: object
      properties:
        fullName:
          type: string
          maxLength: 50
          pattern: ^.{3,50}$
          example: John Doe
        email:
          type: string
          format: email
          maxLength: 100
          example: example@example.com
        countryId:
          type: integer
          format: int32
          minimum: 1
          maximum: 200
          example: 10
        mobile:
          type: string
          minLength: 8
          maxLength: 32
          pattern: ^[\+]?[(]?[0-9]{3}[)]?[-\s\.]?[0-9]{3}[-\s\.]?[0-9]{4,6}$
        token:
          type: string
          pattern: ^[0-9a-z]{32}$
          maxLength: 32
    Product:
      additionalProperties: false
      type: object
      properties:
        title:
          type: string
          example: "This is product title."
          pattern: /^.{0,200}$/
          maxLength: 250
        details:
          type: string
          example: "These is product description text."
          pattern: /^.{0,200}$/
          maxLength: 300
        mainPhoto:
          type: string
          example: "https://www.domain.com/path/photo.png"
          pattern: ^[0-9a-z:/\.]+$
          maxLength: 250
        categoryId:
          type: integer
          format: int32
          minimum: 0
          maximum: 99999
          example: 75123
        ownerId:
          type: integer
          format: int32
          minimum: 0
          maximum: 99999
          example: 90910
        areaId:
          type: integer
          format: int32
          minimum: 0
          maximum: 99999
          example: 99010
        tags:
          type: array
          maxItems: 99999
          items:
            type: string
            example: "electronics"
            pattern: /^.{0,200}$/
            maxLength: 8
        views:
          type: integer
          format: int32
          example: 102
          minimum: 0
          maximum: 99999
        status:
          type: integer
          format: int32
          example: 2
          minimum: 0
          maximum: 99999
        createdAt:
          type: string
          example: "2022-03-13T13:24:26+00:00"
          pattern: /[0-9]{4}/(0[1-9]|1[0-2])/(0[1-9]|[1-2][0-9]|3[0-1]):(2[0-3]|[01][0-9]):[0-5][0-9]:[0-5][0-9]/
          maxLength: 25
        updatedAt:
          type: string
          example: "2022-03-13T13:24:26+00:00"
          pattern: /[0-9]{4}/(0[1-9]|1[0-2])/(0[1-9]|[1-2][0-9]|3[0-1]):(2[0-3]|[01][0-9]):[0-5][0-9]:[0-5][0-9]/
          maxLength: 25
    Request:
      additionalProperties: false
      type: object
      properties:
        requestId:
          type: integer
          format: int32
          example: 1010
          minimum: 0
          maximum: 99999
          description: Unique ID of the request
        dateOfRequest:
          type: string
          description: request Date of the product
          pattern: /[0-9]{4}/(0[1-9]|1[0-2])/(0[1-9]|[1-2][0-9]|3[0-1]):(2[0-3]|[01][0-9]):[0-5][0-9]:[0-5][0-9]/
        productId:
          type: integer
          format: int32
          minimum: 0
          maximum: 99999
          description: Id of a product requested          
      required:
      - requestId
      - dateOfRequest
      - productId
      example:
        requestId: '302'
        dateOfRequest: '2022-03-13T13:24:26+00:00'
        productId: '101'


        


  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer