Closed FilipMessa closed 3 years ago
I missing documentation for API response.
For example, when I call location API, I get an array of location, some fields are self-explanatory by their name, but there is a type
field and I do not know how many types of values exists for it.
Delays
Search_api
route
- Naming should be updated according to glossary https://kiwi.wiki/kiwi/handbook/#/comms/glossary across endpoints. Instead of route
, segments
will be probably more suitable.
route[x].carrier.name
- Carrier name is missing in response and only code is currently available. Should be added to unify response with other endpoints where this value is available.
route[x].airline
- Unify carrier related props naming. airline
inside route
object should be renamed to carrier
to unify it with operating_carrier
which is also present on the same object.
Booking_api
transfers
- Missing description, seems to be always just empty array.
segments
- Missing description, seems to be always just empty array.
route
- Missing description, confusing compared to route
array in search_api
with completely different content. Content is similar to routes
from search_api
but there are still inconsistencies. Search routes
contains [ "PRG", "FRA" ], [ "FRA", "PRG" ]
for return flight. But booking route
is just [ "PRG", "FRA" ]
for similar case, so I cannot distinguish if it’s one-way or return flight.
flights
- Content and structure seems to be quite similar to route
from search_api
. Consider if naming and maybe even content can be unified. For example departure city is called cityFrom
on one endpoint and src_name
on second one.
flights[x].airline
- It looks like data can be cleaned or description with differences should be added. For example repeating code value VY
(for Vueling) is present as code
, iata
, iatacode
and it can be confusing which one should be used.
flights[x].airline.Name
- Name
is the only property inside airline
object which starts with capital letter. Naming should be unified.
baggage
- Baggages related part should be updated. Current sample schema on website only contains bags
section, but there is warning in response that this object is deprecated. There is also another luggage
array with all baggage limits, which is slightly confusing.
It looks from response that new correct way is to use baggage
object. Which is not documented, so it is always not clear which values I can get from it.
Search API
The search
endpoint with different sort
parameter values does not work for all cases. So far sort=price
and sort=quality
work but sort=duration
does not, the results are equivalent to the price
sorting...
Tequila website
API documentation
link in Resources section currently points to Locations API
section. It should probably lead to some page with endpoints summary/description. Or it can be removed.
There are browsable schemas at the bottom of some pages like on Booking API. But they are missing on some other endpoints, for example on Search API. It should be unified.
There are links to some "non-kiwi" code samples in docs like https://gist.github.com/jBenes/32dd9b9120adf58381aa in Booking API description. There are also some old unanswered questions under this gist. We should put all examples into some Tequila related repo under https://github.com/kiwicom .
If you realize some issue related to Tequila API pls write it here. From time to time we will summarize it and push to Tequila developers.
PLS don't forget that is public so be aware of sensitive data!!!