This repository contains a starting point for documenting an API with OpenAPI and displaying the documentation using Framna Docs.
The repository contains the following files.
| File | Description |
|---|---|
| openapi.yml | An OpenAPI specification that documents the API. |
| .framna-docs.yml | A configuration file that specifies the project name and icon to show on Framna Docs. For more information, see the documentation of Framna Docs. |
| icon.png | Thee icon displayed on Framna Docs. |
| .spectral.yml | A configuration file for the open-source Spectral linter that can be used to validate the OpenAPI specification in openapi.yml. |
| .github/workflows/lint.yml | A workflow that lints the OpenAPI specification in pull requests using the Spectral linter. |