diff --git a/CHANGELOG.md b/CHANGELOG.md index f5bd9ea3..b266e54d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,9 +2,51 @@ ## Table of Contents +- [v0.3.0](#v030) - [v0.2.0](#v020) - [v0.1.0 - Initial version](#v010---initial-version) +# v0.3.0 + +**This version introduces API Testing Guidelines and initial linting ruleset and other changes to documents and artifacts approved since v0.2.0.** + +## Please note: +The content of the release includes: +* Commonalities approved deliverables in **[documentation](https://github.com/camaraproject/Commonalities/tree/release-0.3.0/documentation)** folder + - **New:** + - [API Testing Guidelines](https://github.com/camaraproject/Commonalities/blob/release-0.3.0/documentation/API-Testing-Guidelines.md) + - [API Linting Rules](https://github.com/camaraproject/Commonalities/blob/release-0.3.0/documentation/Linting-rules.md) + - [OpenAPI Linting Rules Implementaion Guideline](https://github.com/camaraproject/Commonalities/blob/release-0.3.0/documentation/API-linting-Implementation-Guideline.md) +* Commonalities approved artifacts in **[artifacts](https://github.com/camaraproject/Commonalities/tree/release-0.3.0/artifacts)** folder + - **New:** + - [CAMARA_common.yaml](https://github.com/camaraproject/Commonalities/blob/release-0.3.0/artifacts/CAMARA_common.yaml) + - [Linting rules implementation files](https://github.com/camaraproject/Commonalities/tree/release-0.3.0/artifacts/linting_rules) + +### Added +* API Testing Guidelines created by @shilpa-padgaonkar in https://github.com/camaraproject/Commonalities/pull/117 +* API Design Guidelines updated with scopes naming guidelines by @jlurien in https://github.com/camaraproject/Commonalities/pull/57 +* API Linting Rules - initial linting ruleset description by @rartych in https://github.com/camaraproject/Commonalities/pull/74 +* API linting implementation and guidelines by @ravindrapalaskar17 in https://github.com/camaraproject/Commonalities/pull/110 + +### Changed +* CAMARA_common.yaml includes the following changes: + - CAMARA_common.json was changed to CAMARA_common.yaml to be consistent with all CAMARA API specs + - Includes guidance for info object + - Adds the aligned device schema updated by @shilpa-padgaonkar in https://github.com/camaraproject/Commonalities/pull/107 + +* X-Correlator header as required in OAS definition, X-Version removed from API Design Guidelines by @jlurien in https://github.com/camaraproject/Commonalities/pull/115 +* Filtering criteria in API Design Guidelines changed by @RubenBG7 in https://github.com/camaraproject/Commonalities/pull/132 + +### Fixed +* CAMARA_common.yaml - error response codes updated by @RubenBG7 in https://github.com/camaraproject/Commonalities/pull/124 +* API Design Guidelines updated on response filtering by @rartych in https://github.com/camaraproject/Commonalities/pull/123 + +### Removed +* API-exposure-reference-solution.docx removed from documentation/SupportingDocuments by @jordonezlucena in https://github.com/camaraproject/Commonalities/pull/104 + +**Full Changelog**: https://github.com/camaraproject/Commonalities/compare/v0.2.0...v0.3.0 + + # v0.2.0 **This version introduces CloudEvents format to CAMARA Events and other changes to documents and artifacts approved since v0.1.0.** diff --git a/README.md b/README.md index 68c7211a..43a40615 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,10 @@ Repository to describe and document common guidelines and assets for CAMARA APIs The documents that are relevant for CAMARA API Sub Projects are found in the `documentation` directory (at the top-level). The rest of the sub-directories are primarily for internal working of the Commonalities Working Group. -The `artifacts` directory contains templates for creating Github issues and Common data and error formats for CAMARA APIs. +The `artifacts` directory contains: +* templates for creating Github issues +* common data and error formats for CAMARA APIs in [CAMARA_common.yaml](artifacts/CAMARA_common.yaml) +* OAS definition of CAMARA Event using CloudEvents: [notification-as-cloud-event.yaml](artifacts/notification-as-cloud-event.yaml) ### Frequently-accessed output documents @@ -32,11 +35,13 @@ A list of some of the frequently accessed documents that are an output of the wo | [API-Readiness-Checklist.md](documentation/API-Readiness-Checklist.md) | A checklist that describes the minimum criteria for considering an API Ready | | [Camara_Versioning_Guidelines.md](documentation/Camara_Versioning_Guidelines.md) | Guidelines for API Subprojects on making releases | | [Glossary.md](documentation/Glossary.md) | A glossary of the common terms and their API parameter/field names for use in the APIs | - +| [API-Testing-Guidelines.md](documentation/API-Testing-Guidelines.md) | Guidelines for the API testing in CAMARA project + | ## Status and released versions +* Release 0.3.0 of guidelines and assets for CAMARA APIs is available within the [release-0.3.0 branch](https://github.com/camaraproject/Commonalities/tree/release-0.3.0): * Release 0.2.0 of guidelines and assets for CAMARA APIs is available within the [release-0.2.0 branch](https://github.com/camaraproject/Commonalities/tree/release-0.2.0): * Release 0.1.0 of guidelines and assets for CAMARA APIs is available within the [release-0.1.0 branch](https://github.com/camaraproject/Commonalities/tree/release-0.1.0):