diff --git a/README.md b/README.md index bc2735759..7143f0e65 100644 --- a/README.md +++ b/README.md @@ -27,24 +27,24 @@ The following documents are available: | | Latest Release | Working Draft | | :---------------------------- | :-----------------------------------------------------------------------------: | :---------------------------------------------------------------------------------: | | **Core Specification:** | -| CloudEvents | [v0.3](https://github.com/cloudevents/spec/blob/v0.3/spec.md) | [master](https://github.com/cloudevents/spec/blob/master/spec.md) | +| CloudEvents | [v1.0-rc1](https://github.com/cloudevents/spec/blob/v1.0-rc1/spec.md) | [master](https://github.com/cloudevents/spec/blob/master/spec.md) | | | | **Optional Specifications:** | -| AMQP Event Format | [v0.3](https://github.com/cloudevents/spec/blob/v0.3/amqp-format.md) | [master](https://github.com/cloudevents/spec/blob/master/amqp-format.md) | -| AMQP Transport Binding | [v0.3](https://github.com/cloudevents/spec/blob/v0.3/amqp-transport-binding.md) | [master](https://github.com/cloudevents/spec/blob/master/amqp-transport-binding.md) | +| AMQP Event Format | [v1.0-rc1](https://github.com/cloudevents/spec/blob/v1.0-rc1/amqp-format.md) | [master](https://github.com/cloudevents/spec/blob/master/amqp-format.md) | +| AMQP Transport Binding | [v1.0-rc1](https://github.com/cloudevents/spec/blob/v1.0-rc1/amqp-transport-binding.md) | [master](https://github.com/cloudevents/spec/blob/master/amqp-transport-binding.md) | | AVRO Event Format | - | [master](./avro-format.md) | -| HTTP Transport Binding | [v0.3](https://github.com/cloudevents/spec/blob/v0.3/http-transport-binding.md) | [master](https://github.com/cloudevents/spec/blob/master/http-transport-binding.md) | -| JSON Event Format | [v0.3](https://github.com/cloudevents/spec/blob/v0.3/json-format.md) | [master](https://github.com/cloudevents/spec/blob/master/json-format.md) | +| HTTP Transport Binding | [v1.0-rc1](https://github.com/cloudevents/spec/blob/v1.0-rc1/http-transport-binding.md) | [master](https://github.com/cloudevents/spec/blob/master/http-transport-binding.md) | +| JSON Event Format | [v1.0-rc1](https://github.com/cloudevents/spec/blob/v1.0-rc1/json-format.md) | [master](https://github.com/cloudevents/spec/blob/master/json-format.md) | | Kafka Transport Binding | - | [master](https://github.com/cloudevents/spec/blob/master/kafka-transport-binding.md) | -| MQTT Transport Binding | [v0.3](https://github.com/cloudevents/spec/blob/v0.3/mqtt-transport-binding.md) | [master](https://github.com/cloudevents/spec/blob/master/mqtt-transport-binding.md) | -| NATS Transport Binding | [v0.3](https://github.com/cloudevents/spec/blob/v0.3/nats-transport-binding.md) | [master](https://github.com/cloudevents/spec/blob/master/nats-transport-binding.md) | -| Web hook | [v0.3](https://github.com/cloudevents/spec/blob/v0.3/http-webhook.md) | [master](https://github.com/cloudevents/spec/blob/master/http-webhook.md) | +| MQTT Transport Binding | [v1.0-rc1](https://github.com/cloudevents/spec/blob/v1.0-rc1/mqtt-transport-binding.md) | [master](https://github.com/cloudevents/spec/blob/master/mqtt-transport-binding.md) | +| NATS Transport Binding | [v1.0-rc1](https://github.com/cloudevents/spec/blob/v1.0-rc1/nats-transport-binding.md) | [master](https://github.com/cloudevents/spec/blob/master/nats-transport-binding.md) | +| Web hook | [v1.0-rc1](https://github.com/cloudevents/spec/blob/v1.0-rc1/http-webhook.md) | [master](https://github.com/cloudevents/spec/blob/master/http-webhook.md) | | | | **Additional Documentation:** | | CloudEvents Adapters | - | [master](https://github.com/cloudevents/spec/blob/master/adapters.md) | -| CloudEvents SDK Requirements | [v0.3](https://github.com/cloudevents/spec/blob/v0.3/SDK.md) | [master](https://github.com/cloudevents/spec/blob/master/SDK.md) | +| CloudEvents SDK Requirements | [v1.0-rc1](https://github.com/cloudevents/spec/blob/v1.0-rc1/SDK.md) | [master](https://github.com/cloudevents/spec/blob/master/SDK.md) | | Documented Extensions | - | [master](https://github.com/cloudevents/spec/blob/master/documented-extensions.md) | -| Primer | [v0.3](https://github.com/cloudevents/spec/blob/v0.3/primer.md) | [master](https://github.com/cloudevents/spec/blob/master/primer.md) | +| Primer | [v1.0-rc1](https://github.com/cloudevents/spec/blob/v1.0-rc1/primer.md) | [master](https://github.com/cloudevents/spec/blob/master/primer.md) | | Proprietary Specifications | - | [master](https://github.com/cloudevents/spec/blob/master/proprietary-specs.md) | If you are new to CloudEvents, it is recommended that you start by reading the diff --git a/SDK.md b/SDK.md index 0c23e428d..33f138f10 100644 --- a/SDK.md +++ b/SDK.md @@ -1,4 +1,4 @@ -# CloudEvents SDK Requirements - Version 0.4-wip +# CloudEvents SDK Requirements - Version 1.0-rc1 The intent of this document to describe bare minimum set of requirements for a new SDKs. diff --git a/adapters/aws-s3.md b/adapters/aws-s3.md index 8e1242ea6..e321159a9 100644 --- a/adapters/aws-s3.md +++ b/adapters/aws-s3.md @@ -14,7 +14,7 @@ same pattern as described in the following table: | :-------------------- | :---------------------------------------------- | | `id` | "responseElements.x-amz-request-id" + `.` + "responseElements.x-amz-id-2" | | `source` | "eventSource" value + `.` + "awsRegion" value + `.` + "s3.buckets.name" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.amazonaws.s3.` + "eventName" value | | `datacontenttype` | S3 event type (e.g. `application/json`) | | `dataschema` | Omit | diff --git a/adapters/github.md b/adapters/github.md index b327bd702..eb7b6d555 100644 --- a/adapters/github.md +++ b/adapters/github.md @@ -16,7 +16,7 @@ based on the specified event. | :-------------------- | :------------------------------------------------------------------------------- | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.check_run.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -31,7 +31,7 @@ based on the specified event. | :-------------------- | :----------------------------------------- | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.check_suite.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -46,7 +46,7 @@ based on the specified event. | :-------------------- | :---------------------------------------------------- | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "comment.url" value + `/` + "comment.commit_id" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.commit_comment.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -61,7 +61,7 @@ based on the specified event. | :-------------------- | :----------------------------------------------- | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.content_reference.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -76,7 +76,7 @@ based on the specified event. | :-------------------- | :-------------------------------------- | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.create.` + "ref_type" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -91,7 +91,7 @@ based on the specified event. | :-------------------- | :-------------------------------------- | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.delete.` + "ref_type" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -106,7 +106,7 @@ based on the specified event. | :-------------------- | :-------------------------------------------------------------- | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.deploy_key.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -121,7 +121,7 @@ based on the specified event. | :-------------------- | :------------------------------------ | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.deployment` | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -136,7 +136,7 @@ based on the specified event. | :-------------------- | :---------------------------------------------------------------- | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "deployment.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.deployment_status.` + "deployment_status.state" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -151,7 +151,7 @@ based on the specified event. | :-------------------- | :------------------------------------ | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.fork` | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -166,7 +166,7 @@ based on the specified event. | :-------------------- | :------------------------------------ | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "sender.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.github_app_authorization` | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -181,7 +181,7 @@ based on the specified event. | :-------------------- | :------------------------------------------ | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.gollum.` + "pages.action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -196,7 +196,7 @@ based on the specified event. | :-------------------- | :-------------------------------------------------- | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "installation.account.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.installation.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -211,7 +211,7 @@ based on the specified event. | :-------------------- | :----------------------------------------------------- | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "installation.account.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.installation_repository.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -226,7 +226,7 @@ based on the specified event. | :-------------------- | :------------------------------------------- | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "issue.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.issue_comment.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -241,7 +241,7 @@ based on the specified event. | :-------------------- | :------------------------------------ | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.issue.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -256,7 +256,7 @@ based on the specified event. | :-------------------- | :------------------------------------ | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.label.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -271,7 +271,7 @@ based on the specified event. | :-------------------- | :-------------------------------------------------- | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "sender.url" value without the `/username` portion | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.marketplace_purchase.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -286,7 +286,7 @@ based on the specified event. | :-------------------- | :------------------------------------ | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.member.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -301,7 +301,7 @@ based on the specified event. | :-------------------- | :-------------------------------------------------------------- | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "team.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.membership.` + "scope" value + `.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -316,7 +316,7 @@ based on the specified event. | :-------------------- | :------------------------------------ | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.meta.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -331,7 +331,7 @@ based on the specified event. | :-------------------- | :--------------------------------------- | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.milestone.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -346,7 +346,7 @@ based on the specified event. | :-------------------- | :------------------------------------------- | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "organization.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.organization.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -361,7 +361,7 @@ based on the specified event. | :-------------------- | :--------------------------------------- | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "organization.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.org_block.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -376,7 +376,7 @@ based on the specified event. | :-------------------- | :------------------------------------ | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.page_build` | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -391,7 +391,7 @@ based on the specified event. | :-------------------- | :------------------------------------------ | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.project_card.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -406,7 +406,7 @@ based on the specified event. | :-------------------- | :-------------------------------------------- | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.project_column.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -421,7 +421,7 @@ based on the specified event. | :-------------------- | :------------------------------------- | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.project.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -436,7 +436,7 @@ based on the specified event. | :-------------------- | :------------------------------------ | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.owner.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.public` | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -451,7 +451,7 @@ based on the specified event. | :-------------------- | :------------------------------------------ | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.pull_request.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -466,7 +466,7 @@ based on the specified event. | :-------------------- | :------------------------------------------------- | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "pull_request.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.pull_request_review.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -481,7 +481,7 @@ based on the specified event. | :-------------------- | :--------------------------------------------------------- | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "pull_request.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.pull_request_review_comment.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -496,7 +496,7 @@ based on the specified event. | :-------------------- | :-------------------------------------- | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.push` | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -511,7 +511,7 @@ based on the specified event. | :-------------------- | :---------------------------------------------- | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.registry_package.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -526,7 +526,7 @@ based on the specified event. | :-------------------- | :------------------------------------- | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.release.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -541,7 +541,7 @@ based on the specified event. | :-------------------- | :---------------------------------------- | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.owner.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.repository.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -556,7 +556,7 @@ based on the specified event. | :-------------------- | :------------------------------------ | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.owner.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.repository_import` | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -571,7 +571,7 @@ based on the specified event. | :-------------------- | :------------------------------------------------------------ | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.repository_vulnerability_alert.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -586,7 +586,7 @@ based on the specified event. | :-------------------- | :----------------------------------------------- | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | `github.com` | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.security_advisory.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -601,7 +601,7 @@ based on the specified event. | :-------------------- | :---------------------------------------------------- | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.star.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -616,7 +616,7 @@ based on the specified event. | :-------------------- | :--------------------------------------- | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.status.` # + "state" value ? | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -631,7 +631,7 @@ based on the specified event. | :-------------------- | :------------------------------------ | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.team.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -646,7 +646,7 @@ based on the specified event. | :-------------------- | :-------------------------------------- | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.team_add.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | @@ -661,7 +661,7 @@ based on the specified event. | :-------------------- | :------------------------------------ | | `id` | "X-GitHub-Delivery" HTTP header value | | `source` | "repository.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.github.watch.` + "action" value | | `datacontentencoding` | Omit | | `datacontenttype` | `application/json` | diff --git a/adapters/gitlab.md b/adapters/gitlab.md index f90da7ba2..eedc39dab 100644 --- a/adapters/gitlab.md +++ b/adapters/gitlab.md @@ -16,7 +16,7 @@ based on the specified event. | :-------------------- | :--------------------------------------- | | `id` | Generate a new unique value, e.g. a UUID | | `source` | "repository.homepage" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.gitlab.push` | | `datacontenttype` | `application/json` | | `dataschema` | Omit | @@ -30,7 +30,7 @@ based on the specified event. | :-------------------- | :--------------------------------------- | | `id` | Generate a new unique value, e.g. a UUID | | `source` | "repository.homepage" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.gitlab.tag_push` | | `datacontenttype` | `application/json` | | `dataschema` | Omit | @@ -44,7 +44,7 @@ based on the specified event. | :-------------------- | :---------------------------------------------------- | | `id` | Generate a new unique value, e.g. a UUID | | `source` | "repository.homepage" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.gitlab.issue.` + "object_attributes.state" value | | `datacontenttype` | `application/json` | | `dataschema` | Omit | @@ -58,7 +58,7 @@ based on the specified event. | :-------------------- | :--------------------------------------- | | `id` | Generate a new unique value, e.g. a UUID | | `source` | "commit.url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.gitlab.note.commit` | | `datacontenttype` | `application/json` | | `dataschema` | Omit | @@ -72,7 +72,7 @@ based on the specified event. | :-------------------- | :----------------------------------------------------------- | | `id` | Generate a new unique value, e.g. a UUID | | `source` | "object_attributes.url" value, without the `#note\_...` part | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.gitlab.note.merge_request` | | `datacontenttype` | `application/json` | | `dataschema` | Omit | @@ -86,7 +86,7 @@ based on the specified event. | :-------------------- | :---------------------------------------------------------- | | `id` | Generate a new unique value, e.g. a UUID | | `source` | "object_attributes.url" value without the `#note\_...` part | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.gitlab.note.issue` | | `datacontenttype` | `application/json` | | `dataschema` | Omit | @@ -100,7 +100,7 @@ based on the specified event. | :-------------------- | :---------------------------------------------------------- | | `id` | Generate a new unique value, e.g. a UUID | | `source` | "object_attributes.url" value without the `#note\_...` part | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.gitlab.note.snippet` | | `datacontenttype` | `application/json` | | `dataschema` | Omit | @@ -114,7 +114,7 @@ based on the specified event. | :-------------------- | :------------------------------------------------------------- | | `id` | Generate a new unique value, e.g. a UUID | | `source` | "repository.homepage" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.gitlab.merge_request.` + "object_attributes.action" value | | `datacontenttype` | `application/json` | | `dataschema` | Omit | @@ -128,7 +128,7 @@ based on the specified event. | :-------------------- | :--------------------------------------------------------- | | `id` | Generate a new unique value, e.g. a UUID | | `source` | "project.web_url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.gitlab.wiki_page.` + "object_attributes.action" value | | `datacontenttype` | `application/json` | | `dataschema` | Omit | @@ -142,7 +142,7 @@ based on the specified event. | :-------------------- | :-------------------------------------------------------- | | `id` | Generate a new unique value, e.g. a UUID | | `source` | "project.web_url" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.gitlab.pipeline.` + "object_attributes.status" value | | `datacontenttype` | `application/json` | | `dataschema` | Omit | @@ -156,7 +156,7 @@ based on the specified event. | :-------------------- | :--------------------------------------- | | `id` | Generate a new unique value, e.g. a UUID | | `source` | "repository.homepage" value | -| `specversion` | `0.4-wip` | +| `specversion` | `1.0-rc1` | | `type` | `com.gitlab.job.` + "job_status" value | | `datacontenttype` | `application/json` | | `dataschema` | Omit | diff --git a/amqp-format.md b/amqp-format.md index fb841537b..8eb6b439d 100644 --- a/amqp-format.md +++ b/amqp-format.md @@ -1,4 +1,4 @@ -# AMQP Event Format for CloudEvents - Version 0.4-wip +# AMQP Event Format for CloudEvents - Version 1.0-rc1 ## Abstract diff --git a/amqp-transport-binding.md b/amqp-transport-binding.md index 3159cd4e0..670d3116d 100644 --- a/amqp-transport-binding.md +++ b/amqp-transport-binding.md @@ -1,4 +1,4 @@ -# AMQP Transport Binding for CloudEvents - Version 0.4-wip +# AMQP Transport Binding for CloudEvents - Version 1.0-rc1 ## Abstract @@ -202,7 +202,7 @@ content-type: application/json; charset=utf-8 ----------- application-properties ----------- -cloudEvents:specversion: 0.4-wip +cloudEvents:specversion: 1.0-rc1 cloudEvents:type: com.example.someevent cloudEvents:time: 2018-04-05T03:56:24Z cloudEvents:id: 1234-1234-1234 @@ -264,7 +264,7 @@ content-type: application/cloudevents+json; charset=utf-8 ------------- application-data -------------------------- { - "specversion" : "0.4-wip", + "specversion" : "1.0-rc1", "type" : "com.example.someevent", ... further attributes omitted ... diff --git a/avro-format.md b/avro-format.md index a87445ce4..344747267 100644 --- a/avro-format.md +++ b/avro-format.md @@ -1,4 +1,4 @@ -# Avro Event Format for CloudEvents - Version 0.4-wip +# Avro Event Format for CloudEvents - Version 1.0-rc1 ## Abstract @@ -82,7 +82,7 @@ described by the [CloudEvent Avro Schema](./spec.avsc): "namespace": "io.cloudevents", "type": "record", "name": "CloudEvent", - "version": "0.4-wip", + "version": "1.0-rc1", "doc": "Avro Event Format for CloudEvents", "fields": [ { @@ -157,7 +157,7 @@ The following table shows exemplary mappings: | CloudEvents | Type | Exemplary Avro Value | | ----------- | ------ | ---------------------------------------------- | | type | string | `"com.example.someevent"` | -| specversion | string | `"0.4-wip` | +| specversion | string | `"1.0-rc1` | | source | string | `"/mycontext"` | | id | string | `"7a0dc520-c870-4193c8"` | | time | string | `"2019-06-05T23:45:00Z"` | diff --git a/extensions/dataref.md b/extensions/dataref.md index bff28826b..41fb1bf9b 100644 --- a/extensions/dataref.md +++ b/extensions/dataref.md @@ -47,7 +47,7 @@ both `data` and `dataref` (serialized as JSON): ``` JSON { - "specversion" : "0.4-wip", + "specversion" : "1.0-rc1", "type" : "com.github.pull.create", "source" : "https://github.com/cloudevents/spec/pull/123", "id" : "A234-1234-1234", @@ -62,7 +62,7 @@ The following example shows a CloudEvent in which a middleware has replaced the ``` JSON { - "specversion" : "0.4-wip", + "specversion" : "1.0-rc1", "type" : "com.github.pull.create", "source" : "https://github.com/cloudevents/spec/pull/123", "id" : "A234-1234-1234", diff --git a/http-transport-binding.md b/http-transport-binding.md index 59e3825ad..162e919b1 100644 --- a/http-transport-binding.md +++ b/http-transport-binding.md @@ -1,4 +1,4 @@ -# HTTP Transport Binding for CloudEvents - Version 0.4-wip +# HTTP Transport Binding for CloudEvents - Version 1.0-rc1 ## Abstract @@ -219,7 +219,7 @@ request: ```text POST /someresource HTTP/1.1 Host: webhook.example.com -ce-specversion: 0.4-wip +ce-specversion: 1.0-rc1 ce-type: com.example.someevent ce-time: 2018-04-05T03:56:24Z ce-id: 1234-1234-1234 @@ -237,7 +237,7 @@ This example shows a response containing an event: ```text HTTP/1.1 200 OK -ce-specversion: 0.4-wip +ce-specversion: 1.0-rc1 ce-type: com.example.someevent ce-time: 2018-04-05T03:56:24Z ce-id: 1234-1234-1234 @@ -296,7 +296,7 @@ Content-Type: application/cloudevents+json; charset=utf-8 Content-Length: nnnn { - "specversion" : "0.4-wip", + "specversion" : "1.0-rc1", "type" : "com.example.someevent", ... further attributes omitted ... @@ -317,7 +317,7 @@ Content-Type: application/cloudevents+json; charset=utf-8 Content-Length: nnnn { - "specversion" : "0.4-wip", + "specversion" : "1.0-rc1", "type" : "com.example.someevent", ... further attributes omitted ... @@ -373,7 +373,7 @@ Content-Length: nnnn [ { - "specversion" : "0.4-wip", + "specversion" : "1.0-rc1", "type" : "com.example.someevent", ... further attributes omitted ... @@ -383,7 +383,7 @@ Content-Length: nnnn } }, { - "specversion" : "0.4-wip", + "specversion" : "1.0-rc1", "type" : "com.example.someotherevent", ... further attributes omitted ... @@ -406,7 +406,7 @@ Content-Length: nnnn [ { - "specversion" : "0.4-wip", + "specversion" : "1.0-rc1", "type" : "com.example.someevent", ... further attributes omitted ... @@ -416,7 +416,7 @@ Content-Length: nnnn } }, { - "specversion" : "0.4-wip", + "specversion" : "1.0-rc1", "type" : "com.example.someotherevent", ... further attributes omitted ... diff --git a/http-webhook.md b/http-webhook.md index ed8da5cbe..70b57a336 100644 --- a/http-webhook.md +++ b/http-webhook.md @@ -1,4 +1,4 @@ -# HTTP 1.1 Web Hooks for Event Delivery - Version 0.4-wip +# HTTP 1.1 Web Hooks for Event Delivery - Version 1.0-rc1 ## Abstract diff --git a/json-format.md b/json-format.md index f1fbfdd09..c0ef9ed25 100644 --- a/json-format.md +++ b/json-format.md @@ -1,4 +1,4 @@ -# JSON Event Format for CloudEvents - Version 0.4-wip +# JSON Event Format for CloudEvents - Version 1.0-rc1 ## Abstract @@ -96,7 +96,7 @@ The following table shows exemplary attribute mappings: | CloudEvents | Type | Exemplary JSON Value | | --------------- | ------------- | ------------------------------- | | type | String | "com.example.someevent" | -| specversion | String | "0.4-wip" | +| specversion | String | "1.0-rc1" | | source | URI-reference | "/mycontext" | | id | String | "1234-1234-1234" | | time | Timestamp | "2018-04-05T17:31:00Z" | @@ -151,7 +151,7 @@ Example event with `String`-valued `data`: ```JSON { - "specversion" : "0.4-wip", + "specversion" : "1.0-rc1", "type" : "com.example.someevent", "source" : "/mycontext", "id" : "A234-1234-1234", @@ -167,7 +167,7 @@ Example event with `Binary`-valued data ```JSON { - "specversion" : "0.4-wip", + "specversion" : "1.0-rc1", "type" : "com.example.someevent", "source" : "/mycontext", "id" : "B234-1234-1234", @@ -184,7 +184,7 @@ or [JSON data](#31-handling-of-data) data: ```JSON { - "specversion" : "0.4-wip", + "specversion" : "1.0-rc1", "type" : "com.example.someevent", "source" : "/mycontext", "id" : "C234-1234-1234", @@ -232,7 +232,7 @@ second with JSON data. ```JSON [ { - "specversion" : "0.4-wip", + "specversion" : "1.0-rc1", "type" : "com.example.someevent", "source" : "/mycontext/4", "id" : "B234-1234-1234", @@ -243,7 +243,7 @@ second with JSON data. "data_base64" : "... base64 encoded string ..." }, { - "specversion" : "0.4-wip", + "specversion" : "1.0-rc1", "type" : "com.example.someotherevent", "source" : "/mycontext/9", "id" : "C234-1234-1234", diff --git a/kafka-transport-binding.md b/kafka-transport-binding.md index 3a529c413..2289b6d13 100644 --- a/kafka-transport-binding.md +++ b/kafka-transport-binding.md @@ -1,4 +1,4 @@ -# Kafka Transport Binding for CloudEvents - Version 0.4-wip +# Kafka Transport Binding for CloudEvents - Version 1.0-rc1 ## Abstract @@ -179,7 +179,7 @@ Key: mykey ------------------ headers ------------------- -ce_specversion: "0.4-wip" +ce_specversion: "1.0-rc1" ce_type: "com.example.someevent" ce_source: "/mycontext/subcontext" ce_id: "1234-1234-1234" @@ -245,7 +245,7 @@ content-type: application/cloudevents+json; charset=UTF-8 ------------------- value -------------------- { - "specversion" : "0.4-wip", + "specversion" : "1.0-rc1", "datacontenttype" : "com.example.someevent", ... further attributes omitted ... diff --git a/mqtt-transport-binding.md b/mqtt-transport-binding.md index f69bd13f2..94d0c4e8f 100644 --- a/mqtt-transport-binding.md +++ b/mqtt-transport-binding.md @@ -1,4 +1,4 @@ -# MQTT Transport Binding for CloudEvents - Version 0.4-wip +# MQTT Transport Binding for CloudEvents - Version 1.0-rc1 ## Abstract @@ -189,7 +189,7 @@ Content Type: application/json; charset=utf-8 ------------- User Properties ---------------- -specversion: 0.4-wip +specversion: 1.0-rc1 type: com.example.someevent time: 2018-04-05T03:56:24Z id: 1234-1234-1234 @@ -252,7 +252,7 @@ Content Type: application/cloudevents+json; charset=utf-8 ------------------ payload ------------------- { - "specversion" : "0.4-wip", + "specversion" : "1.0-rc1", "type" : "com.example.someevent", "time" : 2018-04-05T03:56;24Z, "id" : 1234-1234-1234, @@ -281,7 +281,7 @@ Topic Name: mytopic ------------------ payload ------------------- { - "specversion" : "0.4-wip", + "specversion" : "1.0-rc1", "type" : "com.example.someevent", "time" : 2018-04-05T03:56;24Z, "id" : 1234-1234-1234, diff --git a/nats-transport-binding.md b/nats-transport-binding.md index 387eaf643..9004f105a 100644 --- a/nats-transport-binding.md +++ b/nats-transport-binding.md @@ -1,4 +1,4 @@ -# NATS Transport Binding for CloudEvents - Version 0.4-wip +# NATS Transport Binding for CloudEvents - Version 1.0-rc1 ## Abstract @@ -128,7 +128,7 @@ Subject: mySubject ------------------ payload ------------------- { - "specversion" : "0.4-wip", + "specversion" : "1.0-rc1", "type" : "com.example.someevent", ... further attributes omitted ... diff --git a/primer.md b/primer.md index b09336791..fde785673 100644 --- a/primer.md +++ b/primer.md @@ -1,4 +1,4 @@ -# CloudEvents Primer - Version 0.4-wip +# CloudEvents Primer - Version 1.0-rc1 ## Abstract diff --git a/roadmap.md b/roadmap.md index bb6466a9b..c0f863016 100644 --- a/roadmap.md +++ b/roadmap.md @@ -67,7 +67,7 @@ _0.3_ - Completed - 2019/06/13 redaction). 1. Consider validating transport bindings with load tests. -_1.0-rc_ +_1.0-rc1_ - Completed - 2019/09/19 1. Complete all issues and PRs tagged as `v1.0`. 1. Decide on duration and exit criteria for 'verification & testing' period. diff --git a/spec.avsc b/spec.avsc index 6c1cf7e88..3baa31f63 100644 --- a/spec.avsc +++ b/spec.avsc @@ -2,7 +2,7 @@ "namespace":"io.cloudevents", "type":"record", "name":"CloudEvent", - "version":"0.4-wip", + "version":"1.0-rc1", "doc":"Avro Event Format for CloudEvents", "fields":[ { diff --git a/spec.md b/spec.md index 789b0fc95..5b7dad913 100644 --- a/spec.md +++ b/spec.md @@ -1,4 +1,4 @@ -# CloudEvents - Version 0.4-wip +# CloudEvents - Version 1.0-rc1 ## Abstract @@ -280,7 +280,7 @@ The following attributes are REQUIRED to be present in all CloudEvents: - Type: `String` - Description: The version of the CloudEvents specification which the event uses. This enables the interpretation of the context. Compliant event - producers MUST use a value of `0.4-wip` when referring to this version of the + producers MUST use a value of `1.0-rc1` when referring to this version of the specification. - Constraints: - REQUIRED @@ -352,7 +352,7 @@ on the definition of OPTIONAL. for more information. - Constraints: - OPTIONAL - - If present, MUST be a non-empty URI-reference + - If present, MUST be a non-empty URI #### subject @@ -536,7 +536,7 @@ The following example shows a CloudEvent serialized as JSON: ```JSON { - "specversion" : "0.4-wip", + "specversion" : "1.0-rc1", "type" : "com.github.pull.create", "source" : "https://github.com/cloudevents/spec/pull", "subject" : "123",