From da6c62ff6602af2e54767cd3b4badf826df42bc6 Mon Sep 17 00:00:00 2001 From: Bruno Sakoto Date: Tue, 15 Mar 2022 09:49:31 -0400 Subject: [PATCH] Create primary documentation for Jakarta release * Update release notes (using cps table data template) * Update openapi documentation Issue-ID: CPS-935 Signed-off-by: Bruno Sakoto Change-Id: Ibe7f125862379e9bb39b201e60521cc4cb24a0e2 --- docs/_static/openapi/swagger/openapi.yml | 16 ++---------- docs/content/release-notes.rst | 42 +++++++++++++++++--------------- 2 files changed, 24 insertions(+), 34 deletions(-) diff --git a/docs/_static/openapi/swagger/openapi.yml b/docs/_static/openapi/swagger/openapi.yml index 7c7a10d..a96947b 100644 --- a/docs/_static/openapi/swagger/openapi.yml +++ b/docs/_static/openapi/swagger/openapi.yml @@ -75,14 +75,14 @@ paths: anchor: my-anchor data: status: UP + + '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' - '500': - $ref: '#/components/responses/InternalServerError' '/v1/dataspaces/{dataspace-name}/anchors/history': get: description: 'Read anchors data based on filter criteria provided in query parameters' @@ -128,8 +128,6 @@ paths: $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' - '500': - $ref: '#/components/responses/InternalServerError' components: parameters: dataspaceName: @@ -219,16 +217,6 @@ components: status: 403 message: Forbidden error message details: Forbidden error details - InternalServerError: - description: Internal Server Error - content: - application/json: - schema: - $ref: "#/components/schemas/ErrorMessage" - example: - status: 500 - message: Internal Server Error - details: Internal Server Error occurred schemas: AnchorDetails: type: object diff --git a/docs/content/release-notes.rst b/docs/content/release-notes.rst index 923cd00..39a5f1f 100644 --- a/docs/content/release-notes.rst +++ b/docs/content/release-notes.rst @@ -16,19 +16,29 @@ CPS Temporal Release Notes .. * * * JAKARTA * * * .. ======================== -Version: 1.1.0-SNAPSHOT -======================= +Version: 1.1.0 +============== + +.. table:: -This section lists the main changes & fixes merged into master (snapshot) version of CPS-Temporal. This information is here to assist developers that want experiment/test using our latest code bases directly. Stability of this is not guaranteed. + =============================== =============================== + **Docker Image** onap/cps-temporal:1.1.0 + **Designation** 1.1.0 Jakarta + **Date** 2022 March 15 + =============================== =============================== Features -------- -* None + +* `CPS-747 `_ - Add support for Data Deletion Events +* `CPS-482 `_ - Add CSIT tests Bug Fixes --------- - - `CPS-841 `_ Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM +* `CPS-820 `_ - Upgrade log4j to 2.16.0 +* `CPS-841 `_ - Upgrade log4j to 2.17.1 as recommended by ONAP SECCOM +* `CPS-905 `_ - Fix Docker images for CSIT tests .. ======================== .. * * * ISTANBUL * * * @@ -37,16 +47,12 @@ Bug Fixes Version: 1.0.1 ============== -* Release Date: 2021-01-06 (Istanbul) - -Artifacts released ------------------- - .. table:: =============================== =============================== - **Repository** **Docker Image** - onap/cps-temporal onap/cps-temporal:1.0.1 + **Docker Image** onap/cps-temporal:1.0.1 + **Designation** 1.0.1 Istanbul + **Date** 2021 January 6 =============================== =============================== Features @@ -56,21 +62,17 @@ Features Bug Fixes --------- - - `CPS-841 `_ Update log4j version to 2.17.1 due to security vulnerability +* `CPS-841 `_ - Update log4j version to 2.17.1 due to security vulnerability Version: 1.0.0 ============== -* Release Date: 2021-09-14 (Istanbul) - -Artifacts released ------------------- - .. table:: =============================== =============================== - **Repository** **Docker Image** - onap/cps-temporal onap/cps-temporal:1.0.0 + **Docker Image** onap/cps-temporal:1.0.0 + **Designation** 1.0.0 Istanbul + **Date** 2021 September 14 =============================== =============================== New features -- 2.16.6