We're using the «News Service on Refinitiv Data Platform - User and Design Guide, v2.0» manual to implement our news-handling service (which obtains news stories via alerts pushed to an AWS SQS queue), and there is a problem with versioning of the format of the responses.
By default, if we subscribe for the news alerts without specifying the "payloadVersion" field in the top-level object of the JSON document which is the subscription requests's payload, the service pushes news alerts which contain the field "payloadVersion" with the value "1.0" in the top-level object of the JSON objects constituting the alerts' bodies.
We have figured out we can affect this version by setting the field "payloadVersion" in the subscription requests — for instance, if we specify "payloadVersion": "2.0" when subscribing, we'll receive news alerts containing "payloadVersion" set to "2.0" in their payload, and the payload indeed apparently differs from that of the version 1.0.
Unfortunately, the "payloadVersion" field is not documented in the manual we're using for implementation.
So, the questions are:
- What is the semantics of the "payloadVersion" field?
- Where are different versions of it are documented? How do they affect the schema of the JSON payloads of the news alerts?
- Is there a standard way to get notified when a new payload version becomes available for use?
- Is there any process of deprecation of payload versions and accompanying notifications in advance? (In other words, if payload version "1.0" ever becomes deprecated, we'd like to get notified about such an upcoming change proactively).