Introduction

Historically, FlexNet Operations used Swagger to document its REST APIs. However, a key challenge for documentation engineers has been the inability to provide a standardized, clickable URL that customers can use to directly access the REST API documentation.

For example, a typical Swagger documentation link in the documentation with a format such as https://<siteID>-uat.flexnetoperations.com/data/swagger-ui/index.html is not clickable. Users would have to manually copy the link into a browser and update the domain to the valid domain name or tenant ID before they can view the API structure.

To address this limitation, the documentation team has adopted Redocly as an alternative solution. Redocly enables the creation of consistent, user-friendly links for each API reference.

Feature Details

At present, the following REST API documentation is available on Redocly:

• FlexNet Operations Data Access APIs 
• FlexNet Operations Registry Service APIs