Topic title - Fluid Topics - Latest

OpenAPI Connector Reference Guide

Category
Reference Guides
Audience
public
Version
Latest

An OpenAPI document comprises paths, which contain operations.

The OpenAPI connector transforms each operation into a topic.

As the OpenAPI specification does not require a title for each operation, Fluid Topics generates topic titles as follows:

  1. If the operation has a summary field, it becomes the topic title.
  2. In the absence of a summary field, the operationId field becomes the topic title.
  3. In the absence of a summary and operationId field, the description field becomes the topic title.
  4. In the absence of all of the aforementioned fields, the OpenAPI connector generates a title based on the path and operation.
    For example: for a GET /user/{userId} web service, the title is GetUserUserId.