Api.yaml

swagger: '2.0'
info:
  version: 1.10.1
  title: nxplorerjs-microservice
  description: Express Microservice Starter
basePath: /api/v1
tags:
  - name: Examples
    description: Simple example endpoints
  - name: Login
    description: Security Login for JWT Generation
  - name: Mock API
    description: Cars / Drivers mock API using swagger middleware (needs API_MOCK=true)
  - name: Products
    description: Products,Product Options, Price,Inventory API sample
  - name: Starwars
    description: SWAPI API orchestration sample
  - name: Hystrix Demo
    description: Hystrix API demo using Brakes framework
consumes:
  - application/json
produces:
  - application/json
schemes:
  - http
  - https
securityDefinitions:
  Bearer:
    description: |
      For accessing the API a valid JWT token must be passed in all the queries in
      the 'Authorization' header.


      A valid JWT token is generated by the API and retourned as answer of a call
      to the route /login giving a valid user & password.


      The following syntax must be used in the 'Authorization' header :

          Bearer xxxxxx.yyyyyyy.zzzzzz
    type: apiKey
    name: Authorization
    in: header
definitions:
  car:
    required:
      - model
      - type
    properties:
      model:
        type: string
        minLength: 2
        pattern: '^[a-zA-Z0-9- ]+$'
      maker:
        type: string
        minLength: 2
        pattern: '^[a-zA-Z0-9- ]+$'
      registration:
        type: string
      dor:
        type: string
        format: 'date'
      type:
        type: string
        enum: [hatchback, sedan, limo]
      driver:
        $ref: '#/definitions/driver'
      tags:
        type: array
        uniqueItems: true
        items:
          type: string
          minLength: 1
  driver:
    required:
      - name
    properties:
      name:
        type: string
        minLength: 5
      address:
        $ref: '#/definitions/address'
  address:
    properties:
      street:
        type: string
        minLength: 1
      city:
        type: string
        minLength: 1
      state:
        type: string
        minLength: 2
        maxLength: 2
        pattern: '^[A-Z]+$'
      zipcode:
        type: integer
        minimum: 10000
        maximum: 99999
  ExampleBody:
    type: object
    title: example
    required:
      - name
    properties:
      name:
        type: string
        description: The example name
  PublishedProductsBody:
    type: object
    title: published products
    required:
      - name
      - data
    properties:
      name:
        type: string
        description: Product List Name
      data:
        type: array
        items:
          $ref: '#/definitions/publish'
  publish:
    type: object
    title: published products
    required:
      - id
      - url
      - buildId
      - buildStatus
      - scrapeDate   
    properties:
      id:
        type: string
        description: publish name
      url:
        type: string
        description: build url
      buildStatus:
        type: string
        description: build status
        enum: [inprogress, successful, failure, notstarted]
      buildId:
        type: string
        description: build id
      scrapeDate:
        type: string
        description: date scraped
        format: date-time
      publishStartDate:
        type: string
        description: publish start date 
        format: date-time
      publishEndDate:
        type: string
        description: publish end date
        format: date-time
  ProductsBody:
    type: object
    title: products
    required:
      - name
      - data
    properties:
      name:
        type: string
        description: Product List Name
      data:
        type: array
        items:
          $ref: '#/definitions/product'
      country:
        type: string
        description: campaign country
      theme:
        type: object
        title: Page Theme
        properties:
          page:
            type: object
            title: page theme
            properties:
              backgroundImage: 
                type: string
                description: background Image
              background:
                type: string
                description: background color
      visibility:
        type: object
        title: page visibility details
        properties:
          startDate:
            type: string
            description: page start date
            format: date-time
          endDate:
            type: string
            description: page end date
            format: date-time
  product:
    type: object
    title: scraped product
    required:
      - title
      - salePrice
      - brand
      - availability
      - vnv
      - brandUrl
      - image
    properties:
      title:
        type: string
        description: product name
      salePrice:
        type: string
        description: sale price        
      brand:
        type: string
        description: brand name
      availability:
        type: string
        description: availability
      vnv:
        type: string
        description: veg / non veg
      brandUrl:
        type: string
        description: brand url
      image:
        type: string
        description: base64 Image string
      features:
        type: array
        items:
          $ref: '#/definitions/productFeature'
      images:
        type: array
        items:
          $ref: '#/definitions/productImage'
  productFeature:
    type: object
    title: feature line
    required:
      - feature
    properties:
      feature:
        type: string
        description: feature line
  productImage:
    type: object
    title: image details
    required:
      - url
    properties:
      url:
        type: string
        description: image url                     
  LoginBody:
    type: object
    title: user login
    required:
      - email
      - password
      - role
    properties:
      email:
        type: string
        description: The user email
      password:
        type: string
        description: The user password
      role:
        type: string
        description: User Role
        enum:
          - admin
          - guest
  Token:
    type: object
    properties:
      idToken:
        type: string
      expiresIn:
        type: string
parameters:
  carRegistration:
    name: carRegistration
    in: path
    description: Car registration number
    required: true
    type: string

paths:
  /mock/cars:
    get:
      tags:
        - Mock API
      description: Returns all cars, optionally filtered by one or more criteria
      operationId: findCars
      parameters: &carFilters
        - name: tags
          in: query
          description: Filters cars by one or more tags
          required: false
          type: array
          items:
            type: string
          uniqueItems: true
          collectionFormat: csv
        - name: type
          in: query
          description: Filters cars by type (hatchback, sedan, limo)
          required: false
          type: string
          enum: [hatchback, sedan, limo]
        - name: maker
          in: query
          description: Filters cars by maker name
          required: false
          type: string
        - name: dor
          in: query
          description: Filters cars by date of registration
          required: false
          type: string
          format: date
        - name: driver.address.city
          in: query
          description: Filters cars by driver city
          required: false
          type: string
        - name: driver.address.state
          in: query
          description: Filters cars by driver state
          required: false
          type: string
        - name: driver.address.zipcode
          in: query
          description: Filters cars by driver zip code
          required: false
          type: integer
      responses:
        default:
          description: Returns the matching cars
          schema:
            type: array
            items:
              $ref: '#/definitions/car'
          headers:
            last-modified:
              type: string
              description: The date/time that a car was last modified

    delete:
      tags:
        - Mock API
      description: Deletes all cars, optionally filtered by one or more criteria
      operationId: deleteCars
      parameters: *carFilters
      responses:
        default:
          description: Returns the cars that were deleted
          schema:
            type: array
            items:
              $ref: '#/definitions/car'

    post:
      tags:
        - Mock API
      description: Creates a new car in the fleet
      operationId: addCar
      parameters:
        - name: car
          in: body
          description: The car to add to the fleet
          required: true
          schema:
            $ref: '#/definitions/car'
      responses:
        201:
          description: Returns the newly-added car
          schema:
            $ref: '#/definitions/car'
          headers:
            Location:
              type: string
              description: The URL of the newly-added car

  /mock/cars/{carRegistration}:
    parameters:
      - $ref: '#/parameters/carRegistration'

    get:
      tags:
        - Mock API
      description: Returns a car by registration number
      operationId: findCarByRegistration
      responses:
        default:
          description: Returns the car data
          schema:
            $ref: '#/definitions/car'
          headers:
            last-modified:
              type: string
              description: The date/time that the car was last modified

    delete:
      tags:
        - Mock API
      description: Deletes a single car based on the registration number supplied
      operationId: deleteCar
      responses:
        default:
          description: Returns the car that was deleted
          schema:
            $ref: '#/definitions/car'

    patch:
      tags:
        - Mock API
      description: Updates a car by registration number supplied
      parameters:
        - name: car
          in: body
          description: The updated car info
          required: true
          schema:
            $ref: '#/definitions/car'
      responses:
        default:
          description: Returns the updated car data
          schema:
            $ref: '#/definitions/car'

  /mock/cars/{carRegistration}/photos:
    parameters:
      - $ref: '#/parameters/carRegistration'

    post:
      tags:
        - Mock API
      description: Upload a new car photo
      operationId: addCarPhoto
      consumes:
        - multipart/form-data
      parameters:
        - name: id
          in: formData
          description: The car photo ID (generated automatically)
          type: integer
          format: int32
          minimum: 1
        - name: label
          in: formData
          description: A label for the photo
          required: true
          type: string
          minLength: 1
        - name: description
          in: formData
          description: An optional description of the photo
          type: string
        - name: photo
          in: formData
          description: The car photo
          required: true
          type: file
          minLength: 1
          maxLength: 5000000 # ~5MB
      responses:
        default:
          description: Returns the photo information
          schema:
            properties:
              id:
                type: integer
                format: int32
                description: The auto-generated photo ID
              label:
                type: string
              description:
                type: string
              photo:
                type: object
                description: Information about the photo (size, file name, etc.)
          headers:
            Location:
              type: string
              description: The URL of the newly-added photo
    get:
      tags:
        - Mock API
      description: Get a list of the photos for a car
      responses:
        200:
          description: Returns the list of photos
          schema:
            type: array
            items:
              properties:
                id:
                  type: integer
                  format: int32
                  description: The auto-generated photo ID
                label:
                  type: string
                description:
                  type: string
                photo:
                  type: object
                  description: Information about the photo (size, file name, etc.)

  /mock/cars/{carRegistration}/photos/{id}:
    parameters:
      - $ref: '#/parameters/carRegistration'
      - name: id
        in: path
        description: The ID of the photo
        required: true
        type: integer
        format: int32
    get:
      tags:
        - Mock API
      description: Gets a car photo
      operationId: getCarPhoto
      produces:
        - image/jpeg
        - image/gif
        - image/png
        - image/bmp
      responses:
        default:
          description: Returns the car photo
          schema:
            type: file

    delete:
      tags:
        - Mock API
      description: Deletes a car photo
      operationId: deleteCarPhoto
      responses:
        default:
          description: The photo was deleted successfully

  /login:
    post:
      tags:
        - Login
      description: |
        Login to get JWT Token for API Access
      responses:
        '200':
          description: Returns valid JWT Token
          schema:
            $ref: '#/definitions/Token'
        '401':
          description: Unauthorized user
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: body
          in: body
          description: used credentials
          required: true
          schema:
            $ref: '#/definitions/LoginBody'
  /examples:
    get:
      tags:
        - Examples
      description: Fetch all examples
      security:
        - Bearer: []
      responses:
        200:
          description: Returns all examples
    post:
      tags:
        - Examples
      description: Create a new example
      security:
        - Bearer: []
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: body
          in: body
          description: number of items to skip
          required: true
          schema:
            $ref: '#/definitions/ExampleBody'
      responses:
        201:
          description: Example posted
        403:
          description: Forbidden Request

  /examples/{id}:
    get:
      tags:
        - Examples
      security:
        - Bearer: []
      parameters:
        - name: id
          in: path
          required: true
          description: The id of the entity to retrieve
          type: integer
      responses:
        200:
          description: Return the example with the specified id
        404:
          description: Example not available
  /shop/products:
    get:
      tags:
        - Products
      description: Fetch all examples
      responses:
        200:
          description: Returns all examples
  /shop/products/{id}:
    get:
      tags:
        - Products
      parameters:
        - name: id
          in: path
          required: true
          description: The id of the entity to retrieve
          type: integer
      responses:
        200:
          description: Return the example with the specified id
        404:
          description: Example not available
  /shop/productOptions:
    get:
      tags:
        - Products
      description: Fetch all examples
      responses:
        200:
          description: Returns all examples
  /shop/productOptions/{id}:
    get:
      tags:
        - Products
      parameters:
        - name: id
          in: path
          required: true
          description: The id of the entity to retrieve
          type: integer
      responses:
        200:
          description: Return the example with the specified id
        404:
          description: Example not available
  /shop/prices:
    get:
      tags:
        - Products
      description: Fetch all examples
      responses:
        200:
          description: Returns all examples
  /shop/prices/{id}:
    get:
      tags:
        - Products
      parameters:
        - name: id
          in: path
          required: true
          description: The id of the entity to retrieve
          type: integer
      responses:
        200:
          description: Return the example with the specified id
        404:
          description: Example not available
  /shop/inventory:
    get:
      tags:
        - Products
      description: Fetch all examples
      responses:
        200:
          description: Returns all examples
  /shop/inventory/{id}:
    get:
      tags:
        - Products
      parameters:
        - name: id
          in: path
          required: true
          description: The id of the entity to retrieve
          type: integer
      responses:
        200:
          description: Return the example with the specified id
        404:
          description: Example not available
  /shop/priceByOptionId/{id}:
    get:
      tags:
        - Products
      parameters:
        - name: id
          in: path
          required: true
          description: The id of the entity to retrieve
          type: integer
      responses:
        200:
          description: Return the example with the specified id
        404:
          description: Example not available
  /starwars/people/{id}:
    get:
      tags:
        - Starwars
      parameters:
        - name: id
          in: path
          required: true
          description: The id of the entity to retrieve
          type: integer
        - name: fields
          in: query
          required: false
          description: Custom List of fields to be rendered
          type: string
      responses:
        200:
          description: Return the example with the specified id
        404:
          description: Example not available
  /hystrix-demo/start:
    get:
      tags:
        - Hystrix Demo
      responses:
        200:
          description: Random API Failure
  /hystrix-demo/posts:
    get:
      tags:
        - Hystrix Demo
      parameters:
        - name: timeOut
          in: query
          required: false
          description: Time Out Value
          type: integer
      responses:
        200:
          description: Posts API Timeout Failure with Fallback
  /scraper/scrape:
    get:
      tags:
        - Scrape URL
      description: Returns the product scraped from Amazon
      parameters:
        - name: name
          in: query
          required: true
          description: Name of the List
          type: string
        - name: headless
          in: query
          required: false
          type: boolean
        - name: url
          in: query
          required: true
          description: URL to scrape for example (https://www.amazon.in/dp/B074ZJY1JD)
          type: string
        - name: save
          in: query
          required: true
          description: Persist the list
          type: boolean
      responses:
        200:
          description: Gets product data that is scraped from Amazon
  /scraper/scrapeList:
    get:
      tags:
        - Scrape Amazon ASIN LIST
      description: Returns the list products scraped from Amazon
      parameters:
        - name: name
          in: query
          required: true
          description: Name of the List
          type: string
        - name: country
          in: query
          required: false
          type: string
        - name: marketplace
          in: query
          required: false
          type: string
        - name: baseUrl
          in: query
          required: false
          type: string
        - name: asinList
          in: query
          required: true
          description: Comma separated ASIN List to scrape for example "B074ZJY1JD,B01GCEF7R8"
          type: string
        - name: startDate
          required: false
          in: query
          type: string
          description: publish start date
          format: date-time
        - name: endDate
          required: false
          in: query
          type: string
          description: publish end date
          format: date-time
        - name: save
          in: query
          required: true
          description: Persist the list
          type: boolean
        - name: withURL
          in: query
          required: false
          description: If full URL is provided
          type: boolean
      responses:
        200:
          description: Gets product data that is scraped from Amazon
  /scraper/products:
    get:
      tags:
        - Get all products
      responses:
        200:
          description: Return the products with the specified name
        404:
          description: Products not available   
    post:
      tags:
        - Save products
      description: Save Scrapped Products Data JSON
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: body
          in: body
          description: product JSON
          required: true
          schema:
            $ref: '#/definitions/ProductsBody'
      responses:
        201:
          description: Products List posted
        403:
          description: Forbidden Request

  /scraper/publish:
    get:
      tags:
        - Get all published products
      responses:
        200:
          description: Return the products with the specified name
        404:
          description: Products not available   
    post:
      tags:
        - Save publish details
      description: Save Published Products Data JSON
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - name: body
          in: body
          description: product JSON
          required: true
          schema:
            $ref: '#/definitions/PublishedProductsBody'
      responses:
        201:
          description: Published Products List posted
        403:
          description: Forbidden Request
  /scraper/publish/{name}:
    get:
      tags:
        - Get publish details
      parameters:
        - name: name
          in: path
          required: true
          description: The name of the published site
          type: string
      responses:
        200:
          description: Return the published site with the specified name
        404:
          description: Publish site not available
    delete:
      description: deletes a single campaign publish record based on the name supplied
      operationId: deleteCampaignPublish
      parameters:
        - name: name
          in: path
          description: Name of campaign publish record to delete
          required: true
          type: string
      responses:
        204:
          description: campaign publish record deleted
        404:
          description: campaign publish record not available      
  /scraper/products/{name}:
    get:
      tags:
        - Get products
      parameters:
        - name: name
          in: path
          required: true
          description: The name of the entity to retrieve
          type: string
      responses:
        200:
          description: Return the products with the specified name
        404:
          description: Products not available
    delete:
      description: deletes a single can campaign based on the name supplied
      operationId: deleteCampaignProducts
      parameters:
        - name: name
          in: path
          description: Name of campaign to delete
          required: true
          type: string
      responses:
        204:
          description: campaign deleted
        404:
          description: Campaign not available