feat: added documentation for employee invitation_code field #13
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
EmberCraze
reviewed
Apr 24, 2025
source/includes/_employees.md
Outdated
| ``` | ||
|
|
||
| This endpoint registers an Employee. | ||
| This endpoint registers an Employee. The employee will be notified with a invitation code which can be used to create a |
There was a problem hiding this comment.
Is it important to go into details on what happens? Should we not just say that they will get an email to start their onboarding journey? Or is it better to be more explicit? I am thinking if the mechanic changes then we would have to go back and change the docs
EmberCraze
reviewed
Apr 24, 2025
source/includes/_employees.md
Outdated
|
|
||
| This endpoint resends an invitation. After resending, you need to wait at least 24 hours before resending again. | ||
| This endpoint resends notification with a invitation code. After resending, you need to wait at least 24 hours before resending again. |
There was a problem hiding this comment.
Suggested change
| This endpoint resends notification with a invitation code. After resending, you need to wait at least 24 hours before resending again. | |
| This endpoint resends a notification with an invitation code. After resending, you need to wait at least 24 hours before resending again. |
There was a problem hiding this comment.
Didn't you change this to a more reasonable rate limit?
Author
There was a problem hiding this comment.
No, I fixed it to make sure it's 24 hours.
gustav
requested changes
Apr 24, 2025
source/includes/_employees.md
Outdated
Comment on lines
193
to
194
| This endpoint registers an Employee. The employee will be notified with a invitation code which can be used to create a | ||
| magic link to claim the employee. |
There was a problem hiding this comment.
Suggested change
| This endpoint registers an Employee. The employee will be notified with a invitation code which can be used to create a | |
| magic link to claim the employee. | |
| This endpoint registers an Employee. The Employee will be notified with the `invitation_code` that can be used to sign up in Gigapay and accept your invitation. |
source/includes/_employees.md
Outdated
|
|
||
| This endpoint resends an invitation. After resending, you need to wait at least 24 hours before resending again. | ||
| This endpoint resends notification with a invitation code. After resending, you need to wait at least 24 hours before resending again. |
There was a problem hiding this comment.
Didn't you change this to a more reasonable rate limit?
Author
Where? Cannot find the comment. |
EmberCraze
approved these changes
Apr 24, 2025
gustav
approved these changes
Apr 24, 2025
mdamire
added a commit
that referenced
this pull request
Apr 24, 2025
…_code_field generated from commit c56ea32
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.