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

[BUG] Update the documentation links for the specs #4350

Open
kristenTian opened this issue Aug 30, 2022 · 1 comment
Open

[BUG] Update the documentation links for the specs #4350

kristenTian opened this issue Aug 30, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@kristenTian
Copy link

kristenTian commented Aug 30, 2022

Describe the bug
In order to syncing the API Spec between OS and OSD: opensearch-project/OpenSearch-Dashboards#2219, the current SOP is to follow: https://cptnb.github.io/opensearch-dashboards-dev-docs/core-plugins/console/console/

Noticed during the process, the pulled spec file's document links are outdated, therefore need manual fix for all apis in every sync up.

Expected behavior
Update the documentation links to corresponding opensearch ones for all the specs in https://github.com/opensearch-project/OpenSearch/tree/main/rest-api-spec

Relavent OSD PR:
opensearch-project/OpenSearch-Dashboards#2226

@kristenTian kristenTian added bug Something isn't working untriaged labels Aug 30, 2022
@xuezhou25 xuezhou25 added documentation Improvements or additions to documentation and removed bug Something isn't working untriaged labels Aug 31, 2022
@dblock
Copy link
Member

dblock commented Sep 6, 2022

cc: @VachaShah who's working on https://github.com/opensearch-project/opensearch-api-specification to replace the code in rest-api-spec here

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
Status: Planned work items
Development

No branches or pull requests

3 participants