Sign in

v1

latestOpenAPI 3.1.12026-07-1744285.2 KB
gateway

Get config file

A basic OpenAPI config file is not required but can add context to the API provided by the gateway. If none is provided Direktiv generates a virtual one with a basic configuration. The paths section is autogenerated based on the route files provided in the namespace.

get/api/v2/namespaces/{namespace}/gateway/info

Path parameters

namespacestring required

Query parameters

expandstring

Includes all relative files into one OpenAPI spec file

serverstring

Includes a server name into the spec

Response

Basic configuration file for gateway in the namespace

errorsstring[]
warningsstring[]
file_pathstring

path to file in file tree

specobject

contains an OpenAPI spec object. The paths section is replaced based on the routes in the namespace.

Example response

{
  "file_path": "/my/path.yaml"
}