Commonalities 0.5.0 - prepare the scope

[rartych]

Problem description
This issue should serve for collecting topics to be addressed by next release of Commonalities.
Please add your proposals in the comments and open issues if needed.

Expected action
Proposed topics:

• Device identification
• Error responses
  • Proposal to add error response for not supported method for phone number #138
    • Enhancements and Alignments in Errors #329
  • Add reference documentation link to error responses #156
    • Closed as no interest
  • Specify allowed values for error status and code in the error schema #196
    • Normalization of error status and code allowed values #316
  • API misuse #259
    • Update error codes and info.description template for device / phone number identifiers #324
  • Inconsistent statements about 405 status code in API Guidelines and CAMARA_common.yaml #285
    • Enhancements and Alignments in Errors #329
  • Support & Aligment of 504 Exception in CAMARA APIs  #308
    • Enhancements and Alignments in Errors #329
• Guidelines to improve security of APIs and notifications
  • remove empty security scheme #204
    • $\color{BurntOrange}{\textsf{no consensus}}$
  • Create a meaningful security-considerations section #218
    • Update Subscription Security Considerations #277
• Refinement of API Design Guidelines
  • Specify string format whenever possible #93
    • String format/pattern recommendation #330
  • Security and Privacy Considerations for Filtering #99
    • Security and Privacy Considerations for Filtering #331
  • Filtering for data type "boolean" #130
    • Filtering for boolean #336
  • Do not _extract_ the device identification from the access token #268
    • Update error codes and info.description template for device / phone number identifiers #324
  • Missing guideline for file names of API definition files - mixed use of snake_case and kebab-case #284
    • Clarification on api-name, filenames and servers object #333
  • Guidelines for asynchronous response in callback #297
    • $\color{BurntOrange}{\textsf{no feedback}}$
  • Further clarifying statement for api-name #298
    • Clarification on api-name, filenames and servers object #333
  • Support of Multi-SIM lines in CAMARA APIs #302
    • $\color{BurntOrange}{\textsf{no decision}}$
  • Cleanup and slim down design guidelines document #306
    • $\color{green}{\textsf{to be resolved after updating guidelines (after alpha release)}}$
  • Create a CAMARA cheatsheet.md #319
    • Create API-cheatsheet.md #320
• Updates of CAMARA_common.yaml (->CAMARA-common.yaml)
  • Add an “Area” data-type into CAMARA_common.yaml #242
    • Common 'area' data-type #315
  • Add security to CAMARA_common.yaml #217
    • Security scheme in CAMARA_common.yaml #335
• Event subscriptions/notifications
  • How to inform API consumer about unprocessable subscription request in Async mode #243
  • Design Guidelines should provide guidance about sinkCredentials in returned/retrieved subscription objects #276
  • Update the "sink" property description #289
  • Include Reference Link to CAMARA API Design Guidelines in Notification Cloud Events Artifact #290
  • Support of 504 Exception in Cloud Events Model #291
  • Follow the principle of data minimization for events based on explicit subscriptions #295
  • Synchronization Status for initialEvent = true notifications #299
  • Make device attribute optional for explicit subscription requests  #300
  • Resource-based subscription – guidelines for expiration time set by API operator policy #303
  • Resource-based subscription – GET /subscriptions using a 3-legged access token #304
  • servers field in event-subscription-template.yaml not in line with API guidelines #326
  • $\color{green}{\textbf{Consolidated PR:}}$ Subscription & events for Commonalities 0.5.0 #313

Additional context
Meta-release Spring25:
M0:
09-30-2024 kick-off preparation

[rartych]

I tried to group pending issues into topics in the issue description above.
Please create new issues and link them in the comments .

[PedroDiez]

Propose to add:

• Update the "sink" property description #289
• Include Reference Link to CAMARA API Design Guidelines in Notification Cloud Events Artifact #290
• Support of 504 Exception in Cloud Events Model #291

[bigludo7]

Another proposal:

• Provide Test Definition template for explicit subscription API #293

[PedroDiez]

Another proposal:

• Proposal to add a standard for defining durations for API Design guidelines #137

[Kevsy]

Another another proposal...

• Enhancement: api-root to act as a bookmark #294

[jgarciahospital]

Another proposal:
#302

[eric-murray]

I opened a separate but related issue on release numbering in Issue #307

[PedroDiez]

New proposed issue: #308

[hdamker]

@rartych I added a comment with a proposed text to issue #246 regarding the use of error status 501 and would like to see it in the scope of 0.5.0 as this documents the outcome of a TSC decision in July 2024. Happy to open it as a PR if agreed.