Repository files navigation

This SDK current supports the following versions of CloudEvents:

• v1.0

.NET Standard 2.0 (C#) SDK for CloudEvents

TheCloudNative.CloudEvents package provides support for creating, encoding,decoding, sending, and receivingCNCFCloudEvents. Most applicationswill want to add dependencies on otherCloudNative.CloudEvents.*packages for specific event format and protocol binding support. Seetheuser guide for details of the packages available.

1. TheCloudEvent class is not meant to be used withobject serializers like JSON.NET. If you need to serialize or deserialize a CloudEvent directly, always use aCloudEventFormattersuch asJsonEventFormatter.
2. Protocol binding integration is provided in the form of extensions and the objective of those extensionsis to map the CloudEvent to and from the respective protocol message, such as an HTTP request or response.The application is otherwise fully in control of the client. Therefore, the extensions do notadd security headers or credentials or any other headers or properties that may be required to interactwith a particular product or service. Adding this information is up to the application.

Thedocs/ directory contains more documentation, includingtheuser guide. Feedback on what else to include inthe documentation is particularly welcome.

From version 2.0.0-beta.2, there are a number of breaking changescompared with the 1.x series of releases. New code isstrongly encouraged to adopt the latest version rather than relyingon the 1.3.80 stable release.

The stable 2.0.0 version was released on June 15th 2021, and allusers are encouraged to use this (or later) versions.

Amore details list of changes isprovided within the documentation.

• There are bi-weekly calls immediately following theServerless/CloudEventscall at9am PT (US Pacific). Which means they will typically start at 10am PT, butif the other call ends early then the SDK call will start early as well.See theCloudEvents meeting minutesto determine which week will have the call.
• Slack: #cloudeventssdk channel underCNCF's Slack workspace.
• Email:https://lists.cncf.io/g/cncf-cloudevents-sdk
• Contact for additional information: Clemens Vasters (@Clemens Vasterson slack).

The C# SDK welcomes community contributions; see thecontributingdocument for more details.

Each SDK may have its own unique processes, tooling and guidelines. Commongovernance related material can be found in theCloudEventsdocsdirectory. In particular, in there you will find informationconcerning how SDK projects aremanaged,guidelinesfor how PR reviews and approval, and ourCode of Conductinformation.

If there is a security concern with one of the CloudEvents specifications, orwith one of the project's SDKs, please send an email tocncf-cloudevents-security@lists.cncf.io.

• List of current active maintainers
• How to contribute to the project
• SDK's License
• SDK's Release process