diff options
| author |   Daniel Hanrahan <daniel.hanrahan@est.tech> | 2025-01-23 15:20:19 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@onap.org> | 2025-01-23 15:20:19 +0000 |
| commit | ed797d4a340ed145c71ae2cd805b823b26228304 (patch) | |
| tree | 0fb0b626000ce3db9613113ff2f05ecba5314ff5 /docs/api | |
| parent | 31d8f390389b9078a2f0cddca3f4b4b1cd63753a (diff) | |
| parent | bfd35a4539088ea6aa7773ab4d80d4422b9e22a7 (diff) | |
Merge "Add DB Clean-up to CPS Rest Interface"
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/swagger/cps/openapi.yaml | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/docs/api/swagger/cps/openapi.yaml b/docs/api/swagger/cps/openapi.yaml index c84609b638..330c2ca7f7 100644 --- a/docs/api/swagger/cps/openapi.yaml +++ b/docs/api/swagger/cps/openapi.yaml @@ -330,6 +330,65 @@ paths: summary: Get a dataspace tags: - cps-admin + /{apiVersion}/admin/dataspaces/{dataspace-name}/actions/clean: + post: + description: Clean the dataspace (remove orphaned modules) + operationId: cleanDataspace + parameters: + - description: apiVersion + in: path + name: apiVersion + required: true + schema: + default: v2 + enum: + - v1 + - v2 + type: string + - description: dataspace-name + in: path + name: dataspace-name + required: true + schema: + example: my-dataspace + 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 + "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: Clean the dataspace + tags: + - cps-admin /v1/dataspaces/{dataspace-name}/anchors: post: deprecated: true |