blob: a96947bd39ced85bcb74fb838504557f255515d5 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
|
# ============LICENSE_START=======================================================
# Copyright (c) 2021-2022 Bell Canada.
# ================================================================================
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
# ============LICENSE_END=========================================================
openapi: 3.0.1
info:
title: ONAP Open API v3 Configuration Persistence Service - Temporal
description: CPS-Temporal is time-series database for network data
version: 1.0.0
contact:
name: ONAP
url: 'https://onap.readthedocs.io'
email: onap-discuss@lists.onap.org
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0'
x-planned-retirement-date: '202212'
x-component: Modeling
servers:
- url: '/cps-temporal/api'
tags:
- name: cps-temporal-query
description: CPS Temporal Query
paths:
'/v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/history':
get:
description: 'Read the data for the specified anchor based on filter criteria provided in query parameters'
tags:
- cps-temporal-query
summary: Get anchor data by name
operationId: getAnchorDataByName
parameters:
- $ref: '#/components/parameters/dataspaceName'
- name: anchor-name
in: path
description: Anchor Name
required: true
schema:
type: string
example: my-anchor
- $ref: '#/components/parameters/observedTimestampAfter'
- $ref: '#/components/parameters/simplePayloadFilter'
- $ref: '#/components/parameters/pointInTime'
- $ref: '#/components/parameters/pageNumber'
- $ref: '#/components/parameters/pageLimit'
- $ref: '#/components/parameters/sort'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AnchorHistory'
example:
nextRecordsLink: /v1/dataspace/my-dataspace/anchors/my-anchor/history?pageLimit=20&pageNumber=2
previousRecordsLink: /v1/dataspace/my-dataspace/anchors/my-anchor/history?pageLimit=20&pageNumber=0
records:
- timestamp: '2021-03-21T00:00:00.000-0000'
dataspace: my-dataspace
schemaSet: my-schema-set
anchor: my-anchor
data:
status: UP
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'/v1/dataspaces/{dataspace-name}/anchors/history':
get:
description: 'Read anchors data based on filter criteria provided in query parameters'
tags:
- cps-temporal-query
summary: Get anchors data based on filter criteria
operationId: getAnchorsDataByFilter
parameters:
- $ref: '#/components/parameters/dataspaceName'
- name: schema-set-name
in: query
description: Schema-set name
required: true
schema:
type: string
- $ref: '#/components/parameters/observedTimestampAfter'
- $ref: '#/components/parameters/simplePayloadFilter'
- $ref: '#/components/parameters/pointInTime'
- $ref: '#/components/parameters/pageNumber'
- $ref: '#/components/parameters/pageLimit'
- $ref: '#/components/parameters/sort'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AnchorHistory'
example:
nextRecordsLink: /v1/dataspace/my-dataspace/anchors/history?pageLimit=20&pageNumber=2
previousRecordsLink: /v1/dataspace/my-dataspace/anchors/history?pageLimit=20&pageNumber=0
records:
- timestamp: '2021-03-21T00:00:00.000-0000'
dataspace: my-dataspace
schemaSet: my-schema-set
anchor: my-anchor
data:
status: UP
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
components:
parameters:
dataspaceName:
name: dataspace-name
in: path
description: Dataspace Name
required: true
schema:
type: string
observedTimestampAfter:
name: observedTimestampAfter
in: query
description: Fetch data with observed timestamp after <br/> Format - 'yyyy-MM-ddTHH:mm:ss.SSSZ'
required: false
schema:
type: string
example: '2021-03-21T00:00:00.000-0000'
simplePayloadFilter:
name: simplePayloadFilter
in: query
description: Payload filter
required: false
schema:
type: string
pointInTime:
name: pointInTime
in: query
description: Consider data modified before <br/> Format - 'yyyy-MM-ddTHH:mm:ss.SSSZ'
required: false
schema:
type: string
example: '2021-03-21T00:00:00.000-0000'
pageLimit:
in: query
name: pageLimit
required: false
schema:
type: integer
minimum: 0
default: 1000
description: The numbers of items to return
pageNumber:
name: pageNumber
in: query
description: Page number
required: false
schema:
type: integer
minimum: 0
default: 0
sort:
in: query
name: sort
required: false
schema:
type: string
default: observed_timestamp:desc
description: "Sort by timestamp in 'asc' or 'desc' order. Supported values: <br/>observed_timestamp:desc<br/>anchor:asc,observed_timestamp:desc"
responses:
BadRequest:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400
message: Bad request error message
details: Bad request error details
Unauthorized:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized error message
details: Unauthorized error details
Forbidden:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Forbidden error message
details: Forbidden error details
schemas:
AnchorDetails:
type: object
title: AnchorDetails
properties:
observedTimestamp:
type: string
example: '2021-03-21T00:00:00.000-0000'
operation:
type: string
enum: [CREATE, UPDATE, DELETE]
example: UPDATE
dataspace:
type: string
example: 'my-dataspace'
schemaSet:
type: string
example: 'my-schema-set'
anchor:
type: string
example: 'my-anchor'
data:
type: object
example: { "status" : "UP" }
AnchorHistory:
type: object
title: AnchorHistory
properties:
nextRecordsLink:
type: string
example: /v1/dataspace/dataspace-name/anchors/history?pageLimit=20&pageNumber=2
previousRecordsLink:
type: string
example: /v1/dataspace/dataspace-name/anchors/history?pageLimit=20&pageNumber=0
records:
type: array
items:
$ref: '#/components/schemas/AnchorDetails'
required:
- records
ErrorMessage:
type: object
title: Error
properties:
status:
type: string
example: 400
message:
type: string
example: Data could not be fetched
details:
type: string
example: "after parameter should have datetime value in ISO format yyyy-MM-ddTHH:mm:ss.SSSZ"
|
