Commonalities release 0.4.0 scope

[rartych]

Problem description
The next release of Commonalities should be the base for Fall24 CAMARA meta-release.

Expected action
The M0 milestone (scope definition of the release should be achieved in the next Commonalities meeting on 15/04

Additional context

The timeline for Fall24 - https://wiki.camaraproject.org/display/CAM/Meta-release+Fall24

[jlurien]

Hi @rartych,

If I understood correctly, M0 it is the kick-off milestone. The definition of scope should be achieved by M1 (Agree on the scope of commonalities.).
https://wiki.camaraproject.org/display/CAM/CAMARA+Release+Process

[PedroDiez]

Hi,

One doubt, which would be the way of working(*) to settle initial the list of functionalities (scope) to be included within a given Release?

• Commonalities
• I&CM
• Every WG

(*) With way of working I refer to specific "documentation" it has to be considered:

• List the Issues that want to be covered and, if wanted to cover new Issues to be generated before the Milestone X?
• Also consider Existing PRs?
• Any other considerations?

[rartych]

Current status in the comment below

NOTE: Updated by @shilpa-padgaonkar based on the results of https://wiki.camaraproject.org/display/CAM/2024-04-29+Commonalities+WG+Minutes

With previous releases we have used list of issues and PRs that should be resolved within given release. So currently we have following topics:

• Error responses

  • PR Added 501 Not Supported error response #145
  • Issue Which error send back when issue with Device Identifier provided by the API Consumer? #127
  • Issue API Design : UNAUTHENTICATED 401  #128
  • Issue Add reference documentation link to error responses #156
  • Issue Revision of Chapter 6 Error Responses in API Design Guidelines #180

• Test definitions

  • Issue Enhancement of the Testing Guidelines #158

• Evolved model of event subscription

  • Issue Consolidated issue for subscription discussion #149 :
  • Issue Common proposal to tackle subscription-based open issues. #185
  • PR Create subscription-notification-template.yaml #189
  • PR update-design-doc-with-explicit-sub-scope-changes #177
  • Issue Using CloudEvents extension Authcontext for certain event types #150
  • Issue Copy CloudEvents extension Authcontext also for explicit subscriptions  #151
  • Issue Subscription-Issue1: A common way to manage lifecycle of subscriptions #153
  • Issue Subscription-Issue2: Allow event consumers to subscribe to more than one event types with a single subscription #154
  • Issue Subscription-Issue3: Support filter option for subscriptions #155
  • Issue Add initialEvent management in subscription #140

• Event notifications

  • Issue x-correlator_support_guidelines_in_notifications #170
  • Issue Align Common Design Model for Cloud Event specversion field in APIs Design #176

• CAMARA_common.yaml cleanup

  • PR Update CAMARA_common.yaml: add Device headers, fix address #120
  • PR Remove pattern UUID for x-correlator #168
  • PR CAMARA_common.yaml bugs and typos fix #174
  • Issue Revise the device object definition to simplify it #171

• Other issues

  • Issue X-Correlator or x-correlator #191
  • Issue Common Design Model for Cloud Event datacontenttype field #192
  • Issue Update of linting ruleset #188

(The release management issues are driven from the release management WG)

• Release Management issues
  • Issue Add guidance for Info object in apis
  • Issue Readiness Checklist step 6 update proposal
  • Issue API Versioning - Aggregation
  • Issue How to manage version for a API family release
  • Issue Remove basePath in servers.url as variable
  • Issue Deprecate API-Readiness-Checklist.md

The scope should be agreed in Commonalities by M1 (30/04), but I think it should be ready for review by TSC (18/04).

[PedroDiez]

Would also like to propose:

• Issue x-correlator_support_guidelines_in_notifications #170
• Issue Revise the device object definition to simplify it #171
• Issue Align Common Design Model for Cloud Event specversion field in APIs Design #176

[eric-murray]

I would exclude #156 from the scope of v0.4.0 as I don't see any consensus being reached on that issue.

[rartych]

@PedroDiez @eric-murray I have modified the list in #175 (comment) according to your comments.

[shilpa-padgaonkar]

Based on #185 , we should exclude #150 #151

[PedroDiez]

Would make sense to consider within Release 0.4.0?
#188
#191
#192

+1 from TEF side

[hdamker]

From TSC meeting minutes of May 2nd:

• In the commonalities call on 29.04 2024-04-29 Commonalities WG Minutes, the scope of 0.4.0 has been finalized and includes the below topics
  • Error responses
  • Enhancement of Test Definitions
  • Subscriptions
  • Linting ruleset update
  • Wildcard scopes
  • Few other smaller issues
• Some issues have been labelled as backlog to keep them out of scope of 0.4.0

This scope is now reflected within #175 (comment)

[rartych]

Updated list of scope topics (points removed from the scope are deleted, PRs solving issues are added):

• Error responses

  • PR Added 501 Not Supported error response #145
  • PR error_model_alignment #213
    • Issue Which error send back when issue with Device Identifier provided by the API Consumer? #127
    • Issue API Design : UNAUTHENTICATED 401  #128
    • Issue Revision of Chapter 6 Error Responses in API Design Guidelines #180

• Test definitions

  • PR Enhance API-Testing-Guidelines.md #203
    • Issue Enhancement of the Testing Guidelines #158

• Evolved model of event subscription

  • Issue Consolidated issue for subscription discussion #149 :
    • Issue Common proposal to tackle subscription-based open issues. #185
    • PR Create subscription-notification-template.yaml #189
    • PR Update API-design-guidelines for subscription #198
    • PR update-design-doc-with-explicit-sub-scope-changes #177
    • Issue Subscription-Issue1: A common way to manage lifecycle of subscriptions #153
    • Issue Subscription-Issue2: Allow event consumers to subscribe to more than one event types with a single subscription #154
    • Issue Subscription-Issue3: Support filter option for subscriptions #155
    • Issue Add initialEvent management in subscription #140

• Wildcard scope

  • Issue Clear documentation on the use of wildcard scope in Camara #184

• Event notifications

  • Issue x-correlator_support_guidelines_in_notifications #170
  • Issue Align Common Design Model for Cloud Event specversion field in APIs Design #176

• CAMARA_common.yaml cleanup

  • PR Update CAMARA_common.yaml: add Device headers, fix address #120
  • PR Remove pattern UUID for x-correlator #168
  • PR CAMARA_common.yaml bugs and typos fix #174
  • Issue Revise the device object definition to simplify it #171

• Other issues

  • Issue X-Correlator or x-correlator #191
    • PR x-correlator_guideline_format_convention #194
  • Issue Common Design Model for Cloud Event datacontenttype field #192
    • PR guideline_for_datacontenttype_cloudevent_concept_as_enum #193
  • Issue Update of linting ruleset #188

(The release management issues are driven from the release management WG)

• Release Management issues
  • Issue Add guidance for Info object in apis #201
    • PR API Design Guidelines chapter 11: 'info' object, 'servers' object and cleanup  #214
  • Issue Readiness Checklist step 6 update proposal
    • Add API-Readiness-Checklist.md to RM project
  • Issue API Versioning - Aggregation
    • PR Update versioning section in api design guidelines #215
  • Issue How to manage version for a API family release
    • New proposal how to manage "API Families" as Sub Projects with one lead repository and multiple API "family member" repositories
  • Issue Remove basePath in servers.url as variable #199
    • PR API Design Guidelines chapter 11: 'info' object, 'servers' object and cleanup  #214
  • Issue Deprecate API-Readiness-Checklist.md #202
    • PR Deprecate API-Readiness-Checklist.md #220

Device object simplification

• Revise the device object definition to simplify it #171