Document metadata - Fluid Topics - Latest

OpenAPI Connector Reference Guide

Reference Guides

For each OpenAPI document uploaded to a portal, Fluid Topics displays the metadata described in the info section of the OpenAPI Specification as follows:

  • title and version are mandatory. Fluid Topics transforms these values into the ft:title and openapi:version metadata.

  • summary is optional, and appears when previewing the document in the Search page.

  • description is optional, and serves as an introduction for the OpenAPI document. The description section supports the Markdown format (in the CommonMark syntax).

  • Fluid Topics derives the document's originId from the document's path in the archive.