Qdrant API Documentation

This repo contains the configuration files for Qdrant's API documentation. The documentation is built using Fern.

The website is available at api.qdrant.tech.

What does this repo contain?

• OpenAPI Specs
• Docs Configuration
• GitHub Workflows

How to sync OpenAPI specs?

Either manually, by running the script:

bash -x tools/sync-openapi.sh

Note

This script requires yq and python to be present in the system.

Or automatically, just create a PR, and preview action will automatically try to sync and re-generate all the docs it can.

How to update snippets?

The source of truth for the snippets is located in snippets folder, edit it there. File names should match the operationId of the OpenAPI spec.

After editing, follow the How to sync OpenAPI specs? steps to automatically reflect the changes for the latest version of the API.

How to deploy the documentation?

To update your documentation, run

# npm install -g fern-api 
fern generate --docs

To preview your documentation, run

# npm install -g fern-api
fern generate --docs --preview

The repository contains GitHub workflows that will automatically run these commands for you. For example, when you make a PR a preview link will be auto-generated and when you merge to main the docs site will update.