search

opensearch-project / documentation-website

The documentation for OpenSearch, OpenSearch Dashboards, and their associated plugins.
https://opensearch.org/docs
Apache License 2.0
68 stars 473 forks source link

[DOC-META] Missing api documentation #3614

Open curq opened 1 year ago

curq commented 1 year ago

What do you want to do?

Tell us about your request. Provide a summary of the request and all versions that are affected. In the issue https://github.com/opensearch-project/OpenSearch-Dashboards/issues/3714 I was asked to update links in Dev Tools console in Opensearch-Dashboards repo. I was asked to list all the missing docs. First I audited documentation values in JSON files in https://github.com/opensearch-project/OpenSearch-Dashboards/tree/main/src/plugins/console/server/lib/spec_definitions/json/generated. I found several missing docs, I will list respective filenames:

Another important notes is that only PUT _component_template is documented while DELETE, HEAD and GET are not. Additionally, in reindex, delete by query and update by query rethrottle variations are not documented (reindex_rethrottle, delete_by_query_rethrottle, update_by_query_rethrottle).

Lastly after checking https://github.com/opensearch-project/OpenSearch-Dashboards/tree/main/src/plugins/console/server/lib/spec_definitions/js/ingest.ts it seems like a lot of processors are not documented. The list:

Please tell me if missed something and they are actually documented. Also, please comment if you need additional any additional info.

What other resources are available? Provide links to related issues, POCs, steps for testing, etc. https://github.com/opensearch-project/documentation-website/issues/url

hdhalter commented 1 year ago

Thanks for entering this issue, Sirazh! We have a number of APIs in our backlog to document: https://github.com/opensearch-project/documentation-website/issues?q=is%3Aissue+is%3Aopen+label%3AAPI, so we can cross-check against your list.

hdhalter commented 1 year ago

Assigning to @ariamarble , since she is assigned to the other APIs, and @kolchfa-aws for visibility.

hdhalter commented 1 year ago

Hi @curq - The missing processors are being addressed according to this issue: https://github.com/opensearch-project/documentation-website/issues/4193

Removed @ariamarble and added @vagimeli.

hdhalter commented 1 year ago

I did a check to see if we had issues for the undocumented APIs. Most of them do, but I commented if it doesn't.

hdhalter commented 1 year ago

We also have issues for these that are not in the above list:

kolchfa-aws commented 1 year ago

I did a check to see if we had issues for the undocumented APIs. Most of them do, but I commented if it doesn't.

vagimeli commented 1 year ago

See PR #4299 for updates on processors documentation

hdhalter commented 5 months ago

Let's keep this open until we have all APIs complete.

Naarcha-AWS commented 2 months ago

Additional missing APIs uncovered:

dblock commented 2 months ago

I propose we invest some hands into https://github.com/opensearch-project/documentation-website/issues/7700 to bridge all the gaps with automation.