(DRAFT)
Changelog
Main CHANGELOG points for 0.5.0-alpha.1:
...
This sections presents of main changes that need to be introduced in API definitions and analysis of impact of changes.
Release Management guidelines on breaking and non-breaking changes.
PR | Changes | Breaking change for Required changes in OAS | Breaking change for API Provider implementation | Breaking change for API Client implementation | |||||
---|---|---|---|---|---|---|---|---|---|
Common 'area' data-type added to CAMARA_common.yaml #315 | The Area datatype is defined as follows: https://github.com/camaraproject/Commonalities/blob/main/artifacts/CAMARA_common.yaml#L134-L220 | If currently different Area definitions is used: YES | If currently different Area definitions is used: YES | If currently different Area definitions is used: YES | |||||
Normalization of error status and code allowed values using | Error Responses should be defined as follows:
| YES | NO | NO | |||||
Error | If Error | If Error | If Error status is currently used in implementation logic : YES | ||||||
Guidelines for subscription and event notification in API Design Guidelines | updated
| If | If | If | |||||
It is recommended to provide clarification in all subscription APIs featuring | For APIs featuring | For APIs featuring | NO | ||||||
Rules for subscriptions data minimization | NO | NO | NO | ||||||
11.7 Resource access restriction | Potentially YES | Potentially YES | Potentially YES | ||||||
The | Potentially YES | Potentially YES | Potentially YES | ||||||
added clarification on | Potentially YES | Potentially YES | Potentially YES | ||||||
Updated error codes and changed | Use new | For APIs using Device object or phoneNumber as identifier: YES | For APIs using Device object or phoneNumber as identifier: YES | For APIs using Device object or phoneNumber as identifier: potentially YES | |||||
Error codes changed:
| For APIs using Device object or phoneNumber as identifier: YES | For APIs using Device object or phoneNumber as identifier: YES | For APIs using Device object or phoneNumber as identifier: potentially YES | ||||||
Guidelines regarding mandatory error | Error codes changed:
| For APIs using Device object or phoneNumber as identifier: YES | For APIs using Device object or phoneNumber as identifier: YES | For APIs using Device object or phoneNumber as identifier: potentially YES | |||||
Mandatory Errors to be documented in CAMARA API Spec YAML:
For event subscription/notification - see Section 12.1 and 12.2 of API Design Guidelines Errors not needneeded to be documented:
| YESYES | NO | Potentially YES | ||||||
Guidelines on the coverage of error codes in API-Testing-Guidelines #343 | For test plans:
| NO (test plans) | NO | NO |
Note: The changes listed in Changes column are just indicative - always double check each requirement in API Design Guidelines.
Further changes expected
To be added before RC:
...