/paypalBAT

Product Manegement REST API

Primary LanguageJavaScript

paypalBAT

Product Manegement REST API

Description

The product mangement system is made for a startup named Brainwave Assistive Technologies. The startup builds neurotechnology devices with the help of Brain Computer Interfaces. The product mangement system is meant for the employees of the company to help with supply chain management and logistics.

Swagger API Code Link

BAT v1

Swagger API Documentation Link

BAT v1

Github Documentation

Documentation Link

Paypal VAP Class Repo

PayPalVAP

Class Diagram

The following class diagram describes the relations between the entities used in the API.

classDiagram

Entities

  1. Product
Attributes Description
ID ID of the product
Name Name of the product
Version Version of the product
DateCreated Date on which the product was created
wip Work in progress
  1. Supplier
Attributes Description
ID ID of the supplier
name Name of the supplier
  1. Material
Attributes Description
ID ID of the material
Name Name of the material
type Type of the material: (raw, component)
  1. Team
Attributes Description
ID Id of team
  1. Members
Attributes Description
empID ID of the member
Name Name of the member
Age Age of the member
  1. Warehouse
Attributes Description
ID ID of the warehouse
Location Location of the warehouse
Capacity Capacity of the warehouse
  1. Factory
Attributes Description
ID ID of the factory
Location Location of the factory
  1. Inventory
Attributes Description
ID ID of the inventory item
storageType Type of storage the item is stored in: (warehouse, store)
StorageID ID of the storage
Quantity Amount of items stored
InventoryType Type of item: (raw, component, product)
ItemID ID of the item stored
  1. Store
Attributes Description
ID ID of the store
location Location of the store
Ownership Type of ownership: (1st Party, 3rd Party)
Name Name of store if third party

Components used in Swagger

  • Schemas
  • Parameters
  • Error
  • Security Schemas

Error Codes used in Swagegr

  • 200
  • 400
  • 401
  • 404

Some of the features which are used

auth

Authentication

auth

Tags

auth

Request Body

auth

Sucessful Response

auth

Error Responses

auth

GET Parameters

auth auth

Multiple Examples

auth

Query String

auth

Security Scheme with scopes

auth

Reusable Parameters

auth

Reusable Responses

auth

Reusable Schemas