The Redocly is the new API document link for all Flexnet Operations REST APIs
The Redocly is the new API document link for all Flexnet Operations REST APIs
Introduction:
FNO/CMS/UAI currently use Swagger as the documentation software for REST APIs. One main difficulty documentation Engineers encounter is the inability to provide a common URL that customers can use to access the REST API docs.
For example, to access swagger documentation, we can provide a link such as https://<siteID>-uat.flexnetoperations.com/data/swagger-ui/index.html, which is not clickable. We have to copy this to a browser and update the domain to the valid domain name or tenant ID before we can even look at the structure of the API.
The documentation team has found an alternative software that will enable us to provide a common link (For each API) in the documentation via Redocly.
Using this software, we can embed this link for the data access API in FNO Clicking this link will list all methods for this API, and the customer can just provide the siteID and can execute the requests - no chance of incorrect endpoints.
