Dapr: [Proposal] Streamline PubSub PublishRequest.Data

Created on 6 Apr 2020  路  5Comments  路  Source: dapr/dapr

In what area(s)?

/area components
/area cli
/area docs
/area sdks

Describe the proposal

Currently the naming for the data to be published per PubSub is not consistent at Dapr:

  • [X] [CloudEvents spec](https://github.com/cloudevents/spec/blob/v1.0/spec.md#event-data): data
  • [X] in Dapr code: data
  • [x] in Dapr API spec: payload
  • [x] in Dapr CLI: payload
  • [x] in Dapr .NET SDK: content
  • [X] in Dapr JS SDK: data
  • [x] in Dapr Java SDK: event
  • [X] in Dapr python SDK: data
  • [X] in Dapr Rust SDK: data
  • [X] in Dapr GO SDK: data

Even if I like the term "payload" more then "data", I think we should stick to the CloudEvent terms and rename all occurences to "data".

P2 areruntimpubsub breaking-change

Most helpful comment

I think we should follow the term data of CloudEvent.

cc/ @msfussell @orizohar @yaron2 @amanbha

All 5 comments

I think we should follow the term data of CloudEvent.

cc/ @msfussell @orizohar @yaron2 @amanbha

I think we should follow the term data of CloudEvent.

cc/ @msfussell @orizohar @yaron2 @amanbha

Yes, I agree.

To clarify (some of the links are broken as it's been a while and some point to the wrong location now) this issue is about names of variables and the terminology used in comments/docs, correct? It's not about the actual name of the "data" field in the envelope in messages, which to me looks like it's called data everywhere. If so, agree the name "data" should be used instead of the others. And this won't be a breaking change.

This is only a breaking change in the cli. Everywhere else it's only a name change.

Change done in the CLI.

Was this page helpful?
0 / 5 - 0 ratings