Skip to content

Commit ece3941

Browse files
committed
docs: list features
Signed-off-by: David Bernard <[email protected]>
1 parent aefd991 commit ece3941

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

Diff for: README.md

+19-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The SDK can be used to create CDEvents and send them as CloudEvents, as well as
99
Import the modules in your code
1010

1111
```toml
12-
cdevents-sdk = "0.1.0"
12+
cdevents-sdk = "0.1"
1313
```
1414

1515
To send a CDEvent as CloudEvent:
@@ -60,6 +60,24 @@ fn main() -> Result<(), Box<dyn Error>> {
6060

6161
See the [CloudEvents](https://github.com/cloudevents/sdk-rust) docs as well.
6262

63+
## Features
64+
65+
- [x] support cdevents spec 0.3.0
66+
- [x] support cdevents spec 0.4.1
67+
- [ ] support of custom event
68+
- [ ] compile-time generation of type for custom event
69+
- [ ] runtime validation (download of jsonschemas & validation)
70+
- [x] serialize/deserialize of custom event (type `dev.cdeventsx.{subject}.{predicate}.{version}`)
71+
- [x] partial validation of custom event (`subject.content` is not validated, stored as json)
72+
- [x] Cloudevents support (provide wrapper/extractor for CDEvent)
73+
- [x] CDEvent stored into static types (=> no use of jsonshema at runtime)
74+
- [x] rutime validation for scalar types (purl, datetime, uri-reference)
75+
- [ ] report clear and readable error messages on deserialization
76+
- [x] provide type with builder pattern (fluent)
77+
- [x] provide random/sample generator for CDEvent (property based testing)
78+
- [x] test `serialization(deserialization(of spec's examples & conformances)) == spec's examples & conformances`
79+
- [x] test `serialization(random CDEvent) matches the jsonschemas`
80+
6381
## References
6482

6583
- [CDEvents](https://cdevents.dev)

0 commit comments

Comments
 (0)