Generate a Specification

February 15, 2024
April 12, 2024

Specifications can be used to group information for an API. You can generate a specification for an API based on existing request log information in the FireTail platform. 

  1. Navigate to APIs in the FireTail platform.
  2. Select the API you want to generate the specification for.
  3. Click the Specifications tab.
  4. Click Upload/Generate Specification.
  5. Select the Generate Specification option.

Customize the specification 

With the specification generated, you can now select the period of time of historical log requests to base the specification on. Choose from:

  • Last hour
  • Last day
  • Last month
  • Last 3 months
  • Custom - enter a Start date and an End date.

Select to view the file as a JSON or YAML file.

Make inline edits directly to the file to modify or adjust the specification. These changes are instantly visible in the swagger interface. In this interface, you can visualize and test out the API in action. To do this:

  1. Expand the request.
  2. Click Try it out.
  3. (Optional) Enter any required parameters.
  4. Click Execute.

You can download the file in JSON or YAML formats.  Click the Download button beside the file type.

Upload specification

The file can also be uploaded directly to FireTail. Click Upload Spec, the specification will open instantly. It also appears under the specification tab of the API.