diff --git a/CHANGELOG.md b/CHANGELOG.md index 2a28a023..edcf97ab 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,7 @@ ## Table of Contents +- [v0.4.0-rc.2](#v040-rc2) - [v0.4.0-rc.1](#v040-rc1) - [v0.4.0-alpha.1](#v040-alpha1) - [v0.3.0](#v030) @@ -9,6 +10,32 @@ - [v0.1.0 - Initial version](#v010---initial-version) +# v0.4.0-rc.2 + +**This is the second Release Candidate version for Commonalities release 0.4.0.** + +It contains the following corrections compared to [v0.4.0-rc.1](#v040-rc1). + +### Added +* Error 422 UNIDENTIFIABLE_DEVICE added in API Design Guidelines and CAMARA_common.yaml by @rartych in https://github.com/camaraproject/Commonalities/pull/256 + +### Changed +* Errors in event-subscription-template.yaml aligned with CAMARA_common.yaml by @bigludo7 in https://github.com/camaraproject/Commonalities/pull/251 +* CAMARA_common.yaml - info object aligned with API Design Guidelines by @rartych in https://github.com/camaraproject/Commonalities/pull/257 +* API-DocumentationTemplate.md marked as deprecated by @rartych in https://github.com/camaraproject/Commonalities/pull/261 +* Updated event-subscription-template.yaml with attribute startsAt set optional, sinkCredential definition, and other corrections by @rartych in https://github.com/camaraproject/Commonalities/pull/267 + + +### Fixed +* API Design Guidelines - formatting corrected in section 11.6.1 by @rartych in https://github.com/camaraproject/Commonalities/pull/255 +* MNO abbreviation replaced in CAMARA_common.yaml by @rartych in https://github.com/camaraproject/Commonalities/pull/270 + +### Removed +* N/A + +**Full Changelog**: https://github.com/camaraproject/Commonalities/compare/r0.4.0-rc.1...r0.4.0-rc.2 + + # v0.4.0-rc.1 **This version introduces Event Subscription model based on [CloudEvents Subscriptions API draft](https://github.com/cloudevents/spec/blob/main/subscriptions/spec.md) and other changes to documents and artifacts approved since [v0.3.0](#v030).** diff --git a/README.md b/README.md index f40acc76..d37cac34 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,7 @@ The documents that are relevant for CAMARA API Sub Projects are found in the `do 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) +* notification subscription template: [event-subscription-template.yaml](artifacts/camara-cloudevents/event-subscription-template.yaml) * OAS definition of CAMARA Event using CloudEvents: [notification-as-cloud-event.yaml](artifacts/notification-as-cloud-event.yaml) ### Frequently-accessed output documents @@ -32,7 +33,6 @@ A list of some of the frequently accessed documents that are an output of the wo | Document name | Purpose | |-------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [API-design-guidelines.md](documentation/API-design-guidelines.md) | This document captures guidelines for the API design in CAMARA project. These guidelines are applicable to every API to be worked out under the CAMARA initiative. | -| [API-DocumentationTemplate.md](documentation/API-DocumentationTemplate.md) | Template for documenting the APIs | | [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 | @@ -41,7 +41,7 @@ NOTE: Guidelines for Release Management of API versions, e.g. the API-Readiness- ## Status and released versions -* Release 0.4.0-rc.1 of guidelines and assets for CAMARA APIs is available with the [r0.4.0-rc.1 tag](https://github.com/camaraproject/Commonalities/tree/r0.4.0-rc.1): +* Release 0.4.0-rc.2 of guidelines and assets for CAMARA APIs is available with the [r0.4.0-rc.2 tag](https://github.com/camaraproject/Commonalities/tree/r0.4.0-rc.2): * 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): diff --git a/artifacts/camara-cloudevents/event-subscription-template.yaml b/artifacts/camara-cloudevents/event-subscription-template.yaml index aff167e6..e28f39e8 100644 --- a/artifacts/camara-cloudevents/event-subscription-template.yaml +++ b/artifacts/camara-cloudevents/event-subscription-template.yaml @@ -6,18 +6,17 @@ info: Note on ``security`` - ``openId`` scope: The value in this yaml `api-name:event-type:grant-level` must be replaced accordingly to the format defined in the guideline document. - termsOfService: https://swagger.io/terms/ - contact: - email: project-email@sample.com license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 0.1.0-wip + version: 0.1.0 + x-camara-commonalities: 0.4.0 + externalDocs: description: Product documentation at CAMARA url: https://github.com/camaraproject/ servers: - - url: "{apiRoot}/{apiName}/v0" + - url: "{apiRoot}/{apiName}/v0.1" variables: apiRoot: default: http://localhost:9091 @@ -298,9 +297,7 @@ components: description: The address to which events shall be delivered using the selected protocol. example: "https://endpoint.example.com/sink" sinkCredential: - allOf: - - description: A sink credential provides authentication or authorization information necessary to enable delivery of events to a target. - - $ref: "#/components/schemas/SinkCredential" + $ref: "#/components/schemas/SinkCredential" types: description: | Camara Event types eligible to be delivered by this subscription. @@ -359,6 +356,7 @@ components: Up to API project decision to keep it. SinkCredential: + description: A sink credential provides authentication or authorization information necessary to enable delivery of events to a target. type: object properties: credentialType: @@ -452,7 +450,7 @@ components: description: The detail of the requested event subscription. type: object - Event-typeNotification: + EventTypeNotification: type: string description: | event-type - Event triggered when an event-type event occurred @@ -471,7 +469,6 @@ components: - config - types - id - - startsAt properties: protocol: $ref: "#/components/schemas/Protocol" @@ -556,7 +553,7 @@ components: source: $ref: "#/components/schemas/Source" type: - $ref: "#/components/schemas/Event-typeNotification" + $ref: "#/components/schemas/EventTypeNotification" specversion: type: string description: Version of the specification to which this event conforms (must be 1.0 if it conforms to cloudevents 1.0.2 version)