Added list of errors on sign up request in the docs #116
Conversation
|
@CondensedMilk7 turned it into a table, I think that commit automatically got added to this pull request too right? |
|
@silacs is it ready for review? |
|
@KostaD02 yeah, the thing I wanted (possible errors on signup) is ready. |
docs/authentication.md
Outdated
| | `"errors.invalid_avatar"` | When avatar url is not a url | | ||
| | `"errors.invalid_gender"` | When gender is not `'MALE'`, `'FEMALE'` or `'OTHER'` | | ||
| | `"errors.email_in_use"` | When email is already registered | | ||
| <!-- | `"errors.teapot"` | When brewing coffee is requested | --> |
There was a problem hiding this comment.
Whats the point? would be better without comment.
Preferably to not keep unnecessary code
There was a problem hiding this comment.
forgot about that lol, you can remove it before accepting the pr right? I remember I checked some toggle allowing modifications or something like that
i'm not home right now and cant change it myself
should be home by the end of the day though, if you haven't changed it by then, then i will
There was a problem hiding this comment.
Would be great if you update it
docs/authentication.md
Outdated
| Email verification may also be required. | ||
| ::: | ||
|
|
||
| ::: info NOTE |
There was a problem hiding this comment.
Imo it would be better without alert
There was a problem hiding this comment.
Yeah, the table inside the note could be a little unreadable.
For example this is a note:
There was a problem hiding this comment.
yeah I know, but I built the docs and tested it and it looked fine imo, will show you a screenshot im going home soon
There was a problem hiding this comment.
Could you screenshot light and dark mode?
There was a problem hiding this comment.
Threre will be too many errors and it will be spammed.
Would be better to each endpoint have their own error maping. For example here:
There was a problem hiding this comment.
Thats what I'm saying, each endpoint will have their own errors, but Im talking about splitting the endpoints into different categories (different pages) like auth products and cart to be more organized
There was a problem hiding this comment.
Seperating and documenting error listings on endpoint-basis is a great idea.
There was a problem hiding this comment.
We discussed about it and it will be better if each endpoint will have their own error section not in different page in same place as in screenshot
@silacs
There was a problem hiding this comment.
Yeah sure, will start working on it in my free time
|
Just to clarify I haven't forgotten about this and I will still do it, just been really busy |
3 participants
No description provided.