Skip to content

Commit

Permalink
updating API Documentation release (version 95_CF221)
Browse files Browse the repository at this point in the history
  • Loading branch information
quin-build-test committed Jul 30, 2024
1 parent 2d14f51 commit 6e7a416
Show file tree
Hide file tree
Showing 13 changed files with 1,969 additions and 33 deletions.
5 changes: 3 additions & 2 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 <a href="https://www.contributor-covenant.org/version/2/0/code_of_conduct.html">https://www.contributor-covenant.org/version/2/0/code_of_conduct.html</a>.
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>.

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 <a href="https://www.contributor-covenant.org/faq">https://www.contributor-covenant.org/faq</a>.
For answers to common questions about this code of conduct, see the FAQ at <https://www.contributor-covenant.org/faq>.
37 changes: 19 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
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 |
2 changes: 1 addition & 1 deletion dam-api/README.md
Original file line number Diff line number Diff line change
@@ -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
[**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
2 changes: 1 addition & 1 deletion image-processor-api/README.md
Original file line number Diff line number Diff line change
@@ -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
[**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
4 changes: 2 additions & 2 deletions pzn-api/README.md
Original file line number Diff line number Diff line change
@@ -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.
[**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.
4 changes: 2 additions & 2 deletions remotemodel-api/README.md
Original file line number Diff line number Diff line change
@@ -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.
[**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.
2 changes: 1 addition & 1 deletion ring-api/README.md
Original file line number Diff line number Diff line change
@@ -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.
[**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.
4 changes: 2 additions & 2 deletions search-api/README.md
Original file line number Diff line number Diff line change
@@ -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.
[**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.
3 changes: 3 additions & 0 deletions search-v2-api/README.md
Original file line number Diff line number Diff line change
@@ -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.
62 changes: 62 additions & 0 deletions search-v2-api/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
<!DOCTYPE html>
<html>

<head>
<title>Search v2</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<style>
body {
margin: 0;
padding: 0;
}
</style
</head>

<body>
<div id="redoc-container"> </div>
<script src="../lib/redoc.standalone.js"> </script>
<script>
var configOptions = {
hideLoading: true,
theme: {
colors:{
primary: {
main: "#6A2E99"
},
text: {
primary: "#000000"
},
success: {
main: '#04633D'
},
warning: {
main: '#AE3D04'
},
error: {
main: '#C10C0D'
},
},
typography: {
fontFamily: 'Helvetica Neue, Arial, sans-serif',
headings: {
fontFamily: 'Helvetica Neue, Arial, sans-serif'
},
code: {
fontFamily: 'Helvetica Neue, Arial, sans-serif'
}
},
sidebar: {
backgroundColor: "#F2F4F5",
textColor: "#3D5466"
},
logo: {
gutter: "12.5px"
}
}
};
Redoc.init("./openapi.json", configOptions, document.getElementById('redoc-container'))
</script>
</body>

</html>
Loading

0 comments on commit 6e7a416

Please sign in to comment.