Added retry.

[dblock]

Description

Allows to wait for a certain payload. This is useful for asynchronous tasks, such as ML.

  - synopsis: Wait for task.
    path: /_plugins/_ml/tasks/{task_id}
    method: GET
    parameters:
      task_id: ${create_model.task_id}
    response:
      status: 200
      payload:
        state: COMPLETED
    retry:
      count: 3
      wait: 30000

Issues Resolved

Closes #328.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[github-actions]

Changes Analysis

Commit SHA: 0d4818f
Comparing To SHA: 7cae0b8

API Changes

Summary

├─┬Paths
│ ├─┬/_plugins/_ml/models/{model_id}
│ │ └─┬DELETE
│ │   └─┬Responses
│ │     └─┬200
│ │       └─┬application/json
│ │         └──[➖] schema (25021:13)❌ 
│ ├─┬/_plugins/_ml/model_groups/_register
│ │ └─┬POST
│ │   └─┬Responses
│ │     └─┬200
│ │       └─┬application/json
│ │         └──[➖] schema (25076:13)❌ 
│ ├─┬/_plugins/_ml/tasks/{task_id}
│ │ └─┬GET
│ │   └─┬Responses
│ │     └─┬200
│ │       └─┬application/json
│ │         └──[➖] schema (25055:13)❌ 
│ ├─┬/_plugins/_ml/model_groups/{model_group_id}
│ │ ├─┬GET
│ │ │ └─┬Responses
│ │ │   └─┬200
│ │ │     └─┬application/json
│ │ │       └──[➖] schema (25026:13)❌ 
│ │ └─┬DELETE
│ │   └─┬Responses
│ │     └─┬200
│ │       └─┬application/json
│ │         └──[➖] schema (25016:13)❌ 
│ ├─┬/_plugins/_ml/models/_search
│ │ └─┬GET
│ │   ├─┬Responses
│ │   │ └─┬200
│ │   │   └─┬application/json
│ │   │     └──[➖] schema (25109:13)❌ 
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └──[➖] schema (22814:13)❌ 
│ └─┬/_plugins/_ml/models/_register
│   └─┬POST
│     └─┬Responses
│       └─┬200
│         └─┬application/json
│           └──[➖] schema (25091:13)❌ 
└─┬Components
  ├──[➖] schemas (45098:7)❌ 
  ├──[➖] schemas (45086:7)❌ 
  ├──[➕] schemas (45077:7)
  ├──[➕] schemas (45000:7)
  ├──[➕] schemas (45065:7)
  ├──[➕] schemas (45026:7)
  ├──[➕] schemas (45084:7)
  ├──[➕] schemas (45050:7)
  └──[➕] schemas (45038:7)

Document Element	Total Changes	Breaking Changes
paths	8	8
components	9	2

• ❌ BREAKING Changes: 10 out of 17
• Removals: 10
• Additions: 7
• Breaking Removals: 10

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/10169968536/artifacts/1757514388

API Coverage

	Before	After	Δ
Covered (%)	500 (48.97 %)	500 (48.97 %)	0 (0 %)
Uncovered (%)	521 (51.03 %)	521 (51.03 %)	0 (0 %)
Unknown	24	24	0

[github-actions]

Spec Test Coverage Analysis

Total	Tested
524	120 (22.9 %)