blob: 6e611c4858d5c93bdf0b44b09151d133e216f986 [file] [log] [blame]
openapi: 3.0.1
info:
title: ONAP Open API v3 Configuration Persistence Service
description: Configuration Persistence Service is a Model Driven Generic Database
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
version: 1.0.0
x-planned-retirement-date: "202212"
x-component: Modeling
x-logo:
url: cps_logo.png
servers:
- url: /cps/api
security:
- basicAuth: []
tags:
- name: cps-admin
description: cps Admin
- name: cps-data
description: cps Data
paths:
/v1/dataspaces:
post:
tags:
- cps-admin
summary: Create a dataspace
description: Create a new dataspace
operationId: createDataspace
parameters:
- name: dataspace-name
in: query
description: dataspace-name
required: true
schema:
type: string
example: my-dataspace
responses:
"201":
description: Created
content:
text/plain:
schema:
type: string
example: my-resource
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400
message: Bad Request
details: The provided request is not valid
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized request
details: This request is unauthorized
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Request Forbidden
details: This request is forbidden
"409":
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 409
message: Conflicting request
details: The request cannot be processed as the resource is in use.
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
deprecated: true
/{apiVersion}/dataspaces:
delete:
tags:
- cps-admin
summary: Delete a dataspace
description: Delete a dataspace
operationId: deleteDataspace
parameters:
- name: apiVersion
in: path
description: apiVersion
required: true
schema:
type: string
default: v2
enum:
- v1
- v2
- name: dataspace-name
in: query
description: dataspace-name
required: true
schema:
type: string
example: my-dataspace
responses:
"204":
description: No Content
content: {}
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400
message: Bad Request
details: The provided request is not valid
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized request
details: This request is unauthorized
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Request Forbidden
details: This request is forbidden
"409":
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 409
message: Conflicting request
details: The request cannot be processed as the resource is in use.
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
/v2/dataspaces:
post:
tags:
- cps-admin
summary: Create a dataspace
description: Create a new dataspace
operationId: createDataspaceV2
parameters:
- name: dataspace-name
in: query
description: dataspace-name
required: true
schema:
type: string
example: my-dataspace
responses:
"201":
description: Created without response body
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400
message: Bad Request
details: The provided request is not valid
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized request
details: This request is unauthorized
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Request Forbidden
details: This request is forbidden
"409":
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 409
message: Conflicting request
details: The request cannot be processed as the resource is in use.
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
/{apiVersion}/admin/dataspaces:
get:
tags:
- cps-admin
summary: Get all dataspaces
description: Read all dataspaces
operationId: getAllDataspaces
parameters:
- name: apiVersion
in: path
description: apiVersion
required: true
schema:
type: string
default: v2
enum:
- v1
- v2
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DataspaceDetails'
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400
message: Bad Request
details: The provided request is not valid
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized request
details: This request is unauthorized
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Request Forbidden
details: This request is forbidden
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
/{apiVersion}/admin/dataspaces/{dataspace-name}:
get:
tags:
- cps-admin
summary: Get a dataspace
description: Read a dataspace given a dataspace name
operationId: getDataspace
parameters:
- name: apiVersion
in: path
description: apiVersion
required: true
schema:
type: string
default: v2
enum:
- v1
- v2
- name: dataspace-name
in: path
description: dataspace-name
required: true
schema:
type: string
example: my-dataspace
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DataspaceDetails'
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400
message: Bad Request
details: The provided request is not valid
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized request
details: This request is unauthorized
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Request Forbidden
details: This request is forbidden
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
/v1/dataspaces/{dataspace-name}/anchors:
post:
tags:
- cps-admin
summary: Create an anchor
description: Create a new anchor in the given dataspace
operationId: createAnchor
parameters:
- name: dataspace-name
in: path
description: dataspace-name
required: true
schema:
type: string
example: my-dataspace
- name: schema-set-name
in: query
description: schema-set-name
required: true
schema:
type: string
example: my-schema-set
- name: anchor-name
in: query
description: anchor-name
required: true
schema:
type: string
example: my-anchor
responses:
"201":
description: Created
content:
text/plain:
schema:
type: string
example: my-resource
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400
message: Bad Request
details: The provided request is not valid
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized request
details: This request is unauthorized
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Request Forbidden
details: This request is forbidden
"409":
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 409
message: Conflicting request
details: The request cannot be processed as the resource is in use.
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
deprecated: true
/v2/dataspaces/{dataspace-name}/anchors:
post:
tags:
- cps-admin
summary: Create an anchor
description: Create a new anchor in the given dataspace
operationId: createAnchorV2
parameters:
- name: dataspace-name
in: path
description: dataspace-name
required: true
schema:
type: string
example: my-dataspace
- name: schema-set-name
in: query
description: schema-set-name
required: true
schema:
type: string
example: my-schema-set
- name: anchor-name
in: query
description: anchor-name
required: true
schema:
type: string
example: my-anchor
responses:
"201":
description: Created without response body
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400
message: Bad Request
details: The provided request is not valid
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized request
details: This request is unauthorized
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Request Forbidden
details: This request is forbidden
"409":
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 409
message: Conflicting request
details: The request cannot be processed as the resource is in use.
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
/{apiVersion}/dataspaces/{dataspace-name}/anchors:
get:
tags:
- cps-admin
summary: Get anchors
description: "Read all anchors, given a dataspace"
operationId: getAnchors
parameters:
- name: apiVersion
in: path
description: apiVersion
required: true
schema:
type: string
default: v2
enum:
- v1
- v2
- name: dataspace-name
in: path
description: dataspace-name
required: true
schema:
type: string
example: my-dataspace
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AnchorDetails'
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400
message: Bad Request
details: The provided request is not valid
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized request
details: This request is unauthorized
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Request Forbidden
details: This request is forbidden
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
/{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}:
get:
tags:
- cps-admin
summary: Get an anchor
description: Read an anchor given an anchor name and a dataspace
operationId: getAnchor
parameters:
- name: apiVersion
in: path
description: apiVersion
required: true
schema:
type: string
default: v2
enum:
- v1
- v2
- name: dataspace-name
in: path
description: dataspace-name
required: true
schema:
type: string
example: my-dataspace
- name: anchor-name
in: path
description: anchor-name
required: true
schema:
type: string
example: my-anchor
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AnchorDetails'
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400
message: Bad Request
details: The provided request is not valid
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized request
details: This request is unauthorized
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Request Forbidden
details: This request is forbidden
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
delete:
tags:
- cps-admin
summary: Delete an anchor
description: Delete an anchor given an anchor name and a dataspace
operationId: deleteAnchor
parameters:
- name: apiVersion
in: path
description: apiVersion
required: true
schema:
type: string
default: v2
enum:
- v1
- v2
- name: dataspace-name
in: path
description: dataspace-name
required: true
schema:
type: string
example: my-dataspace
- name: anchor-name
in: path
description: anchor-name
required: true
schema:
type: string
example: my-anchor
responses:
"204":
description: No Content
content: {}
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400
message: Bad Request
details: The provided request is not valid
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized request
details: This request is unauthorized
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Request Forbidden
details: This request is forbidden
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
/v1/dataspaces/{dataspace-name}/schema-sets:
post:
tags:
- cps-admin
summary: Create a schema set
description: Create a new schema set in the given dataspace
operationId: createSchemaSet
parameters:
- name: dataspace-name
in: path
description: dataspace-name
required: true
schema:
type: string
example: my-dataspace
- name: schema-set-name
in: query
description: schema-set-name
required: true
schema:
type: string
example: my-schema-set
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/MultipartFile'
required: true
responses:
"201":
description: Created
content:
text/plain:
schema:
type: string
example: my-resource
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400
message: Bad Request
details: The provided request is not valid
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized request
details: This request is unauthorized
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Request Forbidden
details: This request is forbidden
"409":
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 409
message: Conflicting request
details: The request cannot be processed as the resource is in use.
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
deprecated: true
/v2/dataspaces/{dataspace-name}/schema-sets:
post:
tags:
- cps-admin
summary: Create a schema set
description: Create a new schema set in the given dataspace
operationId: createSchemaSetV2
parameters:
- name: dataspace-name
in: path
description: dataspace-name
required: true
schema:
type: string
example: my-dataspace
- name: schema-set-name
in: query
description: schema-set-name
required: true
schema:
type: string
example: my-schema-set
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/MultipartFile'
required: true
responses:
"201":
description: Created without response body
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400
message: Bad Request
details: The provided request is not valid
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized request
details: This request is unauthorized
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Request Forbidden
details: This request is forbidden
"409":
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 409
message: Conflicting request
details: The request cannot be processed as the resource is in use.
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
/{apiVersion}/dataspaces/{dataspace-name}/schema-sets:
get:
tags:
- cps-admin
summary: Get schema sets
description: "Read all schema sets, given a dataspace"
operationId: getSchemaSets
parameters:
- name: apiVersion
in: path
description: apiVersion
required: true
schema:
type: string
default: v2
enum:
- v1
- v2
- name: dataspace-name
in: path
description: dataspace-name
required: true
schema:
type: string
example: my-dataspace
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SchemaSetDetails'
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400
message: Bad Request
details: The provided request is not valid
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized request
details: This request is unauthorized
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Request Forbidden
details: This request is forbidden
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
/{apiVersion}/dataspaces/{dataspace-name}/schema-sets/{schema-set-name}:
get:
tags:
- cps-admin
summary: Get a schema set
description: Read a schema set given a schema set name and a dataspace
operationId: getSchemaSet
parameters:
- name: apiVersion
in: path
description: apiVersion
required: true
schema:
type: string
default: v2
enum:
- v1
- v2
- name: dataspace-name
in: path
description: dataspace-name
required: true
schema:
type: string
example: my-dataspace
- name: schema-set-name
in: path
description: schema-set-name
required: true
schema:
type: string
example: my-schema-set
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SchemaSetDetails'
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400
message: Bad Request
details: The provided request is not valid
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized request
details: This request is unauthorized
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Request Forbidden
details: This request is forbidden
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
delete:
tags:
- cps-admin
summary: Delete a schema set
description: Delete a schema set given a schema set name and a dataspace
operationId: deleteSchemaSet
parameters:
- name: apiVersion
in: path
description: apiVersion
required: true
schema:
type: string
default: v2
enum:
- v1
- v2
- name: dataspace-name
in: path
description: dataspace-name
required: true
schema:
type: string
example: my-dataspace
- name: schema-set-name
in: path
description: schema-set-name
required: true
schema:
type: string
example: my-schema-set
responses:
"204":
description: No Content
content: {}
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400
message: Bad Request
details: The provided request is not valid
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized request
details: This request is unauthorized
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Request Forbidden
details: This request is forbidden
"409":
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 409
message: Conflicting request
details: The request cannot be processed as the resource is in use.
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
/v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/node:
get:
tags:
- cps-data
summary: Get a node
description: Get a node with an option to retrieve all the children for a given
anchor and dataspace
operationId: getNodeByDataspaceAndAnchor
parameters:
- name: dataspace-name
in: path
description: dataspace-name
required: true
schema:
type: string
example: my-dataspace
- name: anchor-name
in: path
description: anchor-name
required: true
schema:
type: string
example: my-anchor
- name: xpath
in: query
description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
required: false
schema:
type: string
default: /
examples:
container xpath:
value: /shops/bookstore
list attributes xpath:
value: "/shops/bookstore/categories[@code=1]"
- name: include-descendants
in: query
description: include-descendants
required: false
schema:
type: boolean
example: false
default: false
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
examples:
dataSample:
$ref: '#/components/examples/dataSample'
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400
message: Bad Request
details: The provided request is not valid
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized request
details: This request is unauthorized
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Request Forbidden
details: This request is forbidden
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
deprecated: true
x-codegen-request-body-name: xpath
/v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/node:
get:
tags:
- cps-data
summary: Get a node
description: Get a node with an option to retrieve all the children for a given
anchor and dataspace
operationId: getNodeByDataspaceAndAnchorV2
parameters:
- name: dataspace-name
in: path
description: dataspace-name
required: true
schema:
type: string
example: my-dataspace
- name: anchor-name
in: path
description: anchor-name
required: true
schema:
type: string
example: my-anchor
- name: xpath
in: query
description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
required: false
schema:
type: string
default: /
examples:
container xpath:
value: /shops/bookstore
list attributes xpath:
value: "/shops/bookstore/categories[@code=1]"
- name: descendants
in: query
description: "Number of descendants to query. Allowed values are 'none', 'all',\
\ -1 (for all), 0 (for none) and any positive number."
required: false
schema:
type: string
example: "3"
default: none
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
examples:
dataSample:
$ref: '#/components/examples/dataSample'
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400
message: Bad Request
details: The provided request is not valid
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized request
details: This request is unauthorized
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Request Forbidden
details: This request is forbidden
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
x-codegen-request-body-name: xpath
/{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes:
put:
tags:
- cps-data
summary: Replace a node with descendants
description: "Replace a node with descendants for a given dataspace, anchor\
\ and a parent node xpath"
operationId: replaceNode
parameters:
- name: apiVersion
in: path
description: apiVersion
required: true
schema:
type: string
default: v2
enum:
- v1
- v2
- name: dataspace-name
in: path
description: dataspace-name
required: true
schema:
type: string
example: my-dataspace
- name: anchor-name
in: path
description: anchor-name
required: true
schema:
type: string
example: my-anchor
- name: xpath
in: query
description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
required: false
schema:
type: string
default: /
examples:
container xpath:
value: /shops/bookstore
list attributes xpath:
value: "/shops/bookstore/categories[@code=1]"
- name: observed-timestamp
in: query
description: observed-timestamp
required: false
schema:
type: string
example: 2021-03-21T00:10:34.030-0100
requestBody:
content:
application/json:
schema:
type: object
examples:
dataSample:
$ref: '#/components/examples/dataSample'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
examples:
dataSample:
value: ""
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400
message: Bad Request
details: The provided request is not valid
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized request
details: This request is unauthorized
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Request Forbidden
details: This request is forbidden
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
post:
tags:
- cps-data
summary: Create a node
description: Create a node for a given anchor and dataspace
operationId: createNode
parameters:
- name: apiVersion
in: path
description: apiVersion
required: true
schema:
type: string
default: v2
enum:
- v1
- v2
- name: dataspace-name
in: path
description: dataspace-name
required: true
schema:
type: string
example: my-dataspace
- name: anchor-name
in: path
description: anchor-name
required: true
schema:
type: string
example: my-anchor
- name: xpath
in: query
description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
required: false
schema:
type: string
default: /
examples:
container xpath:
value: /shops/bookstore
list attributes xpath:
value: "/shops/bookstore/categories[@code=1]"
- name: observed-timestamp
in: query
description: observed-timestamp
required: false
schema:
type: string
example: 2021-03-21T00:10:34.030-0100
- name: Content-Type
in: header
description: Content type header
required: true
schema:
type: string
example: application/json
requestBody:
content:
application/json:
schema:
type: string
examples:
dataSample:
$ref: '#/components/examples/dataSample'
application/xml:
schema:
type: object
xml:
name: stores
examples:
dataSample:
$ref: '#/components/examples/dataSampleXml'
required: true
responses:
"201":
description: Created
content:
text/plain:
schema:
type: string
example: my-resource
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400
message: Bad Request
details: The provided request is not valid
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized request
details: This request is unauthorized
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Request Forbidden
details: This request is forbidden
"409":
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 409
message: Conflicting request
details: The request cannot be processed as the resource is in use.
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
delete:
tags:
- cps-data
summary: Delete a data node
description: Delete a datanode for a given dataspace and anchor given a node
xpath.
operationId: deleteDataNode
parameters:
- name: apiVersion
in: path
description: apiVersion
required: true
schema:
type: string
default: v2
enum:
- v1
- v2
- name: dataspace-name
in: path
description: dataspace-name
required: true
schema:
type: string
example: my-dataspace
- name: anchor-name
in: path
description: anchor-name
required: true
schema:
type: string
example: my-anchor
- name: xpath
in: query
description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
required: false
schema:
type: string
default: /
examples:
container xpath:
value: /shops/bookstore
list attributes xpath:
value: "/shops/bookstore/categories[@code=1]"
- name: observed-timestamp
in: query
description: observed-timestamp
required: false
schema:
type: string
example: 2021-03-21T00:10:34.030-0100
responses:
"204":
description: No Content
content: {}
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400
message: Bad Request
details: The provided request is not valid
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized request
details: This request is unauthorized
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Request Forbidden
details: This request is forbidden
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
patch:
tags:
- cps-data
summary: Update node leaves
description: Update a data node leaves for a given dataspace and anchor and
a parent node xpath. This operation is currently supported for one top level
data node only.
operationId: updateNodeLeaves
parameters:
- name: apiVersion
in: path
description: apiVersion
required: true
schema:
type: string
default: v2
enum:
- v1
- v2
- name: dataspace-name
in: path
description: dataspace-name
required: true
schema:
type: string
example: my-dataspace
- name: anchor-name
in: path
description: anchor-name
required: true
schema:
type: string
example: my-anchor
- name: xpath
in: query
description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
required: false
schema:
type: string
default: /
examples:
container xpath:
value: /shops/bookstore
list attributes xpath:
value: "/shops/bookstore/categories[@code=1]"
- name: observed-timestamp
in: query
description: observed-timestamp
required: false
schema:
type: string
example: 2021-03-21T00:10:34.030-0100
requestBody:
content:
application/json:
schema:
type: object
examples:
dataSample:
$ref: '#/components/examples/dataSample'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
examples:
dataSample:
value: ""
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400
message: Bad Request
details: The provided request is not valid
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized request
details: This request is unauthorized
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Request Forbidden
details: This request is forbidden
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
/v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes:
delete:
tags:
- cps-data
summary: Delete one or all list element(s)
description: Delete one or all list element(s) for a given anchor and dataspace
operationId: deleteListOrListElement
parameters:
- name: dataspace-name
in: path
description: dataspace-name
required: true
schema:
type: string
example: my-dataspace
- name: anchor-name
in: path
description: anchor-name
required: true
schema:
type: string
example: my-anchor
- name: xpath
in: query
description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
required: true
schema:
type: string
examples:
container xpath:
value: /shops/bookstore
list attributes xpath:
value: "/shops/bookstore/categories[@code=1]"
- name: observed-timestamp
in: query
description: observed-timestamp
required: false
schema:
type: string
example: 2021-03-21T00:10:34.030-0100
responses:
"204":
description: No Content
content: {}
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400
message: Bad Request
details: The provided request is not valid
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized request
details: This request is unauthorized
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Request Forbidden
details: This request is forbidden
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
deprecated: true
/{apiVersion}/dataspaces/{dataspace-name}/anchors/{anchor-name}/list-nodes:
put:
tags:
- cps-data
summary: Replace list content
description: "Replace list content under a given parent, anchor and dataspace"
operationId: replaceListContent
parameters:
- name: apiVersion
in: path
description: apiVersion
required: true
schema:
type: string
default: v2
enum:
- v1
- v2
- name: dataspace-name
in: path
description: dataspace-name
required: true
schema:
type: string
example: my-dataspace
- name: anchor-name
in: path
description: anchor-name
required: true
schema:
type: string
example: my-anchor
- name: xpath
in: query
description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
required: true
schema:
type: string
examples:
container xpath:
value: /shops/bookstore
list attributes xpath:
value: "/shops/bookstore/categories[@code=1]"
- name: observed-timestamp
in: query
description: observed-timestamp
required: false
schema:
type: string
example: 2021-03-21T00:10:34.030-0100
requestBody:
content:
application/json:
schema:
type: object
examples:
dataSample:
$ref: '#/components/examples/dataSample'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
examples:
dataSample:
value: ""
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400
message: Bad Request
details: The provided request is not valid
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized request
details: This request is unauthorized
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Request Forbidden
details: This request is forbidden
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
post:
tags:
- cps-data
summary: Add list element(s)
description: Add list element(s) to a list for a given anchor and dataspace
operationId: addListElements
parameters:
- name: apiVersion
in: path
description: apiVersion
required: true
schema:
type: string
default: v2
enum:
- v1
- v2
- name: dataspace-name
in: path
description: dataspace-name
required: true
schema:
type: string
example: my-dataspace
- name: anchor-name
in: path
description: anchor-name
required: true
schema:
type: string
example: my-anchor
- name: xpath
in: query
description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html"
required: true
schema:
type: string
examples:
container xpath:
value: /shops/bookstore
list attributes xpath:
value: "/shops/bookstore/categories[@code=1]"
- name: observed-timestamp
in: query
description: observed-timestamp
required: false
schema:
type: string
example: 2021-03-21T00:10:34.030-0100
requestBody:
content:
application/json:
schema:
type: object
examples:
dataSample:
$ref: '#/components/examples/dataSample'
required: true
responses:
"201":
description: Created
content:
text/plain:
schema:
type: string
example: my-resource
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400
message: Bad Request
details: The provided request is not valid
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized request
details: This request is unauthorized
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Request Forbidden
details: This request is forbidden
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
/v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query:
get:
tags:
- cps-query
summary: Query data nodes
description: Query data nodes for the given dataspace and anchor using CPS path
operationId: getNodesByDataspaceAndAnchorAndCpsPath
parameters:
- name: dataspace-name
in: path
description: dataspace-name
required: true
schema:
type: string
example: my-dataspace
- name: anchor-name
in: path
description: anchor-name
required: true
schema:
type: string
example: my-anchor
- name: cps-path
in: query
description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
required: false
schema:
type: string
default: /
examples:
container cps path:
value: //bookstore
list attributes cps path:
value: "//categories[@code=1]"
- name: include-descendants
in: query
description: include-descendants
required: false
schema:
type: boolean
example: false
default: false
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
examples:
dataSample:
$ref: '#/components/examples/dataSample'
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400
message: Bad Request
details: The provided request is not valid
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized request
details: This request is unauthorized
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Request Forbidden
details: This request is forbidden
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
deprecated: true
x-codegen-request-body-name: xpath
/v2/dataspaces/{dataspace-name}/anchors/{anchor-name}/nodes/query:
get:
tags:
- cps-query
summary: Query data nodes
description: Query data nodes for the given dataspace and anchor using CPS path
operationId: getNodesByDataspaceAndAnchorAndCpsPathV2
parameters:
- name: dataspace-name
in: path
description: dataspace-name
required: true
schema:
type: string
example: my-dataspace
- name: anchor-name
in: path
description: anchor-name
required: true
schema:
type: string
example: my-anchor
- name: cps-path
in: query
description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
required: false
schema:
type: string
default: /
examples:
container cps path:
value: //bookstore
list attributes cps path:
value: "//categories[@code=1]"
- name: descendants
in: query
description: "Number of descendants to query. Allowed values are 'none', 'all',\
\ -1 (for all), 0 (for none) and any positive number."
required: false
schema:
type: string
example: "3"
default: none
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
examples:
dataSample:
$ref: '#/components/examples/dataSample'
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400
message: Bad Request
details: The provided request is not valid
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized request
details: This request is unauthorized
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Request Forbidden
details: This request is forbidden
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
x-codegen-request-body-name: xpath
/v2/dataspaces/{dataspace-name}/nodes/query:
get:
tags:
- cps-query
summary: Query data nodes
description: Query data nodes for the given dataspace across anchors using CPS
path
operationId: getNodesByDataspaceAndCpsPath
parameters:
- name: dataspace-name
in: path
description: dataspace-name
required: true
schema:
type: string
example: my-dataspace
- name: cps-path
in: query
description: "For more details on cps path, please refer https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html"
required: false
schema:
type: string
default: /
examples:
container cps path:
value: //bookstore
list attributes cps path:
value: "//categories[@code=1]"
- name: descendants
in: query
description: "Number of descendants to query. Allowed values are 'none', 'all',\
\ -1 (for all), 0 (for none) and any positive number."
required: false
schema:
type: string
example: "3"
default: none
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
examples:
dataSample:
$ref: '#/components/examples/dataSampleAcrossAnchors'
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400
message: Bad Request
details: The provided request is not valid
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 401
message: Unauthorized request
details: This request is unauthorized
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 403
message: Request Forbidden
details: This request is forbidden
"500":
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occurred
x-codegen-request-body-name: xpath
components:
schemas:
ErrorMessage:
title: Error
type: object
properties:
status:
type: string
message:
type: string
details:
type: string
DataspaceDetails:
title: Dataspace details by dataspace Name
type: object
properties:
name:
type: string
example: my-dataspace
AnchorDetails:
title: Anchor details by anchor Name
type: object
properties:
name:
type: string
example: my-anchor
dataspaceName:
type: string
example: my-dataspace
schemaSetName:
type: string
example: my-schema-set
MultipartFile:
required:
- file
type: object
properties:
file:
type: string
description: multipartFile
format: binary
SchemaSetDetails:
title: Schema set details by dataspace and schemasetName
required:
- moduleReferences
type: object
properties:
dataspaceName:
type: string
example: my-dataspace
moduleReferences:
type: array
items:
$ref: '#/components/schemas/ModuleReferences'
name:
type: string
example: my-schema-set
ModuleReferences:
title: Module reference object
type: object
properties:
name:
type: string
example: my-module-reference-name
namespace:
type: string
example: my-module-reference-namespace
revision:
type: string
example: my-module-reference-revision
examples:
dataSample:
value:
test:bookstore:
bookstore-name: Chapters
categories:
- code: 1
name: SciFi
- code: 2
name: kids
dataSampleXml:
value: <stores xmlns="urn:ietf:params:xml:ns:netconf:base:1.0"> <bookstore xmlns="org:onap:ccsdk:sample">
<bookstore-name>Chapters</bookstore-name> <categories> <code>1</code> <name>SciFi</name>
</categories> </bookstore> </stores>
dataSampleAcrossAnchors:
value:
- anchorName: bookstore1
dataNode:
test:bookstore:
bookstore-name: Chapters
categories:
- code: 1
name: SciFi
- code: 2
name: kids
- anchorName: bookstore2
dataNode:
test:bookstore:
bookstore-name: Chapters
categories:
- code: 1
name: SciFi
- code: 2
name: kids
securitySchemes:
basicAuth:
type: http
scheme: basic