Katana OpenAPI Client Documentation

This directory contains all documentation specific to the katana-openapi-client package.

Documentation Index

User Guides

• Client Guide - Comprehensive guide to using the Katana OpenAPI Client
• Cookbook - Common usage patterns and recipes
• Testing Guide - Testing strategy and test coverage

Maintainer Guides

• OpenAPI Spec Authoring - OpenAPI 3.1 conventions, generator/regen lockstep, ListResponse shape, breaking-change markers, privacy rules. Read this before editing docs/katana-openapi.yaml.

Reference

• Changelog - Release history and version notes
• ADRs - Architecture Decision Records

Quick Links

• Main Repository README - Project overview
• Contributing Guide - How to contribute
• API Documentation - Live docs site

Related Packages

This monorepo also contains:

• katana-mcp-server - MCP server for Claude Code integration