documentation-website [DOC-META] Missing api documentation

trafficstars

What do you want to do?

[ ] Request a change to existing documentation
[ ] Add new documentation
[ ] Report a technical problem with the documentation
[X] Other

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:

cat.master
cluster.delete_voting_config_exclusions
cluster.pending_tasks
cluster.post_voting_config_exclusions
cluster.state
cluster.reroute
field_caps
indices.add_block
indices.flush_synced
indices.flush
indices.forcemerge
indices.get_upgrade
indices.recovery
indices.refresh
indices.resolve_index
indices.rollover
indices.segments
indices.shard_stores
indices.simulate_index
indices.simulate_template
indices.stats - https://github.com/opensearch-project/documentation-website/pull/4892
indices.upgrade
indices.validate_query
ingest.processor_grok
mtermvectors
remote_store.restore
search_shards
snapshot.cleanup_repository
snapshot.clone
termvectors

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:

append-processor
bytes-processor
ingest-circle-processor
convert-processor
date-index-name-processor
dissect-processor
dot-expand-processor
drop-processor
fail-processor
foreach-processor
geoip-processor
gsub-processor
htmlstrip-processor
inference-processor
join-processor
kv-processor
pipeline-processor
remove-processor
rename-processor
script-processor
set-processor
ingest-node-set-security-user-processor
sort-processor
urldecode-processor
user-agent-processor

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

Mar 29 '23 17:03 curq

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.

Mar 29 '23 22:03 hdhalter

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

Mar 29 '23 22:03 hdhalter

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.

Jun 10 '23 00:06 hdhalter

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.

[ ] cat.master - no issue exists
[ ] cluster.delete_voting_config_exclusions https://github.com/opensearch-project/documentation-website/issues/2092
[ ] cluster.pending_tasks https://github.com/opensearch-project/documentation-website/issues/2092
[ ] cluster.post_voting_config_exclusions https://github.com/opensearch-project/documentation-website/issues/2092
[ ] cluster.state https://github.com/opensearch-project/documentation-website/issues/2092
[ ] cluster.reroute https://github.com/opensearch-project/documentation-website/issues/2092
[ ] field_caps - no issue exists
[ ] indices.add_block - no issue exists
[x] indices.flush_synced - https://github.com/opensearch-project/documentation-website/issues/2096
[x] indices.flush- https://github.com/opensearch-project/documentation-website/issues/2096
[x] indices.forcemerge -https://github.com/opensearch-project/documentation-website/issues/5057
[ ] indices.get_upgrade - no issue exists
[ ] indices.recovery -https://github.com/opensearch-project/documentation-website/issues/2098
[x] indices.refresh - https://github.com/opensearch-project/documentation-website/issues/2099; https://github.com/opensearch-project/documentation-website/pull/6954
[ ] indices.resolve_index - https://github.com/opensearch-project/documentation-website/issues/2114
[ ] indices.rollover https://github.com/opensearch-project/documentation-website/issues/2100
[ ] indices.segments - https://github.com/opensearch-project/documentation-website/issues/2101
[ ] indices.shard_stores - https://github.com/opensearch-project/documentation-website/issues/2102
[ ] indices.simulate_index - https://github.com/opensearch-project/documentation-website/issues/2115
[ ] indices.simulate_template - https://github.com/opensearch-project/documentation-website/issues/2115
[x] indices.stats - https://github.com/opensearch-project/documentation-website/issues/2103
[ ] indices.upgrade - no issue exists
[ ] indices.validate_query -https://github.com/opensearch-project/documentation-website/issues/2104
[x] ingest.processor_grok - https://github.com/opensearch-project/documentation-website/issues/2105
[ ] mtermvectors - https://github.com/opensearch-project/documentation-website/issues/2108
[ ] remote_store.restore - no issue exists
[ ] search_shards - https://github.com/opensearch-project/documentation-website/issues/2110
[ ] snapshot.cleanup_repository - https://github.com/opensearch-project/documentation-website/issues/2111
[ ] snapshot.clone - https://github.com/opensearch-project/documentation-website/issues/2111
[ ] termvectors -https://github.com/opensearch-project/documentation-website/issues/2108

Jun 13 '23 00:06 hdhalter

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

[ ] DELETE /_component_template/ - https://github.com/opensearch-project/documentation-website/issues/2113
[ ] HEAD /_component_template/ https://github.com/opensearch-project/documentation-website/issues/2113
[ ] GET /_component_template/ https://github.com/opensearch-project/documentation-website/issues/2113
[ ] POST /_component_template/ (already have PUT)https://github.com/opensearch-project/documentation-website/issues/2113
[ ] POST /_delete_by_query/<task_id>/_rethrottle -https://github.com/opensearch-project/documentation-website/issues/2112
[ ] POST /_update_by_query/<task_id>/_rethrottle https://github.com/opensearch-project/documentation-website/issues/2112
[ ] POST /_reindex/<task_id>/_rethrottle https://github.com/opensearch-project/documentation-website/issues/2112
[x] GET /_msearch/template -https://github.com/opensearch-project/documentation-website/issues/2107
[x] POST /_msearch/template - https://github.com/opensearch-project/documentation-website/issues/2107
[x] GET //_msearch/template -https://github.com/opensearch-project/documentation-website/issues/2107
[x] POST //_msearch/template -https://github.com/opensearch-project/documentation-website/issues/2107
[ ] GET /_validate/query -https://github.com/opensearch-project/documentation-website/issues/2104
[ ] GET //_validate/query https://github.com/opensearch-project/documentation-website/issues/2104
[ ] POST /_validate/query https://github.com/opensearch-project/documentation-website/issues/2104
[ ] POST //_validate/query https://github.com/opensearch-project/documentation-website/issues/2104
[ ] GET /_data_stream/_stats - https://github.com/opensearch-project/documentation-website/issues/2095
[ ] GET /_field_caps?fields= https://github.com/opensearch-project/documentation-website/issues/2094
[ ] POST /_field_caps?fields= https://github.com/opensearch-project/documentation-website/issues/2094
[ ] GET //_field_caps?fields= https://github.com/opensearch-project/documentation-website/issues/2094
[ ] POST //_field_caps?fields= https://github.com/opensearch-project/documentation-website/issues/2094
[ ] PUT //_create/ https://github.com/opensearch-project/documentation-website/issues/2093
[ ] POST //_create/ https://github.com/opensearch-project/documentation-website/issues/2093
[ ] HEAD //_doc/ https://github.com/opensearch-project/documentation-website/issues/2093
[ ] HEAD //_source/ https://github.com/opensearch-project/documentation-website/issues/2093
[ ] GET //_source/ // deprecated (per Nate) https://github.com/opensearch-project/documentation-website/issues/2093
[ ] PUT //_block/ https://github.com/opensearch-project/documentation-website/issues/2093
[ ] HEAD / https://github.com/opensearch-project/documentation-website/issues/2093