diff options
Diffstat (limited to 'docs/api/swagger')
| -rw-r--r-- | docs/api/swagger/cps/openapi.yaml | 222 |
1 files changed, 222 insertions, 0 deletions
diff --git a/docs/api/swagger/cps/openapi.yaml b/docs/api/swagger/cps/openapi.yaml index f6baadc8ea..154548797b 100644 --- a/docs/api/swagger/cps/openapi.yaml +++ b/docs/api/swagger/cps/openapi.yaml @@ -2562,6 +2562,208 @@ paths: tags: - cps-query x-codegen-request-body-name: xpath + /v2/notification-subscription: + delete: + description: Delete cps notification subscription + operationId: deleteNotificationSubscription + parameters: + - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html" + examples: + subscription by dataspace xpath: + value: "/dataspaces/dataspace[@name='dataspace01']" + subscription by anchor xpath: + value: "/dataspaces/dataspace[@name='dataspace01']/anchors/anchor[@name='anchor01']" + in: query + name: xpath + required: true + schema: + default: /dataspaces + type: string + responses: + "204": + content: {} + description: No Content + "400": + content: + application/json: + example: + status: 400 + message: Bad Request + details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request + "403": + content: + application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden + "409": + content: + application/json: + example: + status: 409 + message: Conflicting request + details: The request cannot be processed as the resource is in use. + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Conflict + "500": + content: + application/json: + example: + status: 500 + message: Internal Server Error + details: Internal Server Error occurred + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Delete cps notification subscription + tags: + - cps-admin + get: + description: Get cps notification subscription + operationId: getNotificationSubscription + parameters: + - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html" + examples: + subscription by dataspace xpath: + value: "/dataspaces/dataspace[@name='dataspace01']" + subscription by anchor xpath: + value: "/dataspaces/dataspace[@name='dataspace01']/anchors/anchor[@name='anchor01']" + in: query + name: xpath + required: true + schema: + default: /dataspaces + type: string + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationSubscriptionsDataSample' + description: OK + "400": + content: + application/json: + example: + status: 400 + message: Bad Request + details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request + "403": + content: + application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden + "409": + content: + application/json: + example: + status: 409 + message: Conflicting request + details: The request cannot be processed as the resource is in use. + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Conflict + "500": + content: + application/json: + example: + status: 500 + message: Internal Server Error + details: Internal Server Error occurred + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Get cps notification subscription + tags: + - cps-admin + post: + description: Create cps notification subscription + operationId: createNotificationSubscription + parameters: + - description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html" + examples: + subscription by dataspace xpath: + value: "/dataspaces/dataspace[@name='dataspace01']" + subscription by anchor xpath: + value: "/dataspaces/dataspace[@name='dataspace01']/anchors/anchor[@name='anchor01']" + in: query + name: xpath + required: true + schema: + default: /dataspaces + type: string + requestBody: + content: + application/json: + examples: + dataSample: + $ref: '#/components/examples/NotificationSubscriptionsDataSample' + value: null + schema: + type: object + required: true + responses: + "201": + description: Created without response body + "400": + content: + application/json: + example: + status: 400 + message: Bad Request + details: The provided request is not valid + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Bad Request + "403": + content: + application/json: + example: + status: 403 + message: Request Forbidden + details: This request is forbidden + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Forbidden + "409": + content: + application/json: + example: + status: 409 + message: Conflicting request + details: The request cannot be processed as the resource is in use. + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Conflict + "500": + content: + application/json: + example: + status: 500 + message: Internal Server Error + details: Internal Server Error occurred + schema: + $ref: '#/components/schemas/ErrorMessage' + description: Internal Server Error + summary: Create cps notification subscription + tags: + - cps-admin components: examples: dataSample: @@ -2615,6 +2817,12 @@ components: name: SciFi - code: 2 name: kids + NotificationSubscriptionsDataSample: + value: + cps-notification-subscriptions:dataspaces: + dataspace: + - name: dataspace01 + - name: dataspace02 parameters: dataspaceNameInQuery: description: dataspace-name @@ -2795,6 +3003,19 @@ components: schema: example: 10 type: integer + notificationSubscriptionXpathInQuery: + description: "For more details on xpath, please refer https://docs.onap.org/projects/onap-cps/en/latest/xpath.html" + examples: + subscription by dataspace xpath: + value: "/dataspaces/dataspace[@name='dataspace01']" + subscription by anchor xpath: + value: "/dataspaces/dataspace[@name='dataspace01']/anchors/anchor[@name='anchor01']" + in: query + name: xpath + required: true + schema: + default: /dataspaces + type: string responses: Created: content: @@ -2956,6 +3177,7 @@ components: type: string title: Module reference object type: object + NotificationSubscriptionsDataSample: {} getDeltaByDataspaceAnchorAndPayload_request: properties: json: |