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] Some core plugin API documentations are missing #1895

Closed
bandinib-amzn opened this issue Jul 13, 2022 · 2 comments · Fixed by #1946
Closed

[BUG] Some core plugin API documentations are missing #1895

bandinib-amzn opened this issue Jul 13, 2022 · 2 comments · Fixed by #1946
Assignees
Labels
bug Something isn't working

Comments

@bandinib-amzn
Copy link
Member

Describe the bug

Some core plugin API documentations are missing

To Reproduce
Steps to reproduce the behavior:

  1. Go to https://github.com/opensearch-project/OpenSearch-Dashboards/tree/main/src/core
  2. Click on Core Public API, Core Server API, OpenSearch Dashboards Platform Plugin API
  3. See Page not found error

Expected behavior
It should redirect to valid documentation.

OpenSearch Version
Please list the version of OpenSearch being used.

Dashboards Version
Please list the version of OpenSearch Dashboards being used.

Plugins

Please list all plugins currently enabled.

Screenshots

If applicable, add screenshots to help explain your problem.

Host/Environment (please complete the following information):

  • OS: [e.g. iOS]
  • Browser and version [e.g. 22]

Additional context

Add any other context about the problem here.

@bandinib-amzn bandinib-amzn added bug Something isn't working untriaged labels Jul 13, 2022
@ashwin-pc
Copy link
Member

Looks like these used to point to developer docs which we no longer have. But it might be worthwhile to point them to the public and server API report files in the meantime. They are not as easy to read as dedicated docsite links but will still be useful in the meantime while we get that up and running

@manasvinibs manasvinibs self-assigned this Jul 20, 2022
@manasvinibs
Copy link
Member

@ashwin-pc For OpenSearch Dashboards Platform Plugin API, do you think this is a good link to point to for now -https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/src/core/PRINCIPLES.md ?

manasvinibs added a commit to manasvinibs/OpenSearch-Dashboards that referenced this issue Jul 25, 2022
manasvinibs added a commit to manasvinibs/OpenSearch-Dashboards that referenced this issue Jul 26, 2022
@kavilla kavilla linked a pull request Jul 26, 2022 that will close this issue
7 tasks
manasvinibs added a commit that referenced this issue Jul 26, 2022
…ns (#1946)

Resolves issue - #1895

Signed-off-by: Manasvini B Suryanarayana <[email protected]>
opensearch-trigger-bot bot pushed a commit that referenced this issue Jul 26, 2022
…ns (#1946)

Resolves issue - #1895

Signed-off-by: Manasvini B Suryanarayana <[email protected]>
(cherry picked from commit 2c428b8)
opensearch-trigger-bot bot pushed a commit that referenced this issue Jul 26, 2022
…ns (#1946)

Resolves issue - #1895

Signed-off-by: Manasvini B Suryanarayana <[email protected]>
(cherry picked from commit 2c428b8)
opensearch-trigger-bot bot pushed a commit that referenced this issue Jul 26, 2022
…ns (#1946)

Resolves issue - #1895

Signed-off-by: Manasvini B Suryanarayana <[email protected]>
(cherry picked from commit 2c428b8)
manasvinibs added a commit that referenced this issue Jul 27, 2022
…ns (#1946)

Resolves issue - #1895

Signed-off-by: Manasvini B Suryanarayana <[email protected]>
(cherry picked from commit 2c428b8)
manasvinibs added a commit that referenced this issue Jul 27, 2022
…ns (#1946) (#1958)

Resolves issue - #1895

Signed-off-by: Manasvini B Suryanarayana <[email protected]>
(cherry picked from commit 2c428b8)

Co-authored-by: Manasvini B Suryanarayana <[email protected]>
manasvinibs added a commit that referenced this issue Jul 29, 2022
…ns (#1946) (#1960)

Resolves issue - #1895

Signed-off-by: Manasvini B Suryanarayana <[email protected]>
(cherry picked from commit 2c428b8)

Co-authored-by: Manasvini B Suryanarayana <[email protected]>
Co-authored-by: Kawika Avilla <[email protected]>
CPTNB pushed a commit to CPTNB/OpenSearch-Dashboards that referenced this issue Aug 8, 2022
kavilla added a commit that referenced this issue Aug 23, 2022
…ns (#1946) (#1959)

Resolves issue - #1895

Signed-off-by: Manasvini B Suryanarayana <[email protected]>
(cherry picked from commit 2c428b8)

Co-authored-by: Manasvini B Suryanarayana <[email protected]>
Co-authored-by: Kawika Avilla <[email protected]>
pjfitzgibbons pushed a commit to pjfitzgibbons/OpenSearch-Dashboards that referenced this issue Oct 24, 2022
…ns (opensearch-project#1946) (opensearch-project#1959)

Resolves issue - opensearch-project#1895

Signed-off-by: Manasvini B Suryanarayana <[email protected]>
(cherry picked from commit 2c428b8)

Co-authored-by: Manasvini B Suryanarayana <[email protected]>
Co-authored-by: Kawika Avilla <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
3 participants