Skip to content

README should not overstate list-and-create APIs as CRUD routes #3504

@TheGreatAion

Description

@TheGreatAion

Parent bounty: #743

Documentation bug

The README backend overview says the API includes:

- CRUD routes for users, jobs, and proposals

However, the current routers only expose list and create handlers for those resources:

userRoutes.get(/, getUsers);
userRoutes.post(/, postUser);
jobRoutes.get(/, getJobs);
jobRoutes.post(/, postJob);
proposalRoutes.get(/, getProposals);
proposalRoutes.post(/, postProposal);

There are no update or delete handlers in those routers. Calling the surface CRUD overstates the implemented API and can mislead contributors who use the README as their orientation guide.

Expected behavior

The README should describe these resources as list and create routes until the remaining CRUD operations exist.

Scope

  • Replace the inaccurate CRUD wording with an accurate list-and-create description.
  • Keep the patch limited to this README correction.
  • Do not add API routes, change controller behavior, or modify unrelated documentation.

This issue is limited only to the creator of this issue. This means that only the issue author can attempt to solve this issue. If you would like to work on it, please create another issue with the same contents and refer to issue #743 for more information.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions