Skip to content

Latest commit

 

History

History
43 lines (36 loc) · 1.29 KB

openapi.md

File metadata and controls

43 lines (36 loc) · 1.29 KB
Raw
title description lead date lastmod draft images menu weight toc
OpenAPI
A plugin that fetches OpenAPI specs and uses them to render OpenAPI based API documentation.
A plugin that fetches OpenAPI specs and uses them to render OpenAPI based API documentation.
2022-05-11 20:00:00 +0000
2022-05-11 20:00:00 +0000
false
docs
parent
plugins
515
true

Features

Finds JSON and YAML format OpenAPI spec files in cloned Git repos and loads those OpenAPI specs into Kronicle. Can also download OpenAPI specs from URLs configured in kronicle.yaml files.

Any found/download OpenAPI specs are loaded into Kronicle and can be viewed via Kronicle's web UI.

Adding OpenAPI spec details to a kronicle.yaml metadata file

OpenAPI specs can be set in a /kronicle.yaml file in a Git repo:

components:
  - id: some-component
    name: Some Component
    type: some-component-type
    repo:
        url: https://git.example.com/some-repo
    # 1 or more GraphQL schemas can be specified
    openApiSpecs:
      - url: https://demo.kronicle.tech/openapi
        description: |
          Example OpenAPI spec served via a URL
      - file: some-dir/example-openapi-spec.yaml
        description: |
          Example OpenAPI spec in the https://git.example.com/some-repo repo