aboutsummaryrefslogtreecommitdiffstats
path: root/cps-rest/docs
diff options
context:
space:
mode:
authorputhuparambil.aditya <aditya.puthuparambil@bell.ca>2022-02-25 13:24:03 +0000
committerputhuparambil.aditya <aditya.puthuparambil@bell.ca>2022-02-28 10:06:26 +0000
commitcc17ae5e08acf4fd5e67185982142326318f5bef (patch)
tree339689eb8561add874ccfa3be0fae75b68c11faa /cps-rest/docs
parentebfa4077b2e462237301e93566fed6ef2f56674c (diff)
Updated openapi.yaml to match to changes in get data node API
1. updated the pom version to 3.0.0-SNAPSHOT 2. modified the examples for get data node api to match the post api. Issue-ID: CPS-865 Signed-off-by: puthuparambil.aditya <aditya.puthuparambil@bell.ca> Change-Id: Icf03522e9ba7fb9c245fd9f09b3eb8bb6f3ee60d
Diffstat (limited to 'cps-rest/docs')
-rw-r--r--cps-rest/docs/openapi/components.yml16
-rw-r--r--cps-rest/docs/openapi/cpsData.yml26
-rw-r--r--cps-rest/docs/openapi/cpsQuery.yml6
3 files changed, 19 insertions, 29 deletions
diff --git a/cps-rest/docs/openapi/components.yml b/cps-rest/docs/openapi/components.yml
index 5f31569c9a..ae0326d7ea 100644
--- a/cps-rest/docs/openapi/components.yml
+++ b/cps-rest/docs/openapi/components.yml
@@ -1,5 +1,5 @@
# ============LICENSE_START=======================================================
-# Copyright (c) 2021 Bell Canada.
+# Copyright (c) 2021-2022 Bell Canada.
# Modifications Copyright (C) 2021-2022 Nordix Foundation
# ================================================================================
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -86,7 +86,7 @@ components:
example: my-schema-set
examples:
- dataSampleRequest:
+ dataSample:
value:
test:bookstore:
bookstore-name: Chapters
@@ -96,16 +96,6 @@ components:
- code: 02
name: kids
- dataSampleResponse:
- summary: The data node returned does not include the root node. This is being investigated as a part of CPS-461
- value:
- bookstore-name: Chapters
- categories:
- - code: 01
- name: SciFi
- - code: 02
- name: kids
-
parameters:
dataspaceNameInQuery:
name: dataspace-name
@@ -269,7 +259,7 @@ components:
schema:
type: object
examples:
- dataSampleResponse:
+ dataSample:
value: ""
Created:
description: Created
diff --git a/cps-rest/docs/openapi/cpsData.yml b/cps-rest/docs/openapi/cpsData.yml
index 099512d7dc..265ee23ad1 100644
--- a/cps-rest/docs/openapi/cpsData.yml
+++ b/cps-rest/docs/openapi/cpsData.yml
@@ -1,5 +1,5 @@
# ============LICENSE_START=======================================================
-# Copyright (c) 2021 Bell Canada.
+# Copyright (c) 2021-2022 Bell Canada.
# Modifications Copyright (C) 2021-2022 Nordix Foundation
# ================================================================================
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -37,8 +37,8 @@ nodeByDataspaceAndAnchor:
schema:
type: object
examples:
- dataSampleResponse:
- $ref: 'components.yml#/components/examples/dataSampleResponse'
+ dataSample:
+ $ref: 'components.yml#/components/examples/dataSample'
'400':
$ref: 'components.yml#/components/responses/BadRequest'
'401':
@@ -68,8 +68,8 @@ listElementByDataspaceAndAnchor:
schema:
type: object
examples:
- dataSampleRequest:
- $ref: 'components.yml#/components/examples/dataSampleRequest'
+ dataSample:
+ $ref: 'components.yml#/components/examples/dataSample'
responses:
'201':
$ref: 'components.yml#/components/responses/Created'
@@ -99,8 +99,8 @@ listElementByDataspaceAndAnchor:
schema:
type: object
examples:
- dataSampleRequest:
- $ref: 'components.yml#/components/examples/dataSampleRequest'
+ dataSample:
+ $ref: 'components.yml#/components/examples/dataSample'
responses:
'200':
$ref: 'components.yml#/components/responses/Ok'
@@ -155,8 +155,8 @@ nodesByDataspaceAndAnchor:
schema:
type: object
examples:
- dataSampleRequest:
- $ref: 'components.yml#/components/examples/dataSampleRequest'
+ dataSample:
+ $ref: 'components.yml#/components/examples/dataSample'
responses:
'201':
$ref: 'components.yml#/components/responses/Created'
@@ -188,8 +188,8 @@ nodesByDataspaceAndAnchor:
schema:
type: object
examples:
- dataSampleRequest:
- $ref: 'components.yml#/components/examples/dataSampleRequest'
+ dataSample:
+ $ref: 'components.yml#/components/examples/dataSample'
responses:
'200':
$ref: 'components.yml#/components/responses/Ok'
@@ -241,8 +241,8 @@ nodesByDataspaceAndAnchor:
schema:
type: object
examples:
- dataSampleRequest:
- $ref: 'components.yml#/components/examples/dataSampleRequest'
+ dataSample:
+ $ref: 'components.yml#/components/examples/dataSample'
responses:
'200':
$ref: 'components.yml#/components/responses/Ok'
diff --git a/cps-rest/docs/openapi/cpsQuery.yml b/cps-rest/docs/openapi/cpsQuery.yml
index 06c9ca2a24..dc0402d03e 100644
--- a/cps-rest/docs/openapi/cpsQuery.yml
+++ b/cps-rest/docs/openapi/cpsQuery.yml
@@ -1,6 +1,6 @@
# ============LICENSE_START=======================================================
# Copyright (C) 2021 Nordix Foundation
-# Copyright (C) 2021-2022 Nordix Foundation
+# Modifications Copyright (c) 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.
@@ -37,8 +37,8 @@ nodesByDataspaceAndAnchorAndCpsPath:
schema:
type: object
examples:
- dataSampleResponse:
- $ref: 'components.yml#/components/examples/dataSampleResponse'
+ dataSample:
+ $ref: 'components.yml#/components/examples/dataSample'
'400':
$ref: 'components.yml#/components/responses/BadRequest'
'401':