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

Update query parameter descriptions #780

Open
1 of 27 tasks
Naarcha-AWS opened this issue Jan 10, 2025 · 1 comment
Open
1 of 27 tasks

Update query parameter descriptions #780

Naarcha-AWS opened this issue Jan 10, 2025 · 1 comment
Assignees
Labels
enhancement New feature or request untriaged

Comments

@Naarcha-AWS
Copy link
Contributor

Naarcha-AWS commented Jan 10, 2025

Is your feature request related to a problem?

In order to automate the API documentation, all of the descriptions contained in the spec must be reviewed. Most of these descriptions are contained in the namespaces directory.

What solution would you like?

The following list will help track the progress of description updates for query parameters:

  • core.yaml
  • asynchronous_search.yaml (Add asynchronous search descriptions. #781)
  • cat.yaml
  • cluster.yaml
  • dangling_indices.yaml
  • flow_framework.yaml
  • indices.yaml
  • ingest.yaml
  • insights.yaml
  • ism.yaml
  • knn.yaml
  • list.yaml
  • ml.yaml
  • nodes.yml
  • notifications.yaml
  • observability.yaml
  • ppl.yaml
  • query.yaml
  • remote_store.yaml
  • replication.yaml
  • rollups.yaml
  • search_pipeline.yaml
  • security.yaml
  • sql.yaml
  • tasks.yaml
  • transforms.yaml
  • wlm.yaml

What alternatives have you considered?

We should eventually look into using $refs when descriptions are repeated across namespaces. However, when I tried to achieve this during the CAT API description update, I couldn't figure out a clean way to use $ref.

Do you have any additional context?

Add any other context or screenshots about the feature request here.

@Naarcha-AWS Naarcha-AWS added enhancement New feature or request untriaged labels Jan 10, 2025
@Naarcha-AWS
Copy link
Contributor Author

Please go ahead and assign this issue to me.

@Naarcha-AWS Naarcha-AWS changed the title Update Query parameter descriptions Update query parameter descriptions Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request untriaged
Projects
None yet
Development

No branches or pull requests

1 participant