ebay_product_info__v1.yml

openapi: 3.0.0
info:
  version: "1"
  title: "EbayProductInfo"
  description: Get product info for ebay
servers:
  - url: http://catalog/openapi/EbayProductInfo/v1
tags:
  - name: Product

paths:
  "/specs/{marketplace}/{rid}":
    get:
      tags:
        - Product
      summary: "Get specifications info by rid for specific marketplace"
      parameters:
        - name: marketplace
          in: path
          required: true
          description: "Name of marketplace for which need to get info"
          schema:
            type: string
            enum:
              - "Plaisir"
              - "Rollun"
              - "Any"
            default: "Any"
        - name: rid
          in: path
          required: true
          schema:
            type: string
          example: "RC18A"
        - name: recalculate
          in: query
          required: false
          description: "Attention: currently not implemented.
              If true - value will be recalculated from scratch, bypassing cache"
          schema:
            type: boolean
      responses:
        "200":
          description: "Success"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SpecsResponse"
        "500":
          description: "Internal error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  "/title/{marketplace}/{rid}":
    get:
      tags:
        - Product
      summary: "Get title by rid for specific marketplace"
      parameters:
        - name: marketplace
          in: path
          required: true
          description: "Name of marketplace for which need to get info"
          schema:
            type: string
            enum:
              - "Plaisir"
              - "Rollun"
              - "Any"
            default: "Any"
        - name: rid
          in: path
          required: true
          schema:
            type: string
          example: "RC18A"
        - name: recalculate
          in: query
          required: false
          description: "Attention: currently not implemented.
              If true - value will be recalculated from scratch, bypassing cache"
          schema:
            type: boolean
      responses:
        "200":
          description: "Success"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TitleResponse"
        "500":
          description: "Internal error"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'

components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        messages:
          type: array
          nullable: true
          items:
            $ref: "#/components/schemas/Message"
      description: "Message field is not required"
    Message:
      type: object
      properties:
        level:
          type: string
          enum:
            - emergency
            - alert
            - critical
            - error
            - warning
            - notice
            - info
        type:
          type: string
          enum:
            - UNDEFINED
            - INVALID_RESPONSE
            - NO_STRATEGY
            - MISSING_DATA
          description: >
            UNDEFINED - Any undefined message type
            INVALID_RESPONSE - A message generated by the client stating that the response could not be decoded
            NO_STRATEGY - There is no strategy to compute requested value
            MISSING_DATA - Some crucial data is missing to generate valid response
        text:
          type: string
          description: Message, that describes what went wrong
    SuccessResponse:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
      type: object
      properties:
        data:
          type: object
    SpecsResponse:
      type: object
      allOf:
        - $ref: '#/components/schemas/SuccessResponse'
      properties:
        data:
          $ref: '#/components/schemas/Specs'
    TitleResponse:
      type: object
      allOf:
        - $ref: '#/components/schemas/SuccessResponse'
      properties:
        data:
          $ref: '#/components/schemas/Title'

    ## Resource object
    Specs:
      type: object
      required:
        - Brand
        - Manufacturer Part Number
        - Quantity
        - Aspect Ratio
        - Section Width
        - Wheel Diameter
      properties:
        Brand:
          type: string
          nullable: false
          example: "PIRELLI"
          default: "Unbranded"
        Manufacturer Part Number:
          type: string
          nullable: false
          example: "3659100"
          default: "Does Not Apply"
        Quantity:
          type: integer
          nullable: false
          default: 1
        Aspect Ratio:
          type: string
          nullable: false
          example: "100"
          default: "Unknown"
        Section Width:
          type: string
          nullable: false
          example: "80"
          default: "Unknown"
        Wheel Diameter:
          type: string
          nullable: false
          example: "12"
          default: "Unknown"
        Model:
          type: string
          nullable: true
          example: "SCORPION MX SOFT"
        Machine Type:
          type: string
          nullable: true
          example: "Offroad"
        Placement on Vehicle:
          type: string
          nullable: true
          example: "REAR"
        Load Index:
          type: string
          nullable: true
          example: "50"
        Speed Index:
          type: string
          nullable: true
          example: "M"
        Unit Type:
          type: string
          nullable: true
          example: "EA"
        Unit Quantity:
          type: integer
          nullable: true
          default: 1
        Upc:
          type: string
          nullable: true
          example: "8019227365917"

    Title:
      type: object
      required:
        - Title
      properties:
        Title:
          type: string
          nullable: false
          example: "PIRELLI SCORPION MX SOFT 80/100-12 Offroad Rear Tire Bias Racing 3659100"