Other: I really can't believe that support is so lenient on abhering to the OpenAPI schema.
AnsweredI'm talking with the Fivetran support (Enterprise plan), and I'm telling some of them is sometimes violating the OpenAPI schema.
Also I'm sending like as following.
Here is the rough details of support interactions. I told connector list API endopoint (/v2/groups/{groupId}/connectors) output is violating the OpenAPI Schema.
It's returning null on some fields like connected_by, setup_tests, private_link_id, proxy_agent_id. But they're not allowed to be null.
OpenAPI is asserting like following:
private_link_id:
type: string
I know, it's common to confuse optionals and nulls, so I noted the reference.
https://json-schema.org/understanding-json-schema/reference/null
But the support keeps shifting the point. They're ...
- advice to touch Web UI to change the state, to change it to non-null values.
- Even so, API must follow the schema. To know the current state is one of the purpose of API.
- advice to make null acceptable to make the app robust.
- I also can't believe they're using the word "robust" in such way.
- And if thinking so, should we also consider any kind of API violations? To consider possibly null, string, number, array, etc.. for all fields? To limit such consideration, we have the schema as contraction.
- suggest have the video call without responding my messages, as they thought it's not good to make long email chain.
-
Official comment
Hi 哲平 川口,
Thank you for bringing this issue to our attention. We appreciate your diligence in identifying and reporting discrepancies with the OpenAPI schema, as maintaining accurate and reliable API functionality is crucial for our users.
To ensure that your concerns are addressed appropriately, I've escalated your issue and someone from our team will follow up.
We value your feedback and are committed to improving our services. Please let us know if there is anything else we can assist with.
Best regards,
Katie
Please sign in to leave a comment.
Comments
1 comment