Jump to content

Unadvertised changes to JSON v3 format after release


Recommended Posts

I just noticed that there were a few additions to flight plans after the JSON v3 format was put into production in December:

  • aircraft_faa which holds aircraft information in the old FAA-style format (e.g. H/B744/L)
  • aircraft_short which holds only the aircraft ICAO code (e.g. B744)
  • revision_id which apparently re-adds the flight plan revision ID

The first two fields have been documented in the API docs but revision_id is undocumented so far. Is revision_id going to stay in the format permanently or is it just experimental and might be removed again?

Although I'm happy to see those additions I would have expected the format to be final after release and any modification to result in an incremented format version number. How is the process for future changes supposed to look like?

 

Link to post
Share on other sites

I don't have any inside information for you, but in general, I don't think adding fields to a JSON data structure would require upgrading a version number - after all, your code should still work unchanged, and just ignore those extra fields. That's how JSON-consuming code is usually written. It might not be a great idea to *depend* on those fields until the documentation explicitly mentions them, but you can surely *ignore* them.

23.png
Link to post
Share on other sites

Correct. As Tobias says, version numbers will only be incremented with breaking changes, where "breaking changes" means any changes that would cause existing apps to break, like removing existing fields or changing their type (string). Adding new fields is NOT a breaking change, since existing applications should just ignore any fields they don't know about.

Hope that answers the question!

Néstor Pérez
A Random Platypus
## [email protected]
Facebook Twitter Instagram
VATSIM Logo
Link to post
Share on other sites

That's fine for me, thanks! :) Is there any easy-to-follow place where changes to the data feed are publicly announced? I only stumbled upon those changes by looking at the raw JSON yesterday and wondering myself if I missed the flightplan's revision_id earlier. There was no mention on Tech Blog Q1 either. I don't follow these forums regularly so if there was some announcement maybe I just missed it.

What about the not yet documented revision_id in particular? Are you able to already tell if it is going to stay permanently?

Link to post
Share on other sites

Please sign in to comment

You will be able to leave a comment after signing in



Sign In Now
×
×
  • Create New...