1 # ============LICENSE_START=======================================================
2 # Copyright (c) 2021 Bell Canada.
3 # ================================================================================
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
16 # SPDX-License-Identifier: Apache-2.0
17 # ============LICENSE_END=========================================================
21 title: ONAP Open API v3 Configuration Persistence Service - Temporal
22 description: CPS-Temporal is time-series database for network data
26 url: 'https://onap.readthedocs.io'
27 email: onap-discuss@lists.onap.org
30 url: 'http://www.apache.org/licenses/LICENSE-2.0'
31 x-planned-retirement-date: '202212'
34 - url: '/cps-temporal/api'
36 - name: cps-temporal-query
37 description: CPS Temporal Query
39 '/v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/history':
41 description: 'Read the data for the specified anchor based on filter criteria provided in query parameters'
44 summary: Get anchor data by name
45 operationId: getAnchorDataByName
47 - $ref: '#/components/parameters/dataspaceName'
50 description: Anchor Name
54 - $ref: '#/components/parameters/after'
55 - $ref: '#/components/parameters/simplePayloadFilter'
56 - $ref: '#/components/parameters/pointInTime'
57 - $ref: '#/components/parameters/pageNumber'
58 - $ref: '#/components/parameters/pageLimit'
59 - $ref: '#/components/parameters/sort'
66 $ref: '#/components/schemas/AnchorHistory'
68 nextRecordsLink: /v1/dataspace/my-dataspace/anchors/my-anchor/history?pageLimit=20&pageNumber=2
69 previousRecordsLink: /v1/dataspace/my-dataspace/anchors/my-anchor/history?pageLimit=20&pageNumber=0
71 - timestamp: '2021-03-21T00:00:00.000000-0:00'
72 dataspace: my-dataspace
73 schemaSet: my-schema-set
80 $ref: '#/components/responses/BadRequest'
82 $ref: '#/components/responses/Unauthorized'
84 $ref: '#/components/responses/Forbidden'
85 '/v1/dataspaces/{dataspace-name}/anchors/history':
87 description: 'Read anchors data based on filter criteria provided in query parameters'
90 summary: Get anchors data based on filter criteria
91 operationId: getAnchorsDataByFilter
93 - $ref: '#/components/parameters/dataspaceName'
94 - name: schema-set-name
96 description: Schema-set name
100 - $ref: '#/components/parameters/after'
101 - $ref: '#/components/parameters/simplePayloadFilter'
102 - $ref: '#/components/parameters/pointInTime'
103 - $ref: '#/components/parameters/pageNumber'
104 - $ref: '#/components/parameters/pageLimit'
105 - $ref: '#/components/parameters/sort'
112 $ref: '#/components/schemas/AnchorHistory'
114 nextRecordsLink: /v1/dataspace/my-dataspace/anchors/history?pageLimit=20&pageNumber=2
115 previousRecordsLink: /v1/dataspace/my-dataspace/anchors/history?pageLimit=20&pageNumber=0
117 - timestamp: '2021-03-21T00:00:00.000000-0:00'
118 dataspace: my-dataspace
119 schemaSet: my-schema-set
125 $ref: '#/components/responses/BadRequest'
127 $ref: '#/components/responses/Unauthorized'
129 $ref: '#/components/responses/Forbidden'
135 description: Dataspace Name
142 description: Fetch data after <br/> Format - 'yyyy-MM-ddTHH:mm:ss.SSSZ'
146 example: '2021-03-21T00:00:00.000000-0:00'
148 name: simplePayloadFilter
150 description: Payload filter
157 description: Consider data modified before <br/> Format - 'yyyy-MM-ddTHH:mm:ss.SSSZ'
161 example: '2021-03-21T00:00:00.000000-0:00'
171 description: The numbers of items to return
175 description: Page number
187 default: timestamp:desc
188 description: "Sort by timestamp in 'asc' or 'desc' order. Supported values: <br/> timestamp:desc<br/>timestamp:asc"
191 description: Bad Request
195 $ref: '#/components/schemas/ErrorMessage'
197 description: Unauthorized
201 $ref: '#/components/schemas/ErrorMessage'
203 description: Forbidden
207 $ref: '#/components/schemas/ErrorMessage'
216 example: '2021-03-21T00:00:00.000000-0:00'
219 example: 'my-dataspace'
222 example: 'my-schema-set'
228 example: { "status" : "UP" }
235 example: /v1/dataspace/dataspace-name/anchors/history?pageLimit=20&pageNumber=2
238 example: /v1/dataspace/dataspace-name/anchors/history?pageLimit=20&pageNumber=0
242 $ref: '#/components/schemas/AnchorDetails'
254 example: Data could not be fetched
257 example: "after parameter should have datetime value in ISO format yyyy-MM-ddTHH:mm:ss.SSSZ"