Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update opensearch doc #508

Merged
merged 1 commit into from
Aug 3, 2023
Merged

Update opensearch doc #508

merged 1 commit into from
Aug 3, 2023

Conversation

ribaraka
Copy link
Contributor

Updated OpenSearch documentation to API v2

@ribaraka ribaraka added the documentation Improvements or additions to documentation label Jul 31, 2023
@ribaraka ribaraka self-assigned this Jul 31, 2023
| reportingPlugin | bool | Enables reporting plugin. |
| loadBalancer | bool | Enables Load Balancer. |
| dataNodes | Array of objects ([DataNodes](#DataNodes)) | List of data node settings |
| dashboards | Array of objects ([Dashboards](#Dashboards)) | List of dashboards settings |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dashboard node settings

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

| Field | Type | Description |
|---------------------|---------------------------------------------|-------------------|
| nodeSize | String <br /> **required**<br />_mutable_ | Size of data node |
| nodesNumber | Int32 <br /> **required** _mutable_ | Number of nodes |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add <br /> before mutable

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added + replaced <br /> by <br>

Comment on lines 7 to 8
| name | String <br> **required** | Cluster name. Should have length from 3 to 32 symbols. |
| version | String <br> **required** | OpenSearch instance version. |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

String -> string, Int -> int...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

@ribaraka ribaraka merged commit 2d050d4 into main Aug 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants