SourcesManagement

OpenAPI Spec

Copy page

Learn how to manage OpenAPI spec sources in Inkeep

Overview

An OpenAPI spec source allows Inkeep to ingest an OpenAPI specification file.

Configuration Parameters

URL

Specifies the location where your OpenAPI specification is hosted.

Requirements:

  • The URL must be publicly accessible (no authentication required)
  • The specification must be valid OpenAPI/Swagger format

Citation URL

Specifies the location of your API documentation pages that correspond to the OpenAPI specification. When using the openapi spec in its answers, Inkeep will use this link as a citation.

On this page