Prepare

Author: oklemenz2

CHANGELOG.md

@@ -9,19 +9,19 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Added
 
-- Add support for Cloud Events
-- Include or exclude defined list of users
+- Provide event headers to formatter
 - Support exclusion of event contexts
+- Include or exclude defined list of users
+- Add support for Cloud Events with format `cloudevent` resp. `cloudevents`
 - Overrule path of websocket event via `@websocket.path` or `@ws.path` for non-websocket services
 - Overrule format of websocket event via `@websocket.format` or `@ws.format` for non-websocket services
 - Ignore event elements or operation parameters with `@websocket.ignore` or `@ws.ignore`
-- Optimization of client determination for kind `ws`
-- Allow empty PCP message in event definition
-- Improve documentation and examples
-- Provide event headers to formatter
 
 ### Fixed
 
+- Improve documentation and examples
+- Allow empty PCP message in event definition
+- Optimization of client determination for kind `ws`
 - Ignore not modeled PCP fields in payload serialization
 - Fix annotations value derivation for non-websocket service events
 - Fix annotations `wsCurrentUserInclude`, `currentUserInclude`, `wsCurrentUserExclude`, `currentUserExclude`

README.md

@@ -1061,6 +1061,17 @@ action sendCloudEventMap(
 ) returns Boolean;
 ```
 
+The following annotations are respected:
+
+- **Operation level**:
+  - `@websocket.cloudevent.<attribute>: <value>`
+  - Type: `any` (according to Cloud Event JSON format)
+  - Provide static cloud event attribute value, according to cloud event specification
+- **Operation parameter level**:
+  - `@websocket.cloudevent.<attribute>`
+  - Type: `Boolean`
+  - Value from operation parameter for the annotated element is used as dynamic cloud event attribute value, according to cloud event attribute specification
+
 Unmapped operation parameters are consumed as cloud event data section and can be skipped for cloud event data section
 via `@ws.ignore`, if not necessary.