バージョニング
APIは/v1プレフィックスの下でバージョン管理されています——現在の状態は次のとおりです。
すべてのエンドポイントは/v1の下にあります
このリファレンス内のすべてのパスには/v1というプレフィックスが付いています(/chatではなく/v1/chat)。唯一の例外は/healthで、これは意図的にプレフィックスなしのままになっています——これはバージョン管理された公開契約の一部ではなく、インフラのliveness checkであり、監視ツールはプレフィックスのないパスを指しています。
機械可読なOpenAPI仕様が、APIそのものによって公開されるようになりました——生のJSONは/docs-jsonに、インタラクティブなSwagger UIは/docsにあります——これらは実際のルートハンドラーとリクエスト/レスポンスの型から直接生成されるため、手書きの文章のように密かに乖離することがありません。このページは現時点ではまだ手書きです。手で説明する代わりに、生成された仕様を直接表示するように移行することが自然な次のステップですが、まだ実現していません。