POS-V2.openapi.json

{"openapi":"3.0.1","info":{"title":"POS-V2","description":"","version":"1.0.0"},"tags":[{"name":"User"},{"name":"brand"},{"name":"Category"},{"name":"image"},{"name":"product"}],"paths":{"/user/login/":{"post":{"summary":"login-employee","deprecated":false,"description":"","tags":["User"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"}},"required":["username","password"]},"example":{"username":"01000000001","password":"12345"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{}}}},"headers":{}}},"security":[]}},"/brand/":{"post":{"summary":"create","deprecated":false,"description":"Create brands here. ","tags":["brand"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"images":{"type":"array","items":{"type":"integer","examples":[1,2,3]}},"parent":{"type":"integer","examples":[1]}},"required":["name"]},"example":{"name":"brand 1","images":[1,2],"parent":1}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{}}}},"headers":{}}},"security":[{"bearer":[]}]}},"/brand":{"get":{"summary":"fetch","deprecated":false,"description":"Fetch paginated or unpaginated data from here with filter and search options","tags":["brand"],"parameters":[{"name":"name","in":"query","description":"Brand name","required":false,"example":"Arong","schema":{"type":"string"}},{"name":"parent","in":"query","description":"Parent brand id","required":false,"example":123,"schema":{"type":"integer"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{}}}},"headers":{}}},"security":[{"bearer":[]}]}},"/brand/{id}/":{"patch":{"summary":"update/{id}/","deprecated":false,"description":"Update a brand by it's id","tags":["brand"],"parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Brand name"},"parent":{"type":"integer","description":"Brand parent id"},"images":{"type":"array","items":{"type":"integer","examples":[1,2,3,4]}}}},"example":{"name":"Barong","parent":1231,"images":[3,1]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{}}}},"headers":{}}},"security":[{"bearer":[]}]},"get":{"summary":"fetch/{id}/","deprecated":false,"description":"","tags":["brand"],"parameters":[{"name":"id","in":"path","description":"Brand id","required":true,"example":"123","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{}}}},"headers":{}}},"security":[{"bearer":[]}]}},"/category/":{"post":{"summary":"create","deprecated":false,"description":"Create a category here","tags":["Category"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"images":{"type":"array","items":{"type":"integer","examples":[2,3,4]}},"parent":{"type":"integer"}},"required":["name"]},"example":{"name":"category 1","images":[2],"parent":2323}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{}}}},"headers":{}}},"security":[{"bearer":[]}]}},"/category/1/":{"get":{"summary":"fetch","deprecated":false,"description":"Get a list of categories with or without pagination","tags":["Category"],"parameters":[{"name":"name","in":"query","description":"category name","required":false,"example":"Sharee","schema":{"type":"string"}},{"name":"parent","in":"query","description":"parent id","required":false,"example":12334,"schema":{"type":"integer"}},{"name":"paginate","in":"query","description":"","required":false,"example":"false","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{}}}},"headers":{}}},"security":[{"bearer":[]}]}},"/category/{id}/":{"patch":{"summary":"update/{id}/","deprecated":false,"description":"Update a category by it's id","tags":["Category"],"parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"category name"},"parent":{"type":"integer","description":"category parent id"},"images":{"type":"array","items":{"type":"integer","examples":[1,2,3,4,5]}}}},"example":{"name":"panjabi","parent":323,"images":[5,3]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{}}}},"headers":{}}},"security":[{"bearer":[]}]},"get":{"summary":"fetch/{id}","deprecated":false,"description":"Get a single category by it's id","tags":["Category"],"parameters":[{"name":"id","in":"path","description":"","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{}}}},"headers":{}}},"security":[{"bearer":[]}]}},"/image/":{"post":{"summary":"Store Image","deprecated":false,"description":"","tags":["image"],"parameters":[],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"image_file":{"type":"string","format":"binary"}},"required":["image_file"]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{}}}},"headers":{}}},"security":[{"bearer":[]}]},"get":{"summary":"get images","deprecated":false,"description":"","tags":["image"],"parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{}}}},"headers":{}}},"security":[{"bearer":[]}]}},"/product/":{"post":{"summary":"create","deprecated":false,"description":"","tags":["product"],"parameters":[],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"remarks":{"type":"string"},"brand":{"type":"integer"},"category":{"type":"integer"},"product_attributes":{"type":"array","items":{"type":"string"}},"images":{"type":"array","items":{"type":"integer"}}},"required":["name","remarks","brand","category","product_attributes","images"]},"example":{"name":"Product 2","remarks":"Produict remarks","brand":1,"category":1,"product_attributes":["attr 1","attr 2"],"images":[1]}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{}}}},"headers":{}}},"security":[{"bearer":[]}]},"get":{"summary":"list","deprecated":false,"description":"","tags":["product"],"parameters":[],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{}}}},"headers":{}}},"security":[{"bearer":[]}]}}},"components":{"schemas":{},"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"servers":[{"url":"https://api.pos.jodumodu.com/api/v1","description":"Testing Env"}]}