Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Module uploader is poorly documented #2149

Open
alexslavr opened this issue Nov 25, 2021 · 0 comments
Open

Module uploader is poorly documented #2149

alexslavr opened this issue Nov 25, 2021 · 0 comments
Assignees
@EugeniyBurmistrov
Labels
docs Documentation related changes severity: moderate Issues with medium impact on the product, e.g., new features, non-critical defects, etc.

Comments

@alexslavr
Copy link

Usage on the client-side is not documented at all.

API handlers description is wrong:
Screenshot 2021-11-24 at 18 05 10

e.g. getFormUpload endpoint returns not an upload path, but the object

form: {
   fields: {}
   url: "http://localhost:3000/uploader?dir=images&uploadId=c5c61b58-b6d4-4ce0-8ea8-ccbab3151045"
   uploadId: "c5c61b58-b6d4-4ce0-8ea8-ccbab3151045"
}

It's unclear how to use form.fields

TS typings are also useless:
Screenshot 2021-11-24 at 18 06 26
@MrCheater MrCheater added docs Documentation related changes severity: moderate Issues with medium impact on the product, e.g., new features, non-critical defects, etc. labels Nov 25, 2021
@EugeniyBurmistrov EugeniyBurmistrov self-assigned this Feb 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@EugeniyBurmistrov EugeniyBurmistrov

Labels
docs Documentation related changes severity: moderate Issues with medium impact on the product, e.g., new features, non-critical defects, etc.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@MrCheater @alexslavr @EugeniyBurmistrov