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: Delete a current bookmark for a user

Design notes: feature requirements

Notes:

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

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.

MigratemDELETE /categories/id to GO

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

The design mockups expected that a user could set the name of their bookmark, but neither the database table nor the API support setting a name on bookmarks.

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?

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)

Without an ORM like Rails' ActiveRecord, ensuring that the updated_at field is updated every time a row is modified is up to us. We are not consistently doing this, and we should at least make sure that all existing endpoints are updating the updated_at field.

Add the GET /categories/counts to GO

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

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

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

Migrate PATCH /categories/id to GO

The design mockups state that the dashboard should display the date/time at which a bookmark folder was most recently updated, but the API doesn't currently return the updated_at field, so there is no way for the frontend to display this information.

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

The error handling in the recently added Bookmarks, Folders, and Saved Search endpoints is fairly inconsistent. A few baseline things that we should do are:

• Make sure that failures actually result in 4xx or 5xx status codes so that API clients are aware that an error occurred
• Make sure client-side errors result in 4xx (usually 400) status codes
• Make sure that server-side errors result in 5xx status codes

Migrate POST /categories to GO

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.

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.

Use an in memory DB under the test context

The first pass at these endpoints are probably going to be merged without performing authorization checks. This ticket is meant to track the task of actually enforcing authorization checks for these endpoints, which we'll want before launch.

Specifically, for the MVP, we want to enforce that the authenticated user (via the JWT) matches the user in the actual database user_id foreign key column for each of these resources.

Post-MVP, we may want to loosen this if we want to enable a feature for users to share bookmarks, folders, or saved searches with each other, but we need a lot more discussion about how that should work in our app.

Migrate PUT /categories/id to GO

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

Single test context instead of one per test case

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

There is nothing in the DB or API endpoint preventing a user from creating a duplicate bookmark, not even when present in the same folder. This probably isn't desirable, and we should probably disallow this.