From 6e7a4160bd0b0fd4a5af4941b575df182d5ab2d3 Mon Sep 17 00:00:00 2001 From: quin-build-test Date: Tue, 30 Jul 2024 12:07:30 +0000 Subject: [PATCH] updating API Documentation release (version 95_CF221) --- CODE_OF_CONDUCT.md | 5 +- README.md | 37 +- dam-api/README.md | 2 +- image-processor-api/README.md | 2 +- pzn-api/README.md | 4 +- remotemodel-api/README.md | 4 +- ring-api/README.md | 2 +- search-api/README.md | 4 +- search-v2-api/README.md | 3 + search-v2-api/index.html | 62 ++ search-v2-api/openapi.json | 1869 +++++++++++++++++++++++++++++++++ users-api/README.md | 4 +- wcm-api/README.md | 4 +- 13 files changed, 1969 insertions(+), 33 deletions(-) create mode 100644 search-v2-api/README.md create mode 100644 search-v2-api/index.html create mode 100644 search-v2-api/openapi.json diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 1ac4d42..c1dca02 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -13,6 +13,7 @@ We pledge to act and interact in ways that contribute to an open, welcoming, div Examples of behavior that contributes to a positive environment for our community include: -> Demonstrating empathy and kindness toward other people + - Being respectful of differing opinions, viewpoints, and experiences - Giving and gracefully accepting constructive feedback - Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience @@ -44,8 +45,8 @@ Project maintainers who do not follow or enforce the Code of Conduct in good fai ## Attribution -This Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. +This Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at . Community Impact Guidelines were inspired by Mozilla’s code of conduct enforcement ladder. -For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. \ No newline at end of file +For answers to common questions about this code of conduct, see the FAQ at . diff --git a/README.md b/README.md index f262e6f..9a9130d 100644 --- a/README.md +++ b/README.md @@ -8,32 +8,33 @@ HCL Experience API | Name | Description | Live API Explorer URL | |------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------| -| [**_HCL Ring API _**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/ring-api) | Presents developer entry points to HCL DX 9.5 core platform capabilities which are divided into two main categories: Authorization APIs and Web Content APIs. | /dx/api/core/v1/explorer | -| [**_HCL Digital Asset Management API _**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/dam-api) | Presents developer entry points to the Digital Asset Management features of HCL DX 9.5. | /dx/api/dam/v1/explorer | +| [**_HCL Ring API_**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/ring-api) | Presents developer entry points to HCL DX 9.5 core platform capabilities which are divided into two main categories: Authorization APIs and Web Content APIs. | /dx/api/core/v1/explorer | +| [**_HCL Digital Asset Management API_**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/dam-api) | Presents developer entry points to the Digital Asset Management features of HCL DX 9.5. | /dx/api/dam/v1/explorer | | [**_HCL Image Processor API_**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/image-processor-api) | Presents developer entry points to the Digital Asset Management Image Processor functions of HCL DX 9.5. | /dx/api/image-processor/v1/explorer | | [**_HCL Personalization API_**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/pzn-api) | Presents developer entry points to the Personalization Rule functions of HCL DX 9.5. | /dx/api/pzn/v1/explorer | | [**_HCL WCM API_**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/wcm-api) | Presents redesigned developer entry points to the Web Content Manager functions of HCL DX 9.5. Intended to facilitate the management of Web content, content-sites, and content-pages. | /dx/api/wcm/v2/explorer | | [**_HCL Access Control API_**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/access-api) | Presents developer entry points to the Access Control Management functions of HCL DX 9.5. | /dx/api/access/v1/explorer | | [**_HCL Remote Model API_**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/remotemodel-api) | Presents developer entry points to the various models for pages, layouts, and more functions of HCL DX 9.5. | /dx/api/remotemodel/v1/explorer | -| [**_HCL Search API_**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/search-api) | Presents redesigned developer entry points to the search (like text or keyword searches) functions of HCL DX 9.5. | /dx/api/search/v1/explorer | +| [**_HCL Search API v1_**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/search-api) | Presents redesigned developer entry points to the search (like text or keyword searches) functions of HCL DX 9.5. | /dx/api/search/v1/explorer | +| [**_HCL Search API v2_**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/search-v2-api) | Presents new search capabilities powered by OpenSearch of HCL DX 9.5. | /dx/api/search/v2/explorer | | [**_HCL Users and Groups API_**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/users-api) | Presents developer entry points to the user and group management functions of HCL DX 9.5. | /dx/api/users/v1/explorer | > **Note :** Future HCL DX 9.5 feature functionality will also be exposed through the HCL Experience API. It is recommended that developers building solutions for HCL Digital Experience 9.5 running on Kubernetes programmatically use the HCL Experience API for the scenarios that are covered. -The HCL Experience API is a component of the HCL Digital Experience offerings. HCL Digital Experience offering license and download packages are provided with HCL Digital Experience entitlements available to customers on the HCL Software License Portal. https://www.hcltech.com/software/support/release - -## Reference urls - -Documentation | URL Specification ---------------|------------------ -HCL Ring API | https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/ring-api -HCL Digital Asset Management API | https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/dam-api -HCL Image Processor API | https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/image-processor-api -HCL Personalization API | https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/pzn-api -HCL WCM API | https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/wcm-api -HCL Access Control API | https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/access-api -HCL Remote Model API | https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/remotemodel-api -HCL Search API | https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/search-api -HCL Users and Groups API | https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/users-api \ No newline at end of file +The HCL Experience API is a component of the HCL Digital Experience offerings. HCL Digital Experience offering license and download packages are provided with HCL Digital Experience entitlements available to customers on the HCL Software License Portal. + +## Reference urls + +| Documentation | URL Specification | +| --------------|------------------ | +| HCL Ring API | https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/ring-api | +| HCL Digital Asset Management API | https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/dam-api | +| HCL Image Processor API | https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/image-processor-api | +| HCL Personalization API | https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/pzn-api | +| HCL WCM API | https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/wcm-api | +| HCL Access Control API | https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/access-api | +| HCL Remote Model API | https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/remotemodel-api | +| HCL Search API | https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/search-api | +| HCL Users and Groups API | https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/users-api | diff --git a/dam-api/README.md b/dam-api/README.md index 2c912ba..dafa3ba 100644 --- a/dam-api/README.md +++ b/dam-api/README.md @@ -1,3 +1,3 @@ # DAM API Documentation -[**HCL Digital Asset Management API :**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/dam-api) Presents developer entry points to the Digital Asset Management features of HCL DX 9.5 \ No newline at end of file +[**HCL Digital Asset Management API :**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/dam-api) Presents developer entry points to the Digital Asset Management features of HCL DX 9.5 diff --git a/image-processor-api/README.md b/image-processor-api/README.md index bacc2c6..d58357b 100644 --- a/image-processor-api/README.md +++ b/image-processor-api/README.md @@ -1,3 +1,3 @@ # Image-Processor API Documentation -[**HCL Image Processor API :**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/image-processor-api) Presents developer entry points to the Digital Asset Management Image Processor functions of HCL DX 9.5 \ No newline at end of file +[**HCL Image Processor API :**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/image-processor-api) Presents developer entry points to the Digital Asset Management Image Processor functions of HCL DX 9.5 diff --git a/pzn-api/README.md b/pzn-api/README.md index 3ac8eed..911c40f 100644 --- a/pzn-api/README.md +++ b/pzn-api/README.md @@ -1,3 +1,3 @@ -# Ring API Documentation +# Personalization API Documentation -[ **HCL Personalization API :** ](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/pzn-api) Presents developer entry points to HCL DX 9.5 Personalization Rule functionality. Not all rule types are supported yet and are being added as we go. \ No newline at end of file +[**HCL Personalization API :**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/pzn-api) Presents developer entry points to HCL DX 9.5 Personalization Rule functionality. Not all rule types are supported yet and are being added as we go. diff --git a/remotemodel-api/README.md b/remotemodel-api/README.md index ad802d6..bdc2199 100644 --- a/remotemodel-api/README.md +++ b/remotemodel-api/README.md @@ -1,3 +1,3 @@ -# Ring API Documentation +# Remote Model API Documentation -[ **HCL Remote Model API :** ](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/remotemodel-api) Presents developer entry points to the various models for pages, layouts, and more functions of HCL DX 9.5. \ No newline at end of file +[**HCL Remote Model API :**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/remotemodel-api) Presents developer entry points to the various models for pages, layouts, and more functions of HCL DX 9.5. diff --git a/ring-api/README.md b/ring-api/README.md index 0bbc3ac..515f340 100644 --- a/ring-api/README.md +++ b/ring-api/README.md @@ -1,3 +1,3 @@ # Ring API Documentation -[ **HCL Ring API :** ](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/ring-api) Presents developer entry points to HCL DX 9.5 core platform capabilities which are divided into two main categories: Authorization APIs and Web Content APIs. \ No newline at end of file +[**HCL Ring API :**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/ring-api) Presents developer entry points to HCL DX 9.5 core platform capabilities which are divided into two main categories: Authorization APIs and Web Content APIs. diff --git a/search-api/README.md b/search-api/README.md index 52e1cd5..b46be1a 100644 --- a/search-api/README.md +++ b/search-api/README.md @@ -1,3 +1,3 @@ -# Ring API Documentation +# Search API Documentation -[ **HCL Search API :** ](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/search-api) Presents redesigned developer entry points to the search (like text or keyword searches) functions of HCL DX 9.5. \ No newline at end of file +[**HCL Search API v1 :**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/search-api) Presents redesigned developer entry points to the search (like text or keyword searches) functions of HCL DX 9.5. diff --git a/search-v2-api/README.md b/search-v2-api/README.md new file mode 100644 index 0000000..d62b96c --- /dev/null +++ b/search-v2-api/README.md @@ -0,0 +1,3 @@ +# Search API v2 Documentation + +[**HCL Search API v2 :**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/search-v2-api) Presents redesigned developer entry points to the search (like text or keyword searches) functions of HCL DX 9.5. diff --git a/search-v2-api/index.html b/search-v2-api/index.html new file mode 100644 index 0000000..4ee5960 --- /dev/null +++ b/search-v2-api/index.html @@ -0,0 +1,62 @@ + + + + + Search v2 + + + + + +
+ + + + + diff --git a/search-v2-api/openapi.json b/search-v2-api/openapi.json new file mode 100644 index 0000000..582b7cd --- /dev/null +++ b/search-v2-api/openapi.json @@ -0,0 +1,1869 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "Search API Server", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Presents developer entrypoints to the Search API features.
\n Endpoints with tags marked as protected are JWT secured and need an administrator to login before usage.\n Use the endpoint /admin/authenticate to get a JWT token.
\n Copy that JWT Token and use the Authorize button on the top right corner of the Swagger UI to enter the JWT token.
\n Example: Bearer JWT_TOKEN
\n The credentials are the ones you have configured for the search administrator and push administrator during deployment.", + "version": "2.0.0" + }, + "paths": { + "/contentsources": { + "get": { + "summary": "getContentSources with optional parameter(s) added to the endpoint with ?type=typelist and/or ?size=pagesize", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API lists available content-sources by passing content \"type\" (with comma separated eg. wcm,dam) and max page \"size\".", + "parameters": [ + { + "name": "type", + "required": false, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "comma separated list of contentsource types (i.e. wcm,dam,jcr)", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "size", + "required": false, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "max pagesize (i.e. 100)", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "ContentSource (protected)" + ], + "security": [ + { + "ApiKeyAuth": [] + } + ] + }, + "post": { + "summary": "postContentSources tries to create an OpenSearch document and index from the given name, type and aclLookupHost as parameter.", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API updates multiple but only existing documents in the content source index with given ID and returns an object having a succeeded and failed ids array.", + "requestBody": { + "$ref": "#/components/requestBodies/Data2" + }, + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "400": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Wrong Content Source creation parameters" + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "ContentSource (protected)" + ], + "security": [ + { + "Bearer": [] + } + ] + } + }, + "/contentsources/{contentsource_id}": { + "get": { + "summary": "getContentSourcesById which returns a single content source identified by its ID", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API returns content-sources by passing a single content source ID.", + "parameters": [ + { + "name": "contentsource_id", + "required": true, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "id of contentsource", + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" + }, + "404": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Content Source ID not found." + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "ContentSource (protected)" + ], + "security": [ + { + "ApiKeyAuth": [] + } + ] + }, + "post": { + "summary": "postContentSources tries to create an OpenSearch document and index from the given name, type and aclLookupHost as parameter.", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API updates multiple but only existing documents in the content source index with given ID and returns an object having a succeeded and failed ids array.", + "parameters": [ + { + "name": "contentsource_id", + "required": true, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "id of contentsource", + "in": "path", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/Data2" + }, + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "400": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Wrong Content Source creation parameters" + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "ContentSource (protected)" + ], + "security": [ + { + "Bearer": [] + } + ] + }, + "put": { + "summary": "putContentSources with a single ID, fully updates content source by accepting name, type and aclLookupHost as parameter", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API fully updates content source by accepting \"name\", \"type\" and \"aclLookupHost\" as parameter.", + "parameters": [ + { + "name": "contentsource_id", + "required": true, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "id of contentsource", + "in": "path", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/Data2" + }, + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" + }, + "404": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Content Source ID not found." + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "ContentSource (protected)" + ], + "security": [ + { + "Bearer": [] + } + ] + }, + "patch": { + "summary": "patchContentSources with a single ID, partially updates a content source by accepting \"name\", \"type\" and \"aclLookupHost\" as parameter", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API updates content source by accepting \"name\", \"type\" and \"aclLookupHost\" as parameter.", + "parameters": [ + { + "name": "contentsource_id", + "required": true, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "id of contentsource", + "in": "path", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string", + "example": "wcm" + }, + "aclLookupHost": { + "type": "string", + "example": "https://my-environment.arbitarydomaintest.com" + } + } + } + } + }, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "request body" + }, + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" + }, + "404": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Content Source ID not found." + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "ContentSource (protected)" + ], + "security": [ + { + "Bearer": [] + } + ] + }, + "delete": { + "summary": "deleteContentSources with a single ID deletes an OpenSearch document and index for the given \"contentsource_id\"", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API deletes content source for the given \"contentsource_id\"", + "parameters": [ + { + "name": "contentsource_id", + "required": true, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "id of contentsource", + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "400": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Unable to delete Content Source element" + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" + }, + "404": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Content Source ID not found" + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "ContentSource (protected)" + ], + "security": [ + { + "Bearer": [] + } + ] + } + }, + "/contentsourcetypes": { + "get": { + "summary": "getContentSourceTypes", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API lists all content-source types.", + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "ContentSource (protected)" + ], + "security": [ + { + "ApiKeyAuth": [] + } + ] + } + }, + "/crawlers": { + "get": { + "summary": "getCrawlers", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API retrieves all available \"contentSource\" and \"type\" along with the \"configuration\"", + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" + }, + "404": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "No crawlers found" + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "Crawlers (protected)" + ], + "security": [ + { + "Bearer": [] + } + ] + }, + "post": { + "summary": "postCrawlers", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API creates a new crawler \"configuration\" for the given \"contentSource\" and \"type\"", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "contentSource", + "type", + "configuration" + ], + "properties": { + "contentSource": { + "type": "string", + "example": "ee0765b4-be3e-4d10-9ab4-95e60464e676" + }, + "type": { + "type": "string", + "example": "wcm" + }, + "configuration": { + "type": "object", + "properties": { + "targetDataSource": { + "type": "string" + }, + "schedule": { + "type": "string" + }, + "security": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "basic" + }, + "username": { + "type": "string" + }, + "password": { + "type": "string" + } + } + }, + "maxCrawlTime": { + "type": "number" + }, + "maxRequestTime": { + "type": "number" + } + } + } + } + } + } + }, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "request body" + }, + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "400": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Wrong Crawler creation parameters" + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "Crawlers (protected)" + ], + "security": [ + { + "Bearer": [] + } + ] + } + }, + "/crawlers/{crawler_id}": { + "get": { + "summary": "getCrawlers with a single ID", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API retrieves \"contentSource\" and \"type\" along with the \"configuration\" for the given \"crawler_id\"", + "parameters": [ + { + "name": "crawler_id", + "required": true, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "id of crawler", + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" + }, + "404": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Crawler ID not found." + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "Crawlers (protected)" + ], + "security": [ + { + "Bearer": [] + } + ] + }, + "put": { + "summary": "putCrawlers with a single ID", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API fully updates \"contentSource\", \"type\" and \"configuration\" for a given crawler by accepting \"crawler_id\"", + "parameters": [ + { + "name": "crawler_id", + "required": true, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "id of crawler", + "in": "path", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "contentSource": { + "type": "string", + "example": "ee0765b4-be3e-4d10-9ab4-95e60464e676" + }, + "type": { + "type": "string", + "example": "wcm" + }, + "configuration": { + "type": "object", + "properties": { + "targetDataSource": { + "type": "string" + }, + "schedule": { + "type": "* 2 * * *" + }, + "security": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "basic" + }, + "username": { + "type": "string" + }, + "password": { + "type": "string" + } + } + }, + "maxCrawlTime": { + "type": "number" + }, + "maxRequestTime": { + "type": "number" + } + } + } + } + } + } + }, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "request body" + }, + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" + }, + "404": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Crawler ID not found." + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "Crawlers (protected)" + ], + "security": [ + { + "Bearer": [] + } + ] + }, + "patch": { + "summary": "patchCrawlers with a single ID", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API partially updates \"contentSource\", \"type\" and \"configuration\" for a given crawler by accepting \"crawler_id\"", + "parameters": [ + { + "name": "crawler_id", + "required": true, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "id of crawler", + "in": "path", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "contentSource": { + "type": "string", + "example": "ee0765b4-be3e-4d10-9ab4-95e60464e676" + }, + "type": { + "type": "string", + "example": "wcm" + }, + "configuration": { + "type": "object", + "properties": { + "targetDataSource": { + "type": "string" + }, + "schedule": { + "type": "string" + }, + "security": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "basic" + }, + "username": { + "type": "string" + }, + "password": { + "type": "string" + } + } + }, + "maxCrawlTime": { + "type": "number" + }, + "maxRequestTime": { + "type": "number" + } + } + } + } + } + } + }, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "request body" + }, + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" + }, + "404": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Crawler ID not found." + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "Crawlers (protected)" + ], + "security": [ + { + "Bearer": [] + } + ] + }, + "delete": { + "summary": "deleteCrawlers with a single ID", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API deletes a crawler by accepting \"crawler_id\"", + "parameters": [ + { + "name": "crawler_id", + "required": true, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "id of crawler", + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" + }, + "404": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Crawler ID not found." + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "Crawlers (protected)" + ], + "security": [ + { + "Bearer": [] + } + ] + } + }, + "/crawlers/{crawler_id}/test": { + "post": { + "summary": "testCrawlerConnection", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API verifies credentials for crawler configuration with \"crawler_id\"", + "parameters": [ + { + "name": "crawler_id", + "required": true, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "id of crawler", + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" + }, + "404": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Crawler ID not found." + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "Crawlers (protected)" + ], + "security": [ + { + "Bearer": [] + } + ] + } + }, + "/crawlers/{crawler_id}/trigger": { + "post": { + "summary": "postcrawlersTrigger", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API triggers crawler with \"crawler_id\"", + "parameters": [ + { + "name": "crawler_id", + "required": true, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "id of crawler", + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" + }, + "404": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Crawler ID not found." + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "Crawlers (protected)" + ], + "security": [ + { + "Bearer": [] + } + ] + } + }, + "/contentsources/{contentsource_id}/crawlers": { + "get": { + "summary": "getContentsourcesCrawlers", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API retrieves a single crawler with \"contentSource\" and \"type\" along with the \"configuration\" for the given \"contentsource_id\"", + "parameters": [ + { + "name": "contentsource_id", + "required": true, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "id of contentsource", + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" + }, + "404": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Content source id not found or no crawlers found" + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "Crawlers (protected)" + ], + "security": [ + { + "Bearer": [] + } + ] + } + }, + "/contentsources/{contentsource_id}/documents": { + "get": { + "summary": "Get document ids from index given as contentsource_id (getContentsourcesDocuments)", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API lists document ids and their title from content source index with given ID.", + "parameters": [ + { + "name": "contentsource_id", + "required": true, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "id of contentsource", + "in": "path", + "schema": { + "type": "string" + } + }, + { + "name": "page", + "required": false, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "page number", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "size", + "required": false, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "max pagesize (i.e. 100)", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" + }, + "404": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Content Source ID not found" + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "ContentPush (protected)" + ], + "security": [ + { + "Bearer": [] + } + ] + }, + "put": { + "summary": "Update/Add multiple documents in the index given as contentsource_id (updateContentsourceDocuments)", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API updates/adds multiple documents in the content source index with given ID and returns an object having a succeeded and failed ids array.", + "parameters": [ + { + "name": "contentsource_id", + "required": true, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "id of contentsource", + "in": "path", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "documents" + ], + "properties": { + "documents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "fe657e1b-214f-4816-b2af-77fca67fb171" + }, + "created": { + "type": "number", + "example": 1697468618000, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Date of creation in original source" + }, + "updated": { + "type": "number", + "example": 1697468974000, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Date of last update in original source" + }, + "acls": { + "type": "array", + "example": [ + "acl-1", + "acl-2" + ], + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "List of access control", + "items": {} + }, + "documentObject": { + "type": "object", + "example": {} + } + } + } + } + } + } + } + }, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "request body" + }, + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "400": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Request failed because none of provided documents were updated/added." + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" + }, + "404": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Document ids missing or content source ID not found." + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "ContentPush (protected)" + ], + "security": [ + { + "Bearer": [] + } + ] + }, + "patch": { + "summary": "Update multiple existing documents in the index given as contentsource_id (updateContentsourceDocuments)", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API updates multiple but only existing documents in the content source index with given ID and returns an object having a succeeded and failed ids array.", + "parameters": [ + { + "name": "contentsource_id", + "required": true, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "id of contentsource", + "in": "path", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/Data" + }, + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "400": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Request failed because none of provided documents were updated/added." + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" + }, + "404": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Document ids missing or or content source ID not found." + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "ContentPush (protected)" + ], + "security": [ + { + "Bearer": [] + } + ] + }, + "post": { + "summary": "Update/Add multiple documents to the index given as contentsource_id (postContentsourcesDocuments)", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API updates/adds multiple documents to the content source index with given ID and returns an object having a succeeded and failed ids array.", + "parameters": [ + { + "name": "contentsource_id", + "required": true, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "id of contentsource", + "in": "path", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/Data" + }, + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" + }, + "403": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "New document not created in index." + }, + "404": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Content Source ID not found." + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "ContentPush (protected)" + ], + "security": [ + { + "Bearer": [] + } + ] + }, + "delete": { + "summary": "Delete multiple documents passed in as array from index given as contentsource_id (deleteContentsourcesDocumentsBulk)", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API deletes multiple documents in the content source index with given ID and returns an object having a succeeded and failed ids array.", + "parameters": [ + { + "name": "contentsource_id", + "required": true, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "id of contentsource", + "in": "path", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/Data3" + }, + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "204": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "All documents deleted." + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" + }, + "404": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Content source id not found or none of the documents deleted." + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "ContentPush (protected)" + ], + "security": [ + { + "Bearer": [] + } + ] + } + }, + "/contentsources/{contentsource_id}/documents/get": { + "post": { + "summary": "Get multiple documents from index given as contentsource_id (postContentsourcesDocumentsGet)", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API returns all documents from the given ID which matches the document ids passed as array in the body. Ids not found in the index are ignored and not part the response.", + "parameters": [ + { + "name": "contentsource_id", + "required": true, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "id of contentsource", + "in": "path", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/Data3" + }, + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "400": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Wrong request body (e.g. no ids identifier or empty id list)" + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" + }, + "404": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Content source id not found." + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "ContentPush (protected)" + ], + "security": [ + { + "Bearer": [] + } + ] + } + }, + "/contentsources/{contentsource_id}/documents/byquery": { + "delete": { + "summary": "Delete multiple documents defined by query from index given as contentsource_id (deleteContentsourcesDocumentsByQuery)", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API deletes multiple documents in the content source index with given ID if the query returned matching documents.", + "parameters": [ + { + "name": "contentsource_id", + "required": true, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "id of contentsource", + "in": "path", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "query" + ], + "properties": { + "query": { + "type": "object", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Query object as defined by Opensearch" + } + } + } + } + }, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "request body" + }, + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "204": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "All queried documents deleted." + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" + }, + "404": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Content source id not found or no documents deleted if query did not find any document." + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "ContentPush (protected)" + ], + "security": [ + { + "Bearer": [] + } + ] + } + }, + "/contentsources/{contentsource_id}/documents/{document_id}": { + "get": { + "summary": "Get single document from index given as contentsource_id (getContentsourcesDocumentsById)", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API gets a single document from the content source index with given ID and the passed in document id.", + "parameters": [ + { + "name": "contentsource_id", + "required": true, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "id of contentsource", + "in": "path", + "schema": { + "type": "string" + } + }, + { + "name": "document_id", + "required": true, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "id of document", + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "400": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Invalid request parameter." + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" + }, + "404": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Content source id or document not found." + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "ContentPush (protected)" + ], + "security": [ + { + "Bearer": [] + } + ] + }, + "post": { + "summary": "Add a single document to index given as contentsource_id (postContentsourcesDocumentsById)", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API adds a single not existing document to the content source index with given ID and returns the created document object.", + "parameters": [ + { + "name": "contentsource_id", + "required": true, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "id of contentsource", + "in": "path", + "schema": { + "type": "string" + } + }, + { + "name": "document_id", + "required": true, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "id of document", + "in": "path", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "created", + "updated" + ], + "properties": { + "created": { + "type": "number", + "example": 1697468618000, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Date of creation in original source" + }, + "updated": { + "type": "number", + "example": 1697468974000, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Date of last update in original source" + }, + "acls": { + "type": "array", + "example": [ + "acl-1", + "acl-2" + ], + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "List of access control", + "items": {} + }, + "documentObject": { + "type": "object", + "example": {}, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Additional document relevant properties" + } + } + } + } + }, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "request body" + }, + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "400": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Invalid request parameter." + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" + }, + "403": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Document creation error." + }, + "404": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Content source id not found." + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "ContentPush (protected)" + ], + "security": [ + { + "Bearer": [] + } + ] + }, + "put": { + "summary": "Update/Add a single document to index given as contentsource_id (updateContentsourceDocuments)", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API updates/adds a single document to the content source index with given ID and returns the updated/created document object.", + "parameters": [ + { + "name": "contentsource_id", + "required": true, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "id of contentsource", + "in": "path", + "schema": { + "type": "string" + } + }, + { + "name": "document_id", + "required": true, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "id of document", + "in": "path", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "created", + "updated", + "documentObject" + ], + "properties": { + "created": { + "type": "number", + "example": 1697468618000, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Date of creation in original source" + }, + "updated": { + "type": "number", + "example": 1697468974000, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Date of last update in original source" + }, + "acls": { + "type": "array", + "example": [ + "acl-1", + "acl-2" + ], + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "List of access control", + "items": {} + }, + "documentObject": { + "type": "object", + "example": {} + } + } + } + } + }, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "request body" + }, + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "400": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Request failed because the of provided document was not updated/added." + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" + }, + "404": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Content source id not found or document id missing." + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "ContentPush (protected)" + ], + "security": [ + { + "Bearer": [] + } + ] + }, + "patch": { + "summary": "Update a single existing document to index given as contentsource_id (updateContentsourceDocuments)", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API updates a single already existing document in the content source index with given ID and returns the updated document object.", + "parameters": [ + { + "name": "contentsource_id", + "required": true, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "id of contentsource", + "in": "path", + "schema": { + "type": "string" + } + }, + { + "name": "document_id", + "required": true, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "id of document", + "in": "path", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "created": { + "type": "number", + "example": 0, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Date of creation in original source" + }, + "updated": { + "type": "number", + "example": 0, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Date of last update in original source" + }, + "acls": { + "type": "array", + "example": [ + "acl-1", + "acl-2" + ], + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "List of access control", + "items": {} + }, + "documentObject": { + "type": "object", + "example": {} + } + } + } + } + }, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "request body" + }, + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "400": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Request failed because the of provided document was not updated/added." + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" + }, + "404": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Content source id not found or document id missing." + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "ContentPush (protected)" + ], + "security": [ + { + "Bearer": [] + } + ] + }, + "delete": { + "summary": "Delete a single document passed as document_id from index given as contentsource_id (deleteContentsourcesDocumentsById)", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API deletes a single document from the content source index with given ID.", + "parameters": [ + { + "name": "contentsource_id", + "required": true, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "id of contentsource", + "in": "path", + "schema": { + "type": "string" + } + }, + { + "name": "document_id", + "required": true, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "id of document", + "in": "path", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "204": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Single document successful deleted." + }, + "400": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Invalid request parameter." + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Authentication Error" + }, + "404": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Content source id or document id not found." + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "ContentPush (protected)" + ], + "security": [ + { + "Bearer": [] + } + ] + } + }, + "/search": { + "post": { + "summary": "postSearch", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API returns documents and aggregations. \n The query object is formed with a \"must\", \"should\" and/or \"must_not\" array of objects and\n an optional minimum_should_match property.\n It follows the standard OpenSearch Query structure.\n The aggregations object follows the same OpenSearch Aggregation structure.\n The page (default: 0) and pageSize (default: 100) parameters are optional.\n The scope parameter is an array of Content Source UUIDs to filter the search results.\n If the scope parameter is not provided, the search will be performed on all available Content Sources", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "query" + ], + "properties": { + "query": { + "type": "object", + "properties": { + "must": { + "type": "array", + "example": [ + { + "match": { + "documentObject.author.name": "wpsadmin" + } + } + ], + "items": {} + } + }, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Query object formed with a \"must\" and/or \"should\" array of objects and an optional minimum_should_match property but can be empty to get all items." + }, + "page": { + "type": "integer", + "minimum": 0 + }, + "pageSize": { + "type": "integer", + "minimum": 1, + "example": 10 + }, + "aggregations": { + "type": "object", + "example": { + "author": { + "terms": { + "field": "documentObject.author.name.keyword" + } + } + } + } + } + } + } + }, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "request body" + }, + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "400": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Missing or malformed search request" + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "ContentQuery" + ], + "security": [ + { + "ApiKeyAuth": [] + } + ] + } + }, + "/mysearch": { + "post": { + "summary": "postMySearch", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This API returns documents and aggregations. \n The query object is formed with a \"must\", \"should\" and/or \"must_not\" array of objects and\n an optional minimum_should_match property.\n It follows the standard OpenSearch Query structure.\n The aggregations object follows the same OpenSearch Aggregation structure.\n The page (default: 0) and pageSize (default: 100) parameters are optional.\n The scope parameter is an array of Content Source UUIDs to narrow down the search results.\n If the scope parameter is not provided, the search will be performed on all available Content Sources", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "query" + ], + "properties": { + "query": { + "type": "object", + "properties": { + "must": { + "type": "array", + "example": [ + { + "match": { + "documentObject.author.name": "wpsadmin" + } + } + ], + "items": {} + } + }, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Query object formed with a \"must\" and/or \"should\" array of objects and an optional minimum_should_match property but can be empty to get all items." + }, + "page": { + "type": "integer", + "minimum": 0 + }, + "pageSize": { + "type": "integer", + "minimum": 1, + "example": 10 + } + } + } + } + }, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "request body" + }, + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "400": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Missing or malformed search request" + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "ContentQuery" + ], + "security": [ + { + "ApiKeyAuth": [] + } + ] + } + }, + "/admin/authenticate": { + "post": { + "summary": "postGetToken generates JWT token by accepting \"username\" and \"password\" as parameter", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "This serves as authorisation login for administrators to use protected APIs in subsequent calls.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "username", + "password" + ], + "properties": { + "username": { + "type": "string", + "example": "searchadmin" + }, + "password": { + "type": "string", + "example": "" + } + } + } + } + }, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "request body" + }, + "responses": { + "200": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Success" + }, + "401": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Wrong login credentials" + }, + "500": { + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Server Error" + } + }, + "tags": [ + "Authentication" + ], + "security": [ + { + "ApiKeyAuth": [] + } + ] + } + } + }, + "tags": [], + "servers": [ + { + "url": "/dx/api/search/v2" + } + ], + "components": { + "requestBodies": { + "Data": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "documents" + ], + "properties": { + "documents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "fe657e1b-214f-4816-b2af-77fca67fb171" + }, + "created": { + "type": "number", + "example": 0, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Date of creation in original source" + }, + "updated": { + "type": "number", + "example": 0, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Date of last update in original source" + }, + "acls": { + "type": "array", + "example": [ + "acl-1", + "acl-2" + ], + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "List of access control", + "items": {} + }, + "documentObject": { + "type": "object", + "example": {} + } + } + } + } + } + } + } + }, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "request body" + }, + "Data2": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "name", + "type", + "aclLookupHost" + ], + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string", + "example": "wcm" + }, + "aclLookupHost": { + "type": "string", + "example": "https://my-environment.arbitarydomaintest.com" + } + } + } + } + }, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "request body" + }, + "Data3": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "ids" + ], + "properties": { + "ids": { + "type": "string[]", + "example": [ + "abc", + "def" + ] + } + } + } + } + }, + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "request body" + } + }, + "securitySchemes": { + "Bearer": { + "type": "apiKey", + "in": "header", + "name": "Authorization", + "x-logo":{"url":"../DX_logo.svg","backgroundColor":"#F2F4F5","altText":"HCL_Digital_Experience"},"description": "Bearer JWT" + } + } + } +} \ No newline at end of file diff --git a/users-api/README.md b/users-api/README.md index 59e1828..47c0c60 100644 --- a/users-api/README.md +++ b/users-api/README.md @@ -1,3 +1,3 @@ -# Ring API Documentation +# HCL Users and Groups API Documentation -[ **HCL Users and Groups API :** ](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/users-api) Presents developer entry points to the user and group management functions of HCL DX 9.5. \ No newline at end of file +[**HCL Users and Groups API :**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/users-api) Presents developer entry points to the user and group management functions of HCL DX 9.5. diff --git a/wcm-api/README.md b/wcm-api/README.md index c81945f..67cc217 100644 --- a/wcm-api/README.md +++ b/wcm-api/README.md @@ -1,3 +1,3 @@ -# Ring API Documentation +# WCM API Documentation -[ **HCL WCM API :** ](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/wcm-api) Presents redesigned developer entry points to HCL DX 9.5 Web Content Manager. \ No newline at end of file +[**HCL WCM API :**](https://HCL-TECH-SOFTWARE.github.io/experience-api-documentation/wcm-api) Presents redesigned developer entry points to HCL DX 9.5 Web Content Manager.