This version introduces Event Subscription model based on CloudEvents Subscriptions API draft and other changes to documents and artifacts approved since v0.3.0.
This is ALPHA version for Commonalities release 0.4.0. The following changes are expected to be added in the Release Candidate:
- Error model alignment PR#213
- Enhance API-Testing-Guidelines.md PR#203
- API Design Guidelines chapter 11: 'info' object, 'servers' object and cleanup PR#214
- Alignment with ICM and Release Management
The content of the release includes:
- Commonalities approved deliverables in documentation folder
- Commonalities approved artifacts in artifacts folder
- Usage and style of operation tags in API Design Guidelines by @rartych in camaraproject#152
- x-correlator support in notifications in API Design Guidelines by @PedroDiez in camaraproject#170
- Create subscription-notification-template.yaml by @bigludo7 in camaraproject#189
- Added a different scope naming format for APIs that deal with explicit subscriptions by @shilpa-padgaonkar in camaraproject#177
- API Design Guidelines updated with subscriptionMaxEvents by @bigludo7 in camaraproject#131
- 'specversion' in CloudEvents as enum by @PedroDiez in camaraproject#187
- 'datacontenttype' in CloudEvents as enum by @PedroDiez in camaraproject#193
- API Design Guidelines updated on x-correlator format by @PedroDiez in camaraproject#194
- API Design Guidelines for Notification Subscription by @bigludo7 in camaraproject#198
- API Design Guidelines updated on scope definition including wildcard scopes by @shilpa-padgaonkar in camaraproject#221
- API Design Guidelines updated with character set guidance by @trehman-gsma in camaraproject#143
- Mandated '+' in all phoneNumber formats by @fernandopradocabrillo in camaraproject#148
- Linting rules problem with Traffic Influence API #161 by @VijayKesharwani in camaraproject#169
- CAMARA_common.yaml - bugs and typos fix by @fernandopradocabrillo in camaraproject#174
- API Design Guidelines updated on HTTPs usage by @AxelNennker in camaraproject#205
- Artifacts aligned with API Design Guidelines for Notification Subscription by @PedroDiez in camaraproject#219
- Removed UUID pattern for x-correlator by @jlurien in camaraproject#168
Full Changelog: https://github.com/camaraproject/Commonalities/compare/v0.3.0...r0.4.0-alpha.1
This version introduces API Testing Guidelines and initial linting ruleset and other changes to documents and artifacts approved since v0.2.0.
The content of the release includes:
- Commonalities approved deliverables in documentation folder
- Commonalities approved artifacts in artifacts folder
- API Testing Guidelines created by @shilpa-padgaonkar in camaraproject#117
- API Design Guidelines updated with scopes naming guidelines by @jlurien in camaraproject#57
- API Linting Rules - initial linting ruleset description by @rartych in camaraproject#74
- API linting implementation and guidelines by @ravindrapalaskar17 in camaraproject#110
-
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 camaraproject#107
-
X-Correlator header as required in OAS definition, X-Version removed from API Design Guidelines by @jlurien in camaraproject#115
-
Filtering criteria in API Design Guidelines changed by @RubenBG7 in camaraproject#132
- CAMARA_common.yaml - error response codes updated by @RubenBG7 in camaraproject#124
- API Design Guidelines updated on response filtering by @rartych in camaraproject#123
- API-exposure-reference-solution.docx removed from documentation/SupportingDocuments by @jordonezlucena in camaraproject#104
Full Changelog: https://github.com/camaraproject/Commonalities/compare/v0.2.0...v0.3.0
This version introduces CloudEvents format to CAMARA Events and other changes to documents and artifacts approved since v0.1.0.
The content of the release includes:
- Commonalities approved deliverables in documentation folder
- Commonalities approved artifacts in artifacts folder
- New: OAS definition of CAMARA Event using CloudEvents: notification-as-cloud-event.yaml
- Added reserved word restrictions to API Design Guidelines by @eric-murray in camaraproject#49
- Explicitly indicated use of RFC3339 for DateTime attributes by @patrice-conil in camaraproject#55
- Usage of discriminator: Encourage inheritance rather than polymorphism by @patrice-conil in camaraproject#22
- Use ObjectName as discriminator's mapping key by @patrice-conil in camaraproject#78
- OAS definition of CAMARA Event using Cloudevents in artifacts: notification-as-cloud-event.yaml by @patrice-conil in camaraproject#43
- Updated API Design Guidelines with use of callbacks & cloudEvents by @bigludo7 in camaraproject#56
- Updated Architecture headers in API Design Guidelines by @eric-murray in camaraproject#88
- Fixed code typos in API Design Guidelines section 11.5.1 code sample by @Kevsy in camaraproject#48
- Correction of format and typos by @dfischer-tech in camaraproject#79
- Improved discovery of Commonalities output documents by API Subprojects by @rkandoi in camaraproject#73
- Updated references in UE-Identification.md by @gmuratk in camaraproject#95
- Minor changes needed in API Design Guidelines for CloudEvents by @rartych in camaraproject#86
- Filtering GET results - updated section 8.3 in API Design Guidelines by @rartych in camaraproject#82
- Removed option to use HTTP HEAD from API-design-guidelines.md by @eric-murray in camaraproject#50
Full Changelog: https://github.com/camaraproject/Commonalities/compare/v0.1.0...v.0.2.0
Initial version of guidelines and assets based on the work done in Commonalities WG.
The content of the release includes:
- Commonalities approved deliverables in documentation folder:
- API-Readiness-Checklist.md - A checklist to ensure minimum readiness of the API
- API-design-guidelines.md - API design guidelines -the main document with guidelines for the API design in CAMARA project. These guidelines are applicable to every CAMARA API;
- Camara_Versioning_Guidelines.md - Guidelines to create CAMARA subproject releases
- Glossary.md - Glossary of terms and common parameter/field names to be used in every CAMARA API
- Issue and PR template Howto.md - Instruction for use of Github templates for issues and pull request for CAMARA repositories
- UE-Identification.md - an overview of methods that a 5G Core network has for enabling external parties to identify UEs in the network
- Userstory-template.md - the template for documenting user stories related to API families in CAMARA project
- API-DocumentationTemplate.md- API documentation template - currently obsoleted by embedding documentation into OAS YAML files
- Commonalities approved artifacts in artifacts folder:
- CAMARA_common.json - Common data and errors for CAMARA APIs in JSON file
- Github_templates -
.githubfolder with Github templates for issues and pull request