SAS Viya REST API reference documentation getting a makeover

[#1]

The API Center of Excellence (COE) Team has been working to revamp the navigation for SAS Viya REST API documentation.  

 
The SAS Viya REST API reference documentation on the SAS Developer Portal, developer.sas.com, is getting some upgrades to the navigation that will make it much easier for developers to use the site starting 8/28/19.  

Summary: 

• Moved the Usage Notes to the top, making the Overview easier to find.  
• Made the navigation expandable so that child topics are scannable.  
• Added a section for examples that points to a new GitHub repository. 
• Added the Go language to the code samples section. 

Before: 

 1. The Nav is organized by API Category, with the name of each API as a subtopic.

2. When you click the API name, you get a full list of all the API calls and their documentation, with no introduction about what the API does. 

3. To find out more about the API and get a basic description of it, you must scroll down to the bottom of the list and find the Usage Notes. This is not intuitive and effectively “hides” this important information from the user, who expects overview information at the beginning. 

After: 

1. The Nav under each API is now grouped by category: Usage notes, Operations, Schemas, and Examples.

2. Since the Usage Notes are at the top of the nav, it is more intuitive for users to see the Overview and decide if they are in the right place.  

3. The API definitions are now children of the Operations subcategory, so that they do not use all the navigation space. 

4. The team also added an Examples section with a link to the new GitHub repository that holds all the API examples: 

5. In the Code Samples section, the Go language has been added: 

We are continuing to make improvements to the developer.sas.com site with the goal of giving our developers the best experience with our APIs, CAS actions, and SDK’s. Look for more updates coming soon!