docs: add users api docs #290
Merged
Conversation
This file contains 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
|
@luisfelipec95 can we rebase this with master to fix the integration tests please? |
|
@luisfelipec95, Could we rebase with master dropping the additional commits? |
BryanttV
reviewed
Oct 22, 2024
BryanttV
reviewed
Oct 22, 2024
luisfelipec95
force-pushed
the
lfc/update-doc-api-users
branch
from
55f6a0b to
5aa677a
Compare
BryanttV
reviewed
Oct 22, 2024
BryanttV
reviewed
Oct 23, 2024
BryanttV
reviewed
Oct 24, 2024
There was a problem hiding this comment.
@luisfelipec95, I read the documentation and I think it is very good. However, I would modify the structure a bit to make it more orderly, something like this:
Users API Documentation
-
Endpoints
- GET (Get User)
- POST (Create User)
- PATCH (Update User)
-
Extra Profile Fields
The User API supports the use of extra and custom registration fields for...
- Adding a Custom Field
extended_profile_fieldsREGISTRATION_EXTRA_FIELDSEDNX_CUSTOM_REGISTRATION_FIELDSEOX_CORE_USER_UPDATE_SAFE_FIELDS(used only in the PATCH requests)
- Types of Custom Fields
- Text
- Select
- Checkbox
- TextArea
- Field Visibility Options
- Required
- Optional
- Hidden
- Optional-Exposed
- Adding a Custom Field
For my part, I have no further comments. Thanks!
Co-authored-by: Bryann Valderrama <64033729+BryanttV@users.noreply.github.com>
Co-authored-by: Bryann Valderrama <64033729+BryanttV@users.noreply.github.com>
Co-authored-by: Bryann Valderrama <64033729+BryanttV@users.noreply.github.com>
Co-authored-by: Bryann Valderrama <64033729+BryanttV@users.noreply.github.com>
Co-authored-by: Bryann Valderrama <64033729+BryanttV@users.noreply.github.com>
Co-authored-by: Bryann Valderrama <64033729+BryanttV@users.noreply.github.com>
Co-authored-by: Bryann Valderrama <64033729+BryanttV@users.noreply.github.com>
Co-authored-by: Bryann Valderrama <64033729+BryanttV@users.noreply.github.com>
Co-authored-by: Bryann Valderrama <64033729+BryanttV@users.noreply.github.com>
Co-authored-by: Bryann Valderrama <64033729+BryanttV@users.noreply.github.com>
Co-authored-by: Bryann Valderrama <64033729+BryanttV@users.noreply.github.com>
Co-authored-by: Bryann Valderrama <64033729+BryanttV@users.noreply.github.com>
Co-authored-by: Bryann Valderrama <64033729+BryanttV@users.noreply.github.com>
Co-authored-by: Bryann Valderrama <64033729+BryanttV@users.noreply.github.com>
luisfelipec95
force-pushed
the
lfc/update-doc-api-users
branch
from
25cdc39 to
67e7e52
Compare
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.
Description
This PR adds the user API documentation
Additional information
https://edunext.atlassian.net/browse/AP-1439