sheltertechsf / sheltertech-go Goto Github PK

Add the GET /categories/counts to GO

We don't have a technical specification, so part of this task is to also figure out which endpoints we need and how they should be implemented.

See https://docs.google.com/document/d/1XsgVEfRH9zn4XMQlhtqgfhaJAoL8TV8F6yNlLFa2MA4/edit#bookmark=id.qedtweia4g1e for the high level feature requirement, and https://www.figma.com/file/XUttHGa1csIpbSiurbYmjo/Case-Worker?type=design&node-id=7168-4476&mode=design&t=hcGEvgxPwD4YO79c-0 for the Figma Designs.

The main UI interactions are being able to create new bookmarks, create new folders, and reordering bookmarks within folders.

Migrate POST /categories to GO

Migrate PATCH /categories/id to GO

Acceptance: Route to Update a Bookmark for User

Design notes: feature requirements

Notes:

• auth aware
• domain object: schema.rb
• can change order of bookmark within a folder (or in default space)

Migrate PUT /categories/id to GO

Acceptance: Route to delete a folder associated with the current user

Design notes: feature requirements

Notes:

• folders cannot be nested
• object model: schema.rb

Open Question:

• do we want to remove all bookmarks in the folder, just move them to be associated with the user (no folder), or give the User the choice between the two?

Swagger doc or equivalent to ruby’s no matched route feature

MigratemDELETE /categories/id to GO

Figure out how to model this in the DB and how to create an API for it as well

We can use Github Actions for this like we do with the Rails API repo

There is a mostly done implementation in the repo currently. We should do these things:

1. Verify all routes and logic from those different HTTP method have been migrated over. Rout]

Route Definitions
Rails: https://github.com/ShelterTechSF/askdarcel-api/blob/master/config/routes.rb#L7-L13
Go: https://github.com/ShelterTechSF/sheltertech-go/blob/main/cmd/sheltertech-go/main.go#L30-L33

2. Complete automated tests to cover all those changes

Couple examples here: https://github.com/ShelterTechSF/sheltertech-go/blob/main/cmd/sheltertech-go/integration_test.go

They do require having the DB from the Rails repo running, we may need to chat about that setup.

Migrate GET /categories/hierarchy to GO
This endpoint queries the 'categories' table and where top_level=true, a nested query to the 'category-relationships' table finds child categories. The response body is an object with the "categories" prefix, followed by an array of empty slices for categories with no children, and sub-arrays of child objects if they exist, ordered (optionally) by rank.

Acceptance: Route to return all folders (with name and order for the current user)

Design notes: figma

Notes:

• auth aware
• object model: schema.rb
• returned in increasing order number with name
• endpoint does not need to list all bookmarks per folder

Acceptance: Create a new bookmark for a given resource

Design notes: feature requirements

Notes:

• bookmarks are associated with users, folders and services
• Organizations and Services can be bookmarked
• object model: schema.rb

Single test context instead of one per test case

Use an in memory DB under the test context

Acceptance: Route to Update a Folder's name and order for a User

Design notes: feature requirements

Notes:

• folders cannot be nested
• object model: schema.rb

Acceptance: Route to create a folder with name and next priority order for the current user

Design notes: feature requirements

Notes:

• folders cannot be nested
• object model: schema.rb

Add categories:{} to the categories API response so it matches the Ruby API

Acceptance: Delete a current bookmark for a user

Design notes: feature requirements

Notes:

• bookmarks are associated with users, folders and services
• object model: schema.rb