Consolidated Web API Documentation List is Gone

Platform API
1

The new developer center eliminates the consolidated list of web APIs (https://developer.mypurecloud.com/api/rest/v2/), and scatters them to the four winds buried under the documentation hierarchy.

Please provide in the documentation a consolidated list of all the Web APIs listed together. It's really frustrating from a development perspective not to have this.

Thanks!

2 Likes
2

Hello and thank you for your feedback. A notice about this has been posted in in the announcements:

4

Worth noting the github doesn't work well because all the links on the MD's are rendered pointing towards *.html extensions that don't work. Unless you know to manually change all the URLs you're trying to follow to link.md everything looks broken. (Also it can only show the first 1000 documents)

Example;
https://github.com/MyPureCloud/platform-client-sdk-dotnet/blob/master/build/docs/Action.md

The first hyperlink on that page goes to;
https://github.com/MyPureCloud/platform-client-sdk-dotnet/blob/master/build/docs/ActionContract.html

Which does not exist, it's actually;

https://github.com/MyPureCloud/platform-client-sdk-dotnet/blob/master/build/docs/ActionContract.md

Becky informed me that's a feature not a bug because it was never meant to be used that way from GitHub

2 Likes
5

The information in the announcement doesn't really resolve the issue.

Is it not possible to have a section in the documentation hierarchy that at the very least gives links to the various sections of the API, so they can all be accessed from one place?

Documentation-wise for a developer working with the APIs, this is a serious regression, not at all developer-friendly.

1 Like
6

This does not solve the problem that was created by this change. Can a single page please be added that lists and index-like view of the available APIs like what was previously available when clicking the Genesys icon in the top left-hand corner of the old developer center? Putting everything in individual menus mixed with a bunch of how-to's is not helpful for real developers who just need to quickly locate the correct documentation to find the exact parameters expected by an API endpoint. This was a step backwards in my experience.

2 Likes
7

@Boggs_Daniel @Heather_Rauch My reply above was mistakenly posted in this thread; this thread is not about SDKs.

I'm working on some updates to the new API Explorer view (currently located at https://developer.genesys.cloud/devapps/api-explorer and linked to from the front page) in an effort to make browsing the full list of APIs more familiar. Below is a screenshot featuring a few new features. Could you give me your feedback on these updates?

  • Grouped resources into collapsable accordion sections by swaggertag category (the categories/subpages that used to be on the /api/rest/v2/ page)
  • Added a filter on the sidebar to filter by swaggertag category, with the option to select/clear all
  • The text filter applies with the category filter as an AND (i.e. resources must match "workfor" AND category=[selected list])

image
image3350×2762 875 KB

3 Likes
8

I wish I could give this one million likes. This is exactly the type of thing I was looking for. Would it be possible to include a toggle to collapse and expand all accordion sections? This would allow general scanning as well as targeted searches.

Thank you!!!
Heather

1 Like
9

Yeah, I think I can work that in.

2 Likes
10

Whew, glad there's a replacement. That's looking very nice, better than before. Much appreciated.

1 Like
11

This topic was automatically closed 31 days after the last reply. New replies are no longer allowed.