[$250] [HOLD for payment 2024-02-07] Create centralized types for API params

[roryabraham]

context: #28695 (comment)

Problem

Currently, we're defining a type for API params before each use of that API endpoint. This could lead to inconsistent application of API params and might make it difficult to know the params (and associated types) accepted by each API endpoint.

Solution

Create a centralized map mapping API endpoint (string) to the params accepted by that endpoint.

Issue Owner

Current Issue Owner: @joekaufmanexpensify

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~017c2ec18790b398be
• Upwork Job ID: 1754981618246774784
• Last Price Increase: 2024-02-06

[melvin-bot]

Triggered auto assignment to @joekaufmanexpensify (NewFeature), see https://stackoverflowteams.com/c/expensify/questions/14418#:~:text=BugZero%20process%20steps%20for%20feature%20requests for more details.

[roryabraham]

While we think this is a good idea in the short-term for its own merits, part of our thinking here is that in the long-term we'll be able to define API params in the API (where they are actually defined), and build some compile-time tool that can generate this map in the front-end so that the front-end is always up-to-date with all of the params accepted by each API endpoint.

[roryabraham]

cc @blazejkustra @fabioh8010

[blazejkustra]

Commenting for assignment, thanks for creating this one @roryabraham

[blazejkustra]

I got sick and work half hours, I'll get back to this next week 🤗

[roryabraham]

@blazejkustra put up a PR for centralized API params. Overall it looks good but it's very large and as such things would likely go smoother if we break it up into multiple PRs and migrate one actions file at a time.

Unless I'm mistaken these PRs should be almost 100% compile-time type changes, so I think we could loosen the screenshot and review requirements for each, unless there are any runtime changes introduced, as is often the case when types are found to be incorrect in TS migration PRs.

[roryabraham]

Chatted with @blazejkustra, I'm ok with doing a single PR as long as our C+ is thoroughly testing. It's a fair amount of overhead to review such a big PR but ultimately it does look quite safe.

[blazejkustra]

PR is up and ready for C+ review. @s77rt was selected, please have a look on comments above.

[melvin-bot]

Reviewing label has been removed, please complete the "BugZero Checklist".

[melvin-bot]

The solution for this issue has been 🚀 deployed to production 🚀 in version 1.4.33-5 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

• [TS migration] Create centralized types for API params #34542

If no regressions arise, payment will be issued on 2024-02-07. 🎊

For reference, here are some details about the assignees on this issue:

• @blazejkustra does not require payment (Contractor)

[melvin-bot]

BugZero Checklist: The PR adding this new feature has been merged! The following checklist (instructions) will need to be completed before the issue can be closed:

• [@blazejkustra] Please propose regression test steps to ensure the new feature will work correctly on production in further releases.
• [] Link the GH issue for creating/updating the regression test once above steps have been agreed upon.

[roryabraham]

@joekaufmanexpensify assigning you back here to help issue C+ payment to @s77rt for their review of #34542

[joekaufmanexpensify]

Sounds good. Payment here is $250 for TS PR review to @s77rt. Paid via Upwork.

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~017c2ec18790b398be

[melvin-bot]

Current assignee @s77rt is eligible for the External assigner, not assigning anyone new.

[melvin-bot]

Upwork job price has been updated to $250

[joekaufmanexpensify]

@s77rt offer sent for $250!

[s77rt]

@joekaufmanexpensify Accepted! Thanks!

[joekaufmanexpensify]

$250 sent and contract ended!

[joekaufmanexpensify]

All set!