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

Add example in create API for create index pattern, vega visualizatinn, dashboards for docs #6855

Merged
merged 2 commits into from
May 29, 2024

Conversation

zhyuanqi
Copy link
Collaborator

@zhyuanqi zhyuanqi commented May 29, 2024

Description

Add example in create API for create index pattern, vega visualizatinn, dashboards for docs

Issues Resolved

#6719

Screenshot

Screenshot 2024-05-29 at 11 08 40 AM Screenshot 2024-05-29 at 11 08 46 AM Screenshot 2024-05-29 at 11 08 52 AM

Changelog

  • doc: Add example for saved object creation part for openapi doc.

@@ -10,6 +10,7 @@
- [Client_management_design](multi-datasource/client_management_design.md)
- [High_level_design](multi-datasource/high_level_design.md)
- [User_stories](multi-datasource/user_stories.md)
- [Openapi](openapi/README.md)
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This change is auto generated by the Docsify

Copy link

codecov bot commented May 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.39%. Comparing base (eb3efa8) to head (7bd1e8d).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6855      +/-   ##
==========================================
- Coverage   67.41%   67.39%   -0.02%     
==========================================
  Files        3443     3443              
  Lines       67797    67797              
  Branches    11033    11033              
==========================================
- Hits        45702    45690      -12     
- Misses      19427    19439      +12     
  Partials     2668     2668              
Flag Coverage Δ
Linux_1 ?
Linux_2 55.12% <ø> (ø)
Linux_3 45.17% <ø> (-0.02%) ⬇️
Linux_4 34.82% <ø> (ø)
Windows_1 33.09% <ø> (-0.03%) ⬇️
Windows_2 55.09% <ø> (ø)
Windows_3 45.19% <ø> (ø)
Windows_4 34.82% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@@ -172,6 +174,7 @@
- scripts
- [README](../scripts/README.md)
- [DOCS_README](DOCS_README.md)
- [Theme](theme.md)
Copy link
Contributor

Choose a reason for hiding this comment

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

is this also auto generated?

Copy link
Collaborator Author

@zhyuanqi zhyuanqi May 29, 2024

Choose a reason for hiding this comment

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

Yes. It reads through all the md file and updated the doc here.

@BionIT
Copy link
Collaborator

BionIT commented May 29, 2024

@joshuali925 could you take a look as well?

visState: '{"title":"vegaVisualization","type":"vega","aggs":[]}}'
uiStateJSON: '{}'
description: ''
version: 1,
Copy link
Member

Choose a reason for hiding this comment

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

extra comma?

…n, dashboards for docs

Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com>
BionIT
BionIT previously approved these changes May 29, 2024
@zhyuanqi zhyuanqi added docs Improvements or additions to documentation backport 2.x v2.15.0 and removed seasoned-contributor labels May 29, 2024
@zhyuanqi zhyuanqi merged commit 089a2de into opensearch-project:main May 29, 2024
66 of 67 checks passed
@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch-Dashboards/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch-Dashboards/backport-2.x
# Create a new branch
git switch --create backport/backport-6855-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 089a2dee41908d097a25f8c49ecf24f2d3d43b11
# Push it to GitHub
git push --set-upstream origin backport/backport-6855-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch-Dashboards/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-6855-to-2.x.

@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch-Dashboards/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch-Dashboards/backport-2.x
# Create a new branch
git switch --create backport/backport-6855-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 089a2dee41908d097a25f8c49ecf24f2d3d43b11
# Push it to GitHub
git push --set-upstream origin backport/backport-6855-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch-Dashboards/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-6855-to-2.x.

@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch-Dashboards/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch-Dashboards/backport-2.x
# Create a new branch
git switch --create backport/backport-6855-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 089a2dee41908d097a25f8c49ecf24f2d3d43b11
# Push it to GitHub
git push --set-upstream origin backport/backport-6855-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch-Dashboards/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-6855-to-2.x.

LDrago27 pushed a commit to LDrago27/OpenSearch-Dashboards that referenced this pull request Jun 3, 2024
…n, dashboards for docs (opensearch-project#6855)

* Add example in create API for create index pattern, vega visualization, dashboards for docs

Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com>

* Changeset file for PR opensearch-project#6855 created/updated

---------

Signed-off-by: Yuanqi(Ella) Zhu <zhyuanqi@amazon.com>
Co-authored-by: opensearch-changeset-bot[bot] <154024398+opensearch-changeset-bot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.x docs Improvements or additions to documentation v2.15.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants