Epic-Breakfast-Productions / OpenQuarterMaster

Open Quartermaster is an open source inventory management system, designed to be simple to use yet powerful and extendable. The last inventory management system you will ever need!
https://openquartermaster.com
GNU General Public License v3.0
10 stars 6 forks source link

[FR]: Core API - Rework Stored Items #683

Open GregJohnStewart opened 3 weeks ago

GregJohnStewart commented 3 weeks ago

Software

Core API, Base Station

Describe what you'd like to see

We should move from keeping stored in the Item object to keeping them in a separate collection.

Benefits:

Object Changes

Items

Stored

New API layout

/.../inventoryItem [C, S]
                  /<item id> [R, U, D]
                            /stored [S]
                                   /transact (add/ subtract/ transfer/ checkout object types)
                                   /transaction [S]
                                           /<transactionId> [R]
                                   /stats (same as interface for search, but returns a stats object for stored related to an item)
                                   /inBlock/<blockId> [C(if amount, create with 0) S]
                                                     /stats (same as interface for search, but returns a stats object for stored related to an item + block)
                                                     /<storedId> [R, U (update only data, not amounts)]

C/reate R/ead U/pdate D/elete S/earch


Is your feature request related to a problem?

Test users have expressed some confusion on methods of storage. Additionally, old method does not scale well for large amounts of individual stored items

Describe alternatives you've considered

None

Additional context

None

Checklist:

API

UI