docs: add users api docs #290

luisfelipec95 · 2024-10-10T22:50:17Z

Description

This PR adds the user API documentation

Additional information

https://edunext.atlassian.net/browse/AP-1439

BryanttV

Thanks @luisfelipec95!

BryanttV · 2024-10-15T19:05:22Z

docs/how_to/users_api.rst

+
+URL: ``/eox-core/api/v1/update-user/``
+
+Method: PATCH


Could we explain the use of EOX_CORE_USER_UPDATE_SAFE_FIELDS here? Also, could we explain and give an example about updating an extra profile field?

docs/how_to/users_api.rst

magajh · 2024-10-17T07:54:10Z

@luisfelipec95 can we rebase this with master to fix the integration tests please?

magajh

Thanks @luisfelipec95!

magajh · 2024-10-17T14:23:44Z

docs/how_to/users_api.rst

+
+ "extended_profile_fields": [ "org_name" ]
+
+2. Add org_name to REGISTRATION_EXTRA_FIELDS, indicating whether the field is hidden, optional, or required:


I think when people make a field in the setting hidden, It will not get updated when using the API. Have you tested it? we should explain this

magajh · 2024-10-17T14:24:47Z

docs/how_to/users_api.rst

+
+If, for example, we want to add the field `Organization name`, we will have to do the following:
+
+1. Add the field name, `org_name` for example, to `extended_profile_fields`. This indicates that `org_name` will be saved as an extended profile field.


Suggested change

1. Add the field name, `org_name` for example, to `extended_profile_fields`. This indicates that `org_name` will be saved as an extended profile field.

1. Add the field name, `org_name` for example, to `extended_profile_fields` setting. This indicates that `org_name` will be saved as an extended profile field.

magajh · 2024-10-17T14:25:28Z

docs/how_to/users_api.rst

+
+ "extended_profile_fields": [ "org_name" ]
+
+2. Add org_name to REGISTRATION_EXTRA_FIELDS, indicating whether the field is hidden, optional, or required:


Suggested change

2. Add org_name to REGISTRATION_EXTRA_FIELDS, indicating whether the field is hidden, optional, or required:

2. Add org_name to `REGISTRATION_EXTRA_FIELDS` setting, ...

I think we should also highlight better the possible options a field can have

magajh · 2024-10-17T14:30:14Z

docs/how_to/users_api.rst

+ "org_name": "required"
+ }
+
+3. In this step, we will create the custom field as a dictionary. In this case, we are going to create a text field for org_name. We must indicate: name, type, and label as the minimum:


Suggested change

3. In this step, we will create the custom field as a dictionary. In this case, we are going to create a text field for org_name. We must indicate: name, type, and label as the minimum:

3. Define the custom field by creating it as a dictionary inside the `EDNX_CUSTOM_REGISTRATION_FIELDS` setting. In this case, we are creating a text field for `org_name`. You must specify at least the `name`, `type`, and `label`:

magajh · 2024-10-17T14:30:37Z

docs/how_to/users_api.rst

+ "org_name": "required"
+ }
+
+3. In this step, we will create the custom field as a dictionary. In this case, we are going to create a text field for org_name. We must indicate: name, type, and label as the minimum:


We should specify what the possible types are

magajh · 2024-10-17T14:32:22Z

docs/how_to/users_api.rst

+
+
+
+**Extra Profile Fields**


I think we should add a little intro here, I'm thinking something like:
The User API supports the use of extra and custom registration fields for both Create and Update operations. This allows for flexibility in managing user profiles with additional fields beyond the default ones, ensuring that tenants can extend user data as needed.

magajh · 2024-10-17T14:32:58Z

docs/how_to/users_api.rst

+
+**Tenant settings**
+
+Add the following settings to the microsite where we want to add the fields:


Suggested change

Add the following settings to the microsite where we want to add the fields:

To add custom or extra registration fields for a specific tenant, you'll need to configure the following settings:

magajh · 2024-10-17T14:40:08Z

docs/how_to/users_api.rst

+
+**Creating custom registration fields**
+
+**Tenant settings**


To update an existing extra profile field from the User model like: gender, city, country, etc. Do we need to follow all these steps and configs? if not, can we explain what we will need to do for both cases? in case of an extra field (that already exists), and in the case of a custom field

BryanttV · 2024-10-22T17:12:25Z

@luisfelipec95, Could we rebase with master dropping the additional commits?

docs/how_to/users_api.rst

BryanttV · 2024-10-22T17:22:30Z

docs/how_to/users_api.rst

+ "org_name": "required"
+ }
+
+### Note on Hidden Fields


The text with # is not rendered correctly.

docs/how_to/users_api.rst

Co-authored-by: Bryann Valderrama <[email protected]>

BryanttV · 2024-10-22T18:49:33Z

docs/how_to/users_api.rst

+ http://tenant-a.local.edly.io:8000/eox-core/api/v1/user/?username=johndoe
+
+ http://tenant-a.local.edly.io:8000/eox-core/api/v1/user/[email protected]
+


Suggested change

http://tenant-a.local.edly.io:8000/eox-core/api/v1/user/?username=johndoe

http://tenant-a.local.edly.io:8000/eox-core/api/v1/user/[email protected]

POST http://tenant-a.local.edly.io:8000/eox-core/api/v1/user/?username=johndoe

POST http://tenant-a.local.edly.io:8000/eox-core/api/v1/user/[email protected]

BryanttV · 2024-10-22T19:01:29Z

docs/how_to/users_api.rst

+**Note on Hidden Fields**
+
+Fields that are set as `hidden` in the configuration will not be visible in the registration form or user profile, and they **cannot be updated through the API**.
+
+If you attempt to update a field that is marked as `hidden` using the API, the update will be ignored, and no changes will be applied to that field.


Could we update the rest of the words with `` to use `` ``.

Suggested change

**Note on Hidden Fields**

Fields that are set as `hidden` in the configuration will not be visible in the registration form or user profile, and they **cannot be updated through the API**.

If you attempt to update a field that is marked as `hidden` using the API, the update will be ignored, and no changes will be applied to that field.

**Note on Hidden Fields**

Fields that are set as ``hidden`` in the configuration will not be visible in the registration form or user profile, and they **cannot be updated through the API**.

If you attempt to update a field that is marked as ``hidden`` using the API, the update will be ignored, and no changes will be applied to that field.

docs: add users api docs

c3f3995

luisfelipec95 requested a review from a team as a code owner October 10, 2024 22:50

luisfelipec95 marked this pull request as draft October 10, 2024 22:50

github-actions bot added the size/s label Oct 10, 2024

luisfelipec95 added 2 commits October 11, 2024 17:24

docs: add custom registration fields doc

a1d6c3b

docs: add user create, update and get

f614f60

github-actions bot added size/m and removed size/s labels Oct 11, 2024

luisfelipec95 marked this pull request as ready for review October 11, 2024 22:59

BryanttV requested changes Oct 15, 2024

View reviewed changes

magajh requested changes Oct 17, 2024

View reviewed changes

github-actions bot added size/xl and removed size/m labels Oct 22, 2024

luisfelipec95 requested review from magajh and BryanttV October 22, 2024 16:46

BryanttV reviewed Oct 22, 2024

View reviewed changes

docs/how_to/users_api.rst Show resolved Hide resolved

docs/how_to/users_api.rst Show resolved Hide resolved

docs/how_to/users_api.rst Show resolved Hide resolved

luisfelipec95 and others added 9 commits October 22, 2024 13:20

docs: add improvements

217eb8f

docs: add improvements

39cdd43

Co-authored-by: Bryann Valderrama <[email protected]>

docs: add improvements

7b7a0e5

Co-authored-by: Bryann Valderrama <[email protected]>

docs: add improvements

8634c2c

Co-authored-by: Bryann Valderrama <[email protected]>

docs: add improvements

67d710e

Co-authored-by: Bryann Valderrama <[email protected]>

docs: add improvements

fa7aee7

Co-authored-by: Bryann Valderrama <[email protected]>

docs: add improvements

8b235a1

Co-authored-by: Bryann Valderrama <[email protected]>

docs: add improvements

25d14a3

Co-authored-by: Bryann Valderrama <[email protected]>

docs: add improvements

5aa677a

Co-authored-by: Bryann Valderrama <[email protected]>

luisfelipec95 force-pushed the lfc/update-doc-api-users branch from 55f6a0b to 5aa677a Compare October 22, 2024 18:21

github-actions bot removed the size/xl label Oct 22, 2024

github-actions bot added the size/m label Oct 22, 2024

docs: add users api docs

be7604f

luisfelipec95 requested a review from BryanttV October 22, 2024 18:51

BryanttV reviewed Oct 22, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add users api docs #290

docs: add users api docs #290

luisfelipec95 commented Oct 10, 2024 •

edited

Loading

BryanttV left a comment

BryanttV Oct 15, 2024

magajh commented Oct 17, 2024

magajh left a comment

magajh Oct 17, 2024

magajh Oct 17, 2024

magajh Oct 17, 2024

magajh Oct 17, 2024

magajh Oct 17, 2024

magajh Oct 17, 2024

magajh Oct 17, 2024

magajh Oct 17, 2024

BryanttV commented Oct 22, 2024

BryanttV Oct 22, 2024

BryanttV Oct 22, 2024

BryanttV Oct 22, 2024


		"extended_profile_fields": [ "org_name" ]

		2. Add org_name to REGISTRATION_EXTRA_FIELDS, indicating whether the field is hidden, optional, or required:


		If, for example, we want to add the field `Organization name`, we will have to do the following:

		1. Add the field name, `org_name` for example, to `extended_profile_fields`. This indicates that `org_name` will be saved as an extended profile field.

	2. Add org_name to REGISTRATION_EXTRA_FIELDS, indicating whether the field is hidden, optional, or required:
	2. Add org_name to `REGISTRATION_EXTRA_FIELDS` setting, ...

	3. In this step, we will create the custom field as a dictionary. In this case, we are going to create a text field for org_name. We must indicate: name, type, and label as the minimum:
	3. Define the custom field by creating it as a dictionary inside the `EDNX_CUSTOM_REGISTRATION_FIELDS` setting. In this case, we are creating a text field for `org_name`. You must specify at least the `name`, `type`, and `label`:


		Tenant settings

		Add the following settings to the microsite where we want to add the fields:

	Add the following settings to the microsite where we want to add the fields:
	To add custom or extra registration fields for a specific tenant, you'll need to configure the following settings:

		http://tenant-a.local.edly.io:8000/eox-core/api/v1/user/?username=johndoe

		http://tenant-a.local.edly.io:8000/eox-core/api/v1/user/[email protected]


		URL: ``/eox-core/api/v1/update-user/``

		Method: PATCH

docs: add users api docs #290

Are you sure you want to change the base?

docs: add users api docs #290

Conversation

luisfelipec95 commented Oct 10, 2024 • edited Loading

Description

Additional information

BryanttV left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

magajh commented Oct 17, 2024

magajh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BryanttV commented Oct 22, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

luisfelipec95 commented Oct 10, 2024 •

edited

Loading