Implement initial REST API #1

New Issue

apollo · 2024-01-22T12:24:37-06:00

apollo commented

2024-01-22 12:24:37 -06:00

In order for this application to start being useful, the API to interact with Assets needs to be completed. Ideally this will include advanced querying by various fields and partial updates.

Bare minimum implementation needs to include:

Assets

GET /assets?offset=&limit=
- Retrieve a number of assets, with the (optionally) given offset and limit
GET /assets/:id
- Retrieve a single asset by database ID
POST /assets
- Create an Asset, using provided JSON body
PUT /assets/:id
- Fully update an Asset, using provided JSON body & database ID
DELETE /assets/:id
- Delete an Asset using the database ID

Buildings

GET /buildings?offset=&limit=
- Retrieve a number of Buildings, with the (optionally) given offset and limit
GET /buildings/:id
- Retrieve a single Building by database ID
POST /buildings
- Create a Building, using provided JSON body
PUT /buildings/:id
- Fully update a Building, using provided JSON body & database ID
DELETE /buildings/:id
- Delete a Building using the database ID

Shelf Locations

GET /shelves?offset=&limit=
- Retrieve a number of Shelf Locations, with the (optionally) given offset and limit
GET /shelves/:id
- Retrieve a single Shelf Location by database ID
POST /shelves
- Create a Shelf Location, using provided JSON body
PUT /shelves/:id
- Fully update a Shelf Location, using provided JSON body & database ID
DELETE /shelves/:id
- Delete a Shelf Location using the database ID

Stretch Goals

As stated above, it would be beneficial to implement a more advanced query system for (at the very least) Assets, allowing to search by the various fields. Initially, the relationships (Category/Shelf) would likely need to be by ID, however including the ability to search by name would be extremely beneficial.

In order for this application to start being useful, the API to interact with Assets needs to be completed. Ideally this will include advanced querying by various fields and partial updates. Bare minimum implementation needs to include: ### Assets - [ ] GET /assets?offset=&limit= - Retrieve a number of assets, with the (optionally) given offset and limit - [x] GET /assets/:id - Retrieve a single asset by database ID - [x] POST /assets - Create an Asset, using provided JSON body - [ ] PUT /assets/:id - Fully update an Asset, using provided JSON body & database ID - [x] DELETE /assets/:id - Delete an Asset using the database ID ### Buildings - [ ] GET /buildings?offset=&limit= - Retrieve a number of Buildings, with the (optionally) given offset and limit - [x] GET /buildings/:id - Retrieve a single Building by database ID - [x] POST /buildings - Create a Building, using provided JSON body - [ ] PUT /buildings/:id - Fully update a Building, using provided JSON body & database ID - [x] DELETE /buildings/:id - Delete a Building using the database ID ### Categories - [ ] GET /categories?offset=&limit= - Retrieve a number of Categories, with the (optionally) given offset and limit - [x] GET /categories/:id - Retrieve a single Category by database ID - [x] POST /categories - Create a Category, using provided JSON body - [ ] PUT /categories/:id - Fully update a Category, using provided JSON body & database ID - [x] DELETE /categories/:id - Delete a Category using the database ID ### Shelf Locations - [ ] GET /shelves?offset=&limit= - Retrieve a number of Shelf Locations, with the (optionally) given offset and limit - [x] GET /shelves/:id - Retrieve a single Shelf Location by database ID - [x] POST /shelves - Create a Shelf Location, using provided JSON body - [ ] PUT /shelves/:id - Fully update a Shelf Location, using provided JSON body & database ID - [x] DELETE /shelves/:id - Delete a Shelf Location using the database ID ## Stretch Goals As stated above, it would be beneficial to implement a more advanced query system for (at the very least) Assets, allowing to search by the various fields. Initially, the relationships (Category/Shelf) would likely need to be by ID, however including the ability to search by name would be extremely beneficial.

apollo added the enhancement label 2024-01-22 12:50:52 -06:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: goinv/server#1