akash-network / akash-network/console

Rename the files of the router definition in the router file and service file

Open
#1,282 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

tech-debt
Dominant language
TypeScript
Stars
264
Forks
94
Avg merge
18h 49m
Merged PRs (30d)
297

Description

Why

We need to plan ahead for future api versions and right now there's no strategy implemented to handle future versions of the api endpoints.

What

We will establish a new file naming convention to include the version of the route in the filename.

Rename all the routers under the modules with the version of the api (current v1) in the name of the file.

For example:

start-trial.v1.router.ts
start-trial.v2.router.ts

Contributor guide

Open the contributing guide

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

Start by inspecting the router and service files under the modules to inventory the existing router definitions and their references. Rename the current API version's router files to include v1, update references as needed, and verify that the project builds and its existing checks pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, backend
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.