API プレビューを使用すると、正式に GitHub API の一部になる前に、新しい API や既存の API メソッドへの変更を試すことができます。
プレビュー期間中は、開発者からのフィードバックに基づいて機能を変更することがあります。 変更をする際には、事前の通知なく開発者blogでアナウンスします。
API プレビューにアクセスするには、リクエストの Accept
ヘッダー内でカスタムのメディアタイプを提供しなければなりません。 各プレビューの機能ドキュメントに、どのカスタムメディアタイプを提供するのかが示されています。
強化されたデプロイメント
より多くの情報と細かい粒度で、デプロイメントをより詳細に制御します。
カスタムメディアタイプ: ant-man-preview
発表日: 2016-04-06
リアクション
コミット、Issue、コメントに対するリアクションを管理します。
カスタムメディアタイプ: squirrel-girl-preview
発表日: 2016-05-12 更新日: 2016-06-07
タイムライン
Issue またはプルリクエストのイベントのリストを取得します。
カスタムメディアタイプ: mockingbird-preview
発表日: 2016-05-23
ページ
GitHub Pages サイトの詳細情報を取得します。
カスタムメディアタイプ: mister-fantastic-preview
発表日: 2016-07-06
pre-receive 環境
pre-receive フックの環境を作成、一覧表示、更新、削除します。
カスタムメディアタイプ: eye-scream-preview
発表日: 2015-07-29
プロジェクト
プロジェクトを管理します。
カスタムメディアタイプ: inertia-preview
発表日: 2016-09-14 更新日: 2016-10-27
コミット検索
コミットの検索をします。
カスタムメディアタイプ: cloak-preview
発表日: 2017-01-05
リポジトリトピック
リポジトリの結果を返す呼び出しでリポジトリトピックのリストを表示します。
カスタムメディアタイプ: mercy-preview
発表日: 2017-01-31
行動規範
すべての行動規範を表示するか、リポジトリに現在ある行動規範を取得します。
カスタムメディアタイプ: scarlet-witch-preview
入れ子チーム
入れ子チームコンテンツを Team ペイロードに含めます。
カスタムメディアタイプ: hellcat-preview
発表日: 2017-09-01
グローバル webhook
Organization およびユーザイベントタイプのグローバル webhook を有効にします。 この API プレビューは GitHub Enterprise Server でのみ使用できます。
カスタムメディアタイプ: superpro-preview
発表日: 2017-12-12
リポジトリ移譲
リポジトリを Organization またはユーザに移譲します。
カスタムメディアタイプ: nightshade-preview
発表日: 2017-11-09
ロック理由の追加
Issue をロックするときに理由を追加できるようになりました。
カスタムメディアタイプ: sailor-v-preview
発表日: 2018-01-10
Team ディスカッション
API を使用して、Team ディスカッションと Team ディスカッションコメントを管理できるようになりました。
カスタムメディアタイプ: echo-preview
発表日: 2018-02-07
署名済みコミットの必須化
これで、API を使用して、保護されたブランチで署名済みコミットを必須にするための設定を管理できます。
カスタムメディアタイプ: zzzax-preview
発表日: 2018-02-22
複数の承認レビューの必須化
API を使用して、プルリクエストに対して複数の承認レビューを必須にすることができるようになりました。
カスタムメディアタイプ: luke-cage-preview
発表日: 2018-03-16
ホバーカード情報の取得
ユーザのホバーカードから情報を取得します。
カスタムメディアタイプ: hagar-preview
発表日: 2018-03-21
チェック実行とチェックスイート API
GitHub App がリポジトリのコードに対して外部チェックを実行できるようにします。 詳細については、チェック実行とチェックスイート API をご覧ください。
カスタムメディアタイプ: antiope-preview
発表日: 2018-05-07
リポジトリへの匿名 Git アクセス
GitHub Enterprise Server インスタンスがプライベートモードの場合、サイトおよびリポジトリの管理者は、パブリックリポジトリに対して匿名の Git アクセスを有効にすることができます。
カスタムメディアタイプ: x-ray-preview
発表日: 2018-07-12
プロジェクトカードの詳細
Issue イベントおよび Issue タイムラインイベントの REST API 応答は、プロジェクト関連イベントの project_card
フィールドを返すようになりました。
カスタムメディアタイプ: starfox-preview
発表日: 2018-09-05
デプロイメントステータス
デプロイメントステータスの環境
を更新し、in_progress
および queued
ステータスを使用できるようになりました。 デプロイメントステータスを作成するときに、auto_inactive
パラメータを使用して、古い本番
デプロイメントを inactive
としてマークできるようになりました。
カスタムメディアタイプ: flash-preview
発表日: 2018-10-16
リポジトリの作成権限
Organization メンバーによるリポジトリの作成可否、および作成可能なリポジトリのタイプを設定できるようになりました。 詳細については、「Organization を更新する」を参照してください。
カスタムメディアタイプ: surtur-preview
発表日: 2019-12-03
コンテンツの添付
Content Attachments API を使用して、登録されたドメインにリンクする URL の詳細情報を GitHub で提供できるようになりました。 詳細については、「添付コンテンツを使用する」を参照してください。
カスタムメディアタイプ: corsair-preview
発表日: 2018-12-10
ドラフトプルリクエスト
ドラフトプルリクエスト API とそのプルリクエストエンドポイントを使用して、プルリクエストがドラフト状態かどうかを確認できます。 ドラフトプルリクエストについての詳細は、「プルリクエストについて」を参照してください。
カスタムメディアタイプ: shadow-cat-preview
発表日: 2019-02-14
Pages の有効化と無効化
Pages API の新しいエンドポイントを使用して、Pages を有効または無効にできます。 Pages の詳細については、「GitHub Pages の基本 」を参照してください。
カスタムメディアタイプ: switcheroo-preview
発表日: 2019-03-14
コミットのブランチまたはプルリクエストの一覧表示
Commits API で 2 つの新しいエンドポイントを使用して、コミットのブランチまたはプルリクエストを一覧表示できます。
カスタムメディアタイプ: groot-preview
発表日: 2019-04-11
GitHub App のアンインストール
GitHub App の所有者は、Apps API を使用してアプリケーションをアンインストールできるようになりました。
カスタムメディアタイプ: gambit-preview
リポジトリの脆弱性アラートの有効化または無効化
Repos API で 2 つの新しいエンドポイントを使用して、脆弱性アラートを有効化または無効化できます。
カスタムメディアタイプ: dorian-preview
発表日: 2019-04-24
プルリクエストブランチの更新
新しいエンドポイントを使用して、プルリクエストブランチを上流ブランチの HEAD からの変更で更新できます。
カスタムメディアタイプ: lydian-preview
発表日: 2019-05-29
リポジトリテンプレートの作成および使用
新しいエンドポイントで、テンプレートを使用してリポジトリを作成し、is_template
パラメータを true
に設定して、テンプレートリポジトリである認証済みユーザのリポジトリを作成できます。 is_template
キーを使用して、リポジトリを取得し、テンプレートリポジトリとして設定されているかどうかを確認します。
カスタムメディアタイプ: baptiste-preview
発表日: 2019-07-05