You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Could this 7-year-old issue perhaps be looked into again? The current documentation is lacking in many aspects, making it unnecessarily difficult to develop applications against the iRail API.
The JSON schemas only describe the top-level fields of responses, never the nested objects inside of them
As a direct consequence of this, it's hard to know which fields are optional and which aren't, as this part of the schema is simply not available
The example responses are inaccurate/data is returned in unexpected formats
Numbers are shown in the example as floats and ints, but in practice they are returned as strings
Booleans are shown in the example as ints (0 or 1), but in practice they are also returned as strings (these should just contain true and false instead of numbers in all honesty)
This also leads to uncertainties surrounding some fields. When I see the value "0" in my API response, is it a string, an int or a bool?
Change templates, or modify the current one, to explicitly show the returned datastructures and their descriptions.
The text was updated successfully, but these errors were encountered: