はじめに
Red Hat Quay アプリケーションプログラミングインターフェイス (API) は、Red Hat Quay 内でタスクを管理および自動化するための包括的な RESTful インターフェイスを提供します。OAuth 2.0 プロトコル に基づいて設計されたこの API は、Red Hat Quay リソースへの安全できめ細かいアクセスを可能にし、管理者とユーザーがリポジトリーの作成、イメージの管理、権限の設定などのアクションを実行できるようにします。
Red Hat Quay はセマンティックバージョニング (SemVer) の原則に従っており、次のようなリリース間で予測可能な API の安定性を確保しています。
- メジャーリリース: 新しい機能を導入します。API 互換性に対する重大な変更が含まれる可能性があります。たとえば、Red Hat Quay 2.0 の API は Red Hat Quay 3.0 とは異なります。
- マイナーリリース: 下位互換性を保ちながら新しい機能を追加します。たとえば、3.y リリースではバージョン 3. リリースに機能が追加されます。
- パッチリリース: 3.y.z などのマイナーリリースとの下位互換性を維持しながら、バグ修正と改善を提供します。
次のガイドでは、Red Hat Quay API についてさらに詳しく説明し、以下のトピックの詳細を示します。
- OAuth 2 アクセストークンと、従来の API トークンおよび Red Hat Quay のロボットトークンとの比較
- OAuth 2 アクセストークンの生成
- トークン管理のベストプラクティス
- OAuth 2 アクセストークンの機能
- Red Hat Quay API の使用
- Red Hat Quay API 設定例
このガイドには、すべての api/v1 エンドポイントに関する情報と、サンプルコマンドを使用してそれらのエンドポイントにアクセスする方法が記載された 2 番目のガイドが付属されています。
