Skip to content

API automation (Phase 1) #9050

@Naarcha-AWS

Description

@Naarcha-AWS

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

Metadata

Metadata

Assignees

Labels

Backlog - DOCDoc writer assigned to issue responsible for creating PR.In progressIssue/PR: The issue or PR is in progress.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions