Fix swagger codegen typings
Maintainers usually reply within 2 days
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- typescript
- Domain
- api
Research direction
Inspect the generated models from the swagger codegen typescript-axios plugin and compare them with typescript-fetch output, focusing on the TaskProgress and TaskSummary examples. Determine whether switching plugins or addressing the typescript-axios generation issue is appropriate; done means custom models receive correct TypeScript typings while remaining usable in Node without an incompatible polyfill.
Written by the indexing model from the issue text.
Description
It seems the typescript-axios plugin does not generate correct typings, all the models have any type. The typescript-fetch plugin works as expected but is not immediately compatible with node without a "polyfill".
This get more important as we start to have more "custom" models. For example, the TaskProgress model is based off of rmf's TaskSummary message, with an additional field to indicate the current progress. These "custom" models are not reflected in rmf-models and must be imported from api-client. In the future, dashboard and react-component might not use rmf-models directly anymore, all model definitions will come from api-client.
We can either switch to typescript-fetch or attempt to fix typescript-axios upstream. Note that swagger codegen is a java project so that requires a different set of expertise.
- Dominant language
- TypeScript
- Stars
- 140
- Forks
- 87
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 13
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from open-rmf/rmf-web
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 25/100
open-rmf/rmf-web#1081 · 4 comments ·
Maintainers usually reply within 2 days
-
[Other issue]: Trajectories are not displayed on the rmf-web map for 'coordinate_system: wgs84' mapsOpen
Difficulty 4/5 3-5 days Newbie friendliness 32/100
open-rmf/rmf-web#1058 · 6 comments ·
Maintainers usually reply within 2 days
-
Migrate task forms to use jsonformsMay be free again @aaronchongth claimed this 611 days ago, and no pull request is open. Open
open-rmf/rmf-web#997 · 1 assignee ·
Maintainers usually reply within 2 days
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 25/100
Maintainers usually reply within 2 days
-
Rmf-web seems unable to verify the submitted task information.Possibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 4/5 3-5 days Newbie friendliness 35/100
open-rmf/rmf-web#684 · 2 comments ·
Maintainers usually reply within 2 days
All issues in open-rmf/rmf-web
Similar issues
-
area:docs documentation good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 12 days
-
area:docs good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
thainanluiz/TSSuper#30 ·
-
[analytics-core] getQueryParams does not decode `+` as space and truncates values containing `=`Openbug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
amplitude/Amplitude-TypeScript#2179 · 1 comment ·
Maintainers usually reply within 2 days
-
ci good first issue severity: low
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
TMHSDigital/GH-Arcade#111 ·