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.

Sign up for GitHub

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

Jump to bottom

[DOC-META] Missing api documentation #3614

Open
1 of 4 tasks
curq opened this issue Mar 29, 2023 · 10 comments
Open
1 of 4 tasks

[DOC-META] Missing api documentation #3614

curq opened this issue Mar 29, 2023 · 10 comments
Assignees
@Naarcha-AWS @vagimeli @kolchfa-aws
Labels
API Content gap Sev3 Medium priority. Content that's missing, driven by dev, PM or the community.

Comments

@curq
Copy link

curq commented Mar 29, 2023 •
edited by hdhalter
Loading

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • 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 - Add Index Stats API #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
@curq curq added the untriaged label Mar 29, 2023
@curq curq mentioned this issue Mar 29, 2023
Merged
8 tasks
@hdhalter
Copy link
Contributor

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 hdhalter added API 1 - Backlog Issue: The issue is unassigned or assigned but not started Sev3 Medium priority. Content that's missing, driven by dev, PM or the community. and removed untriaged labels Mar 29, 2023
@hdhalter hdhalter added this to the 2023-Q2 milestone Mar 29, 2023
@hdhalter
Copy link
Contributor

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

@hdhalter hdhalter assigned vagimeli and unassigned ariamarble Jun 10, 2023
@hdhalter
Copy link
Contributor

Hi @curq - The missing processors are being addressed according to this issue: #4193

Removed @ariamarble and added @vagimeli.

@hdhalter
Copy link
Contributor

hdhalter commented Jun 13, 2023 •
edited
Loading

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
Copy link
Contributor

hdhalter commented Jun 13, 2023 •
edited
Loading

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

@kolchfa-aws
Copy link
Collaborator

kolchfa-aws commented Jun 20, 2023 •
edited by hdhalter
Loading

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
Copy link
Contributor

See PR #4299 for updates on processors documentation

@joshuarrrr joshuarrrr mentioned this issue Aug 17, 2023
Merged
8 tasks
@Naarcha-AWS Naarcha-AWS removed this from the 2023-Q2 milestone Nov 13, 2023
@hdhalter
Copy link
Contributor

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

@hdhalter hdhalter reopened this Apr 23, 2024
@hdhalter hdhalter removed untriaged 1 - Backlog Issue: The issue is unassigned or assigned but not started labels Apr 26, 2024
@Naarcha-AWS
Copy link
Collaborator

Additional missing APIs uncovered:

  • PUT data_streams
  • DELETE data_streams
  • GET data_streams
  • PUT data_streams/migrate
  • GET data_streams/promote
  • PUT data_streams/modify

@dblock
Copy link
Member

dblock commented Jul 12, 2024

I propose we invest some hands into #7700 to bridge all the gaps with automation.

@hdhalter hdhalter changed the title [DOC] Missing api documentation [DOC-META] Missing api documentation Jul 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Naarcha-AWS Naarcha-AWS

@vagimeli vagimeli

@kolchfa-aws kolchfa-aws

Labels
API Content gap Sev3 Medium priority. Content that's missing, driven by dev, PM or the community.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
7 participants
@dblock @curq @Naarcha-AWS @hdhalter @vagimeli @kolchfa-aws @ariamarble