Skip to content

Commit be3e30b

Browse files
Vinayak Patilmarcvincentvista
authored andcommitted
Apply suggestions from code review
Co-authored-by: Marc Vincent Vista <marcvincent.vista@hcl.com>
1 parent b4cab01 commit be3e30b

File tree

3 files changed

+24
-24
lines changed

3 files changed

+24
-24
lines changed

docs/deployment/install/container/helm_deployment/preparation/optional_tasks/optional_install_new_search.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ configuration:
203203

204204
### Common fields mapping for fallback
205205

206-
Common field mappings are the default mappings for WCM, DAM, JCR, PORTAL and PEOPLE in the `documentObject`. You can find appropriate mappings for each field in the `documentObject`. Use an empty string if none of the mappings apply. For more information about `documentObject`, see [Indexed documents](../../../../../manage/container_configuration/configure_opensearch/architectural_overview.md#indexed-documents).
206+
Common field mappings are the default mappings for WCM, DAM, JCR, PORTAL, and PEOPLE in the `documentObject` parameter. You can find appropriate mappings for each field in this parameter. Use an empty string if none of the mappings apply. For more information about the `documentObject` parameter, see [Indexed documents](../../../../../manage/container_configuration/configure_opensearch/architectural_overview.md#indexed-documents).
207207

208208
```yaml
209209
commonFieldMappings:
@@ -241,10 +241,10 @@ commonFieldMappings:
241241

242242
Refer to the following list for more information about the fields:
243243

244-
- `wcm`, `dam`, `jcr`, `portal` and `people` are the types of content source currently supported.
244+
- `wcm`, `dam`, `jcr`, `portal`, and `people` are the types of content source currently supported.
245245
- Names of common field mappings such as `title`, `description`, `type`, and `tags` cannot be changed.
246246
- Apart from `title`, `description`, `type` and `tags`, additional common fields are not allowed.
247-
- There are default values defined to map different content sources such as `wcm`, `dam`, `jcr` and `portal` to different common fields such as `title`, `description`, `type` and `tags`. You can change these default mapping values.
247+
- There are default values defined to map different content sources such as `wcm`, `dam`, `jcr`, and `portal` to different common fields such as `title`, `description`, `type` and `tags`. You can change these default mapping values.
248248

249249
### Persistent Volume size requests
250250

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
# API documentation
22

3-
In this section, you will learn about the available APIs in People Service and how to interact with them. This section serves as a reference for developers and administrators looking to leverage People Service APIs to enhance their platforms. It includes details on the available APIs such as OpenAPI, Swagger Explorer and [Experience API documentation](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/) to help users understand and work with People Service APIs effectively.
3+
In this section, you will learn about the available APIs in People Service and how to interact with them. This section serves as a reference for developers and administrators looking to leverage People Service APIs to enhance their platforms. It includes details on the available APIs such as OpenAPI, Swagger Explorer, and [Experience API documentation](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/){target="_blank"} to help users understand and work with People Service APIs effectively.
44

55
## Working with APIs
66

77
People Service APIs are designed to provide developers and administrators with the necessary tools to interact with the service and enhance their platforms. The APIs are RESTful and follow standard conventions, making them easy to work with and integrate into existing systems. The following sections provide an overview of the available APIs and how to interact with them effectively.
88

99
People Service APIs are categorized into the following sections:
1010

11-
- [Authentication](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/authentication): APIs related to user authentication and session management.
12-
- [Profiles](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/profiles): APIs related to managing user profiles, including creating, updating, and deleting profiles.
13-
- [Schema](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/schema): APIs related to managing profile attributes and schema definitions.
14-
- [Custom Fields](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/custom-fields): APIs related to managing custom fields for user profiles.
15-
- [Images and Media](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/images-and-media): APIs related to managing profile images and media content.
16-
- [Tags](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/tags): APIs related to managing tags for user profiles.
17-
- [Search](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/search): APIs related to searching for user profiles based on specific criteria.
18-
- [Privacy](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/privacy): APIs related to managing user privacy settings and data protection.
19-
- [Federation and User Directories](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/federation-and-user-directories): APIs related to integrating with external user directories and federated identity providers.
20-
- [Utils](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/utils): Utility APIs for common tasks and operations.
21-
- [Probes](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/probes): Health check APIs for monitoring the service status and availability.
22-
- [Search Re-Index](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/search-re-index): APIs related to retrying full or partial re-indexing for all or pending user profiles.
11+
- [Authentication](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/authentication){target="_blank"}: APIs related to user authentication and session management.
12+
- [Profiles](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/profiles){target="_blank"}: APIs related to managing user profiles, including creating, updating, and deleting profiles.
13+
- [Schema](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/schema){target="_blank"}: APIs related to managing profile attributes and schema definitions.
14+
- [Custom Fields](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/custom-fields){target="_blank"}: APIs related to managing custom fields for user profiles.
15+
- [Images and Media](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/images-and-media){target="_blank"}: APIs related to managing profile images and media content.
16+
- [Tags](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/tags){target="_blank"}: APIs related to managing tags for user profiles.
17+
- [Search](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/search){target="_blank"}: APIs related to searching for user profiles based on specific criteria.
18+
- [Privacy](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/privacy){target="_blank"}: APIs related to managing user privacy settings and data protection.
19+
- [Federation and User Directories](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/federation-and-user-directories){target="_blank"}: APIs related to integrating with external user directories and federated identity providers.
20+
- [Utils](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/utils){target="_blank"}: Utility APIs for common tasks and operations.
21+
- [Probes](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/probes){target="_blank"}: Health check APIs for monitoring the service status and availability.
22+
- [Search Re-Index](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/search-re-index){target="_blank"}: APIs related to retrying full or partial re-indexing for all or pending user profiles.
2323

2424
## OpenAPI and Swagger Explorer
2525

@@ -37,4 +37,4 @@ Use the following URLs to access the Swagger Explorer for People Service APIs an
3737

3838
Ensure to replace `<HOSTNAME>` with the correct value.
3939

40-
For more information on the People Service API schema, refer to the [HCL Experience API Documentation](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/).
40+
For more information on the People Service API schema, refer to the [HCL Experience API Documentation](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/){target="_blank"}.

docs/extend_dx/integration/people_service/integration/people_service_search_v2_integration.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,25 +26,25 @@ People Service automatically indexes data when changes occur. However, it does n
2626

2727
When creating and mutating users using the API or provisioning users through [User synchronization](../administration/user_provisioning/user_synchronization.md), the user data is indexed as needed as part of the creation or mutation process.
2828

29-
- [People Profile API endpoint](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/profiles)
29+
- [People Profile API endpoint](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/profiles){target="_blank"}
3030

3131
- To create new user profile and index, trigger the `POST` endpoint named `/dx/api/people/v1/people`.
3232
- To update existing user profile and indexing, trigger the `PUT` endpoint named `/dx/api/people/v1/people/{id}`.
3333
- To delete existing user profile and indexing, trigger the `DELETE` endpoint named `/dx/api/people/v1/people/{id}`.
3434

35-
- [User Synchronization API endpoint](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/federation-and-user-directories)
35+
- [User Synchronization API endpoint](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/federation-and-user-directories){target="_blank"}
3636

37-
- To start user synchronization and indexing , trigger the `POST` endpoint named `/dx/api/people/v1/user-directories/sync`
37+
- To start user synchronization and indexing, trigger the `POST` endpoint named `/dx/api/people/v1/user-directories/sync`.
3838

3939
### On-demand indexing
4040

41-
If immediate processing is required, the People Service provides an indexing API that fully resynchronizes the index with the People Service user data.
41+
If immediate processing is required, People Service provides an indexing API that fully resynchronizes the index with the People Service user data.
4242

43-
- [Search Indexing API endpoint](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/search-re-index)
43+
- [Search Indexing API endpoint](https://opensource.hcltechsw.com/experience-api-documentation/people-service-api/#tag/search-re-index){target="_blank"}
4444

4545
- To get details of all pending and failed user index operations, trigger the `GET` endpoint named `/dx/api/people/v1/search/index/pending`.
46-
- To retry pending and failed user index operations, trigger the `POST` endpoint named `/dx/api/people/v1/search/index/pending`
47-
- To start full indexing for all users available in the people database., trigger the `POST` endpoint named `/dx/api/people/v1/search/index`
46+
- To retry pending and failed user index operations, trigger the `POST` endpoint named `/dx/api/people/v1/search/index/pending`.
47+
- To start full indexing for all users available in the people database, trigger the `POST` endpoint named `/dx/api/people/v1/search/index`.
4848

4949
### Upgrading to CF226 or later
5050

0 commit comments

Comments
 (0)