Repository navigation
[$250] [HOLD for payment 2024-02-07] Create centralized types for API params #33965
Description
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: @joekaufmanexpensifyUpwork Automation - Do Not Edit
- Upwork Job URL: https://www.upwork.com/jobs/~017c2ec18790b398be
- Upwork Job ID: 1754981618246774784
- Last Price Increase: 2024-02-06
Activity
melvin-bot commentedon Jan 4, 2024
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 commentedon Jan 4, 2024
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 commentedon Jan 4, 2024
cc @blazejkustra @fabioh8010
blazejkustra commentedon Jan 4, 2024
Commenting for assignment, thanks for creating this one @roryabraham
blazejkustra commentedon Jan 9, 2024
I got sick and work half hours, I'll get back to this next week 🤗
roryabraham commentedon Jan 17, 2024
@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.
21 remaining items
roryabraham commentedon Feb 6, 2024
@joekaufmanexpensify assigning you back here to help issue C+ payment to @s77rt for their review of #34542
joekaufmanexpensify commentedon Feb 6, 2024
Sounds good. Payment here is $250 for TS PR review to @s77rt. Paid via Upwork.
[-][HOLD for payment 2024-02-07] Create centralized types for API params[/-][+][$500] [HOLD for payment 2024-02-07] Create centralized types for API params[/+]melvin-bot commentedon Feb 6, 2024
Job added to Upwork: https://www.upwork.com/jobs/~017c2ec18790b398be
melvin-bot commentedon Feb 6, 2024
Current assignee @s77rt is eligible for the External assigner, not assigning anyone new.
[-][$500] [HOLD for payment 2024-02-07] Create centralized types for API params[/-][+][$250] [HOLD for payment 2024-02-07] Create centralized types for API params[/+]melvin-bot commentedon Feb 6, 2024
Upwork job price has been updated to $250
joekaufmanexpensify commentedon Feb 6, 2024
@s77rt offer sent for $250!
s77rt commentedon Feb 6, 2024
@joekaufmanexpensify Accepted! Thanks!
joekaufmanexpensify commentedon Feb 6, 2024
$250 sent and contract ended!
joekaufmanexpensify commentedon Feb 6, 2024
All set!