Signals Notebook: How to download raw Swagger files (in YAML format) for Signals Notebook API definition

Who needs Swagger files?

If you are a developer integrating Signals Notebook APIs and using Swagger-compatible tools, such as Postman, you may find it useful to have the raw Swagger files that describe the API definitions. Signals Notebook provides you with the Swagger UI on the web, where you can conveniently test the APIs in an interactive way. This article describes how you can retrieve the raw Swagger files, which help you to start working with the APIs programmatically.

Where can I find the Swagger files?

The files are available in YAML format for you to download from your Signals Notebook tenant URL. Please follow the steps below.

1. As an Admin user, open Signals Configuration.
2. Open "System Settings". In the left column, select "API Key" -> "External API key"
3. Find a download icon next to the text "Open External API Document".
   Click this icon to download the ZIP file.
   
4. Extract the ZIP file, and you will find API document files in YAML format.
   

You can use these YAML files for Swagger-based tools and Postman.