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. |
| | `"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
| @@ -88,6 +88,30 @@ curl -X 'POST' \ | |||
| 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.
Without :::
Yeah now looking at it without ::: I think it looks better, but its fine with ::: too, what do you think which one is better? I already fixed the errors documentation issue and removed the code comment, i'll commit when you decide on this
There was a problem hiding this comment.
actually, would this be better in errors.md? just making a section for signup (and also the others when I add them)
There was a problem hiding this comment.
@silacs sorry for the late response. Let's keep it without an alert; a single table looks better. It would be great if each endpoint had its own error mapping.
There was a problem hiding this comment.
yeah, im thinking of making it like how the shop is in the sidebar
so
errors
ⳑ Auth
ⳑ Products
ⳑ Cart
and then each category will have errors for each endpoints
what do you think?
There was a problem hiding this comment.
Could work but each time user has to search it, would be better if it will be with endpoint description
No description provided.