Analysis of 0.5.0-alpha.1 changes

Changelog

Release PR ready for final review, main CHANGELOG points:

• Added

  • Common 'area' data-type added to CAMARA_common.yaml by @tlohmar in #315

  • Security and Privacy Considerations for Filtering in API Design Guidelines by @rartych in #331

  • Security scheme added to CAMARA_common.yaml by @rartych in #335

  • VERSION.yaml file added to indicate Commonalities version by @rartych in #339

  • Filtering for boolean guideline and examples in API Design Guidelines by @rartych in #336

  • Guidelines on the coverage of error codes in API-Testing-Guidelines by @jlurien in #343

• Changed

  • Normalization of error status and code allowed values using enum by @PedroDiez in #316

  • Guidelines for subscription and event notification in API Design Guideliness by @bigludo7 in #313 main changes:

    • updated terminationReason in event notification type "subscription-ends"

    • updated description of sink and sinkCredential attributes for subscription

    • added rules for subscriptions with device identifier attribute

    • added section 11.7 Resource access restriction relevant to subscriptions

    • added clarification on expiresAt attribute for subscription

  • Updated error codes and changed info.description template for device / phone number identifiers in Appendix A in API Design Guideliness by @eric-murray in #324

  • Guidelines regarding mandatory error status and alignment of error codes related to identifiers in API Design Guideliness by @PedroDiez in #329

• Fixed

  • Clarification on api-name, filenames and servers object by @rartych in #333

  • Removed broken link to DPV document and updated broken links to CAMARA wiki by @rartych in #347

Analysis

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.

  application/json:
    schema:
      allOf:
        - $ref: "#/components/schemas/ErrorInfo"
        - type: object
          properties:
            status:
              enum:
                - <status>
            code:
              enum:
                - <code1>
                - <code2>

• To be added before RC:

  • Remaining PRs:

    • https://github.com/camaraproject/Commonalities/pull/277

    • https://github.com/camaraproject/Commonalities/pull/325

    • https://github.com/camaraproject/Commonalities/pull/330

  • Cleanup and slim down design guidelines document

  • Linting rules update

  • Corrections to alpha version