Skip to content

Commit 5843523

Browse files
committed
opensearch-project#844 Adding spec for UBI.
Signed-off-by: jzonthemtn <[email protected]>
1 parent 389a8de commit 5843523

File tree

4 files changed

+39
-0
lines changed

4 files changed

+39
-0
lines changed

.github/workflows/test-spec.yml

+2
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ jobs:
5959
tests: plugins/knn
6060
- version: 2.19.0
6161
tests: plugins/learning_to_rank
62+
- version: 2.19.0
63+
tests: plugins/user_behavior_insights
6264
- version: 2.19.0
6365
tests: plugins/security
6466
cert: tests/plugins/security/.kirk.pem

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
66

77
### Added
88

9+
- Added specs for UBI plugin endpoints ([#844](https://github.com/opensearch-project/opensearch-api-specification/pull/844))
910
- Added defaults for Snapshot APIs ([#830](https://github.com/opensearch-project/opensearch-api-specification/pull/830))
1011
- Added specs for LTR plugin for stats endpoints ([#786](https://github.com/opensearch-project/opensearch-api-specification/issues/786/))
1112
- Added defaults for Cluster APIs ([#824](https://github.com/opensearch-project/opensearch-api-specification/pull/824/))

spec/namespaces/ubi.yaml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
openapi: 3.1.0
2+
info:
3+
title: OpenSearch UBI API
4+
description: OpenSearch UBI API.
5+
version: 1.0.0
6+
paths:
7+
/_plugins/ubi/initialize:
8+
get:
9+
operationId: ubi.initialize.0
10+
x-operation-group: ubi.initialize
11+
x-version-added: '1.0'
12+
description: Initializes the UBI indexes.
13+
responses:
14+
'200':
15+
$ref: '#/components/responses/ubi.initialize@200'
16+
17+
components:
18+
responses:
19+
ubi.initialize@200:
20+
content:
21+
application/json:
22+
schema:
23+
$ref: '../schemas/ubi._common.yaml#/components/schemas/Initialize'

spec/schemas/ubi._common.yaml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
openapi: 3.1.0
2+
info:
3+
title: Schemas of `ubi._common` Category
4+
description: Schemas of `ubi._common` category.
5+
version: 1.0.0
6+
paths: {}
7+
components:
8+
schemas:
9+
Initialize:
10+
type: object
11+
properties:
12+
message:
13+
type: string

0 commit comments

Comments
 (0)