w3c / automotive

W3C Automotive Working Group Specifications
Other
145 stars 68 forks source link

documentation: subscription timestamp #462

Closed aw-muc closed 1 year ago

aw-muc commented 1 year ago

Within the https://raw.githack.com/w3c/automotive/gh-pages/spec/VISSv2_Transport.html#subscribe documentation, the subscriptionNotification is described as followed

Object Name Attribute Type Required
action Action Yes
subscriptionId string Yes
data object/array Yes

Within the examples, the following is documented: Notification:

          {
            "action": "subscription",
            "subscriptionId": "12345",
            “data”: {“path”: ”Vehicle.Drivetrain.FuelSystem.Level”, 
                    “dp”: {“value”: ”50”, “ts”: ”2020-04-15T13:37:00Z”}
            },
            **"ts": "2020-04-15T13:37:00Z"**
          }

As you can see the example has an additional timestamp mentioned, which is not part of the documentation of the subscribeNotification;

Can you please clarify, what is the correct implementation?

UlfBj commented 1 year ago

Subscription notification messages shall have a timestamp. That is added to the table in PR#471.

aw-muc commented 1 year ago

Awesome; @UlfBj will the issue automatically be closed, when pull request is merged?

UlfBj commented 1 year ago

@aw-muc It will be closed at the WG meeting when it is merged. Thanks for finding this documentation error.

UlfBj commented 1 year ago

Fixed in PR#471