Zendesk OpenAPI

Sanjeev Mandalapu I see that the OAS has been updated with fixes to remove the erroneous trailing ".yaml" in schema names, and to address the malformed array schema, that's already a big improvement, thanks.

Here are some schema which I've identified to still contain array-types without `items` properties:

• GroupSLAPolicyFilterConditionObject
• TriggerActionObject
• TriggerChangeObject
• TriggerConditionObject
• AuditObject

Thanks again, looking forward to further fixes and improvements.

Daniel Williams: Nah! We wanted to keep it generalised for now as part of the (initial) documentation offering. I will take your suggestion/feedback to the team and do a feasibility check to do such customised generation within the Admin Centre UI.

Mitch Ryan your comments on this page are a good start. The team are working on the reported `items` already. The trailing .yaml is a source file issue and is being rectified too. We will post an updated file soon in the documentation.

With more OAS files (as we cover more products), we will create a public GH repo which could help with issue management.

Honestly, thank you for the feedback in improving this resource.

Sanjeev Mandalapu - thanks for the long awaited update. Where should we post bugs+issues with the OpenAPI schema?

To give an example: many fields/properties of `type: array` either:

1. Have no `items` property altogether. As one specific example, the `TicketUpdateInput` schema has a `tags` property, which is `type: array`, but does not specify items, and therefore we cannot programmatically determine that this is (presumably) an array of strings.

2. Have specified a `properties` property instead of an `items` property. Consider the example of `PushNotificationDevicesInput`, which is `type: array` but has `properties: …` instead of `items: …`.

Additionally, some schema/component names have a trailing `.yaml` for some reason. I assume this is erroneous, but I could be wrong.

@Sanjeev Mandalapu

Is there a way to generate the OAS for our specific instance of ZD so that it includes custom fields, objects, etc?

Wondering the same?

Greg Katechis Any updates on that OpenAPI schema?

Ah, I misunderstood, I thought you meant that Zendesk's official clients (SDKs) were accessing data over GraphQL.

Back to you for that update now Greg…

https://support.zendesk.com/hc/en-us/community/posts/4486825535258-What-is-the-Access-log-API-

Quote (1st official comment): A large part of our frontend uses a tool called GraphQL. For the purposes of this EAP it means that the URL path is obfuscated and we don’t know what was accessed as part of the request an agent made. You will see this /graphql path in some of the URLs.

Serge, could you please provide a source for that statement (that GraphQL is being used in the clients)? If that's true, then we might be able to reverse-engineer the client source to find the GraphQL API URL, and therefore be able to do introspection.