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

API automation (Phase 1) #9050

Open
1 of 26 tasks
Naarcha-AWS opened this issue Jan 10, 2025 · 0 comments
Open
1 of 26 tasks

API automation (Phase 1) #9050

Naarcha-AWS opened this issue Jan 10, 2025 · 0 comments
Assignees
Labels
1 - Backlog - DOC Doc writer assigned to issue responsible for creating PR. 2 - In progress Issue/PR: The issue or PR is in progress.

Comments

@Naarcha-AWS
Copy link
Collaborator

Naarcha-AWS commented Jan 10, 2025

Tell us about your request. Provide a summary of the request.

Add API automation markers after the query parameter descriptions have been updated in the API specification. This is related to opensearch-project/opensearch-api-specification#780. As we add markers, any gaps identified from the initial API automation workflow will be identified. @nhtruong can assist any workflow issues we encounter.

Furthermore, going through each namespace will allow us to add any API pages missing from the documentation that exists from the spec.

The following list uses the namespaces yaml files to track the progress of the automation:

  • asynchronous_search.yaml
  • cat.yaml (In-progress: CAT API automation (Part II) #9060)
  • 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
@Naarcha-AWS Naarcha-AWS added 2 - In progress Issue/PR: The issue or PR is in progress. 1 - Backlog - DOC Doc writer assigned to issue responsible for creating PR. labels Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 - Backlog - DOC Doc writer assigned to issue responsible for creating PR. 2 - In progress Issue/PR: The issue or PR is in progress.
Projects
None yet
Development

No branches or pull requests

2 participants