jamesplease / jamesplease/api-pls

Add relationship routes

Open
#15 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
JavaScript
Stars
10
Forks
1
PR merge metrics
No merged PRs in 30d

Description

There are two ways to do this:

1. Hardcoding the routes in. I can do this because I will know all of the possible relationships from the resource definitions. The downside to this approach is that the route config will become a bit less tidy.

2. Star routes, then managing finding the routes from within the middleware. This can still use the definitions, but it would keep the route config file more orderly.

---

There are two types of routes I need to support:

`/books/1/relationships/author`

`/books/1/author`

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the resource definitions, route configuration, and middleware described in the issue, starting with how existing routes are registered. Decide between explicit relationship routes and starred routes, then verify that both `/books/1/relationships/author` and `/books/1/author` are supported for defined relationships.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.