プロジェクト API 変更ログ
この変更ログでは、 プロジェクト API の最新の変更、改善、および更新について知ることができます。 この変更ログでは、行われた変更をリリース日付の順にリストしています。 既存の API バージョンに対する変更は、既存のクライアント・アプリケーションの互換性が確保されるように設計されています。
2024 年 4 月 3 日
プロジェクト API v1.0.0 が使用可能になりました。 必ずベータ版からバージョンを更新してください。
以下の変更は、 list 操作のページ編集に影響します。 詳しくは、Projects API の資料の pagination セクションを参照してください。
リスト・プロジェクト
GET /v1/projects
- ページ・トークン照会パラメーターの名前が
startからtokenに変更されました。- 例えば、
list-projects操作の呼び出しがGET /v1/projects?limit=5&start={page_token}からGET /v1/projects?limit=5&token={page_token}に変更されました。
- 例えば、
- 最初のページは、要求 URL にトークン照会パラメーターなしで返されます。 例えば、
GET /v1/projects?limit=5またはGET /v1/projectsなどです。- 最初のページは、指定されたページ・トークンが無効な場合にも戻されます。
lastフィールドとpreviousフィールドはサポートされなくなり、応答ペイロードにも含まれなくなりました。
リスト構成
GET /v1/projects/{project_id}/configs
- この操作は現在ページ編集されています。
- ページ・サイズが
limit照会パラメーターで指定されていない場合は、デフォルトの 10 レコードが返されます。- 最大ページ・サイズは 100 レコードです。
- 最初のページは、要求 URL にトークン照会パラメーターなしで返されます。 例えば、
GET /v1/projects/{project_id}/configs/?limit=5またはGET /v1/projects/{project_id}/configsなどです。- 最初のページは、指定されたページ・トークンが無効な場合にも戻されます。
リスト環境
GET /v1/projects/{project_id}/environments
- この操作は現在ページ編集されています。
limit照会パラメーターでページ・サイズが指定されていない場合は、デフォルトの 10 レコードが返されます。- 最大ページ・サイズは 100 レコードです。
- 最初のページは、要求 URL に
token照会パラメーターを指定せずに返されます。 例えば、GET /v1/projects/{project_id}/environments/?limit=5またはGET /v1/projects/{project_id}/environmentsなどです。- 最初のページは、指定されたページ・トークンが無効な場合にも戻されます。
デプロイ可能なアーキテクチャーのスタッキングをサポートする方法
実験
デプロイ可能なアーキテクチャーのスタック をサポートするための試験的メソッドが追加されました。
2023 年 11 月 6 日
最新の更新には、以下の互換性のない変更が含まれています。
- すべてのメソッドの
configurationsresponseモデルは、pipeline_stateを使用しなくなりました。configurationのすべての状況情報は、configurationの正規スキーマの拡張されたstateプロパティーで使用可能です。
プロジェクトおよび構成の変更
create-project: POST /v1/projects
- これで、
resource_groupおよびlocationがrequestペイロードに組み込まれます。 これらは、照会パラメーターとしてサポートされなくなりました。
delete-config: PATCH /v1/projects/{project_id}/configs/{id}
draft_only照会パラメーターは推奨されません。- API は、指定されたプロジェクト ID および
versionのconfigurationの削除をサポートするようになりました。 projects#delete-config-version を参照してください。
名前変更された構成エンドポイント
以下の構成エンドポイントは、以下のように名前変更されます。
POST /v1/projects/{project_id}/configs/{id}/checkはPOST /v1/projects/{project_id}/configs/{id}/validateに変更されました。POST /v1/projects/{project_id}/configs/{id}/installはPOST /v1/projects/{project_id}/configs/{id}/deployに変更されました。POST /v1/projects/{project_id}/configs/{id}/uninstallはPOST /v1/projects/{project_id}/configs/{id}/undeployに変更されました。
置換された構成エンドポイント
drafts メソッドは、以下のように versions 操作に置き換えられました。
GET /v1/projects/{project_id}/configs/{config_id}/draftsはGET /v1/projects/{project_id}/configs/{id}/versionsに変更されました。GET /v1/projects/{project_id}/configs/{config_id}/drafts/{version}はGET /v1/projects/{project_id}/configs/{id}/versions/{version}に変更されました。
構成状態
configurations の状態モデルはフラット化されています。 pipeline_state は使用できなくなり、1 つの state プロパティーが拡張されて、 configuration の考えられるすべての状況が取り込まれるようになりました。
以下に、新しい state 値を示します。
approveddeleteddeletingdeleting_faileddiscardeddeployeddeploying_faileddeployingsupercededundeployingundeploying_failedvalidatedvalidatingvalidating_failed
すべての configuration エンドポイントは、この state プロパティーを response モデルに組み込みます。 例については、 projects#get-config-version-response を参照してください。
新規メタデータの構成
configurations 操作の response モデルで、新規メタデータがルートに定義されるようになりました。 approve ジョブが configuration で実行された場合、 approved_version プロパティーが response ペイロードに含まれます。 同様に、 deploy ジョブが configuration で実行された場合、 response 本体で deployed_version および last_deployed メタデータが使用可能です。 validation ジョブを実行するとメタデータ last_validated が生成され、 undeploy ジョブを実行するとメタデータ last_undeployed が response に生成されます。
2023 年 10 月 25 日
create や update などの projects および configurations 操作では、 name や description などの定義プロパティーを definition ラッパーで提供する必要があります。 同様に、これらのプロパティーは、 create、
update、 get、および list 操作の response ペイロードの definition ブロック内でのみ使用できるようになりました。 これは、2023 年 7 月 6 日に最初にリリースされた破壊的な変更です。 以下のセクションでは、この更新の影響を受けるメソッドについて詳しく説明します。
プロジェクト
create-project: POST /v1/projects
request&responseでは、name、description、およびdestroy_on_deleteの両方がdefinitionオブジェクト内でラップされるようになりました。- これで、このエンドポイントの呼び出し元は、このラッパー内の定義プロパティーを提供することになります。以下に例を示します。
definition: {“name”: “test”, “description”: “This is a test project”, “destroy_on_delete”: false}.destroy_on_deleteが指定されていない場合、プロジェクト作成操作でデフォルト値trueが割り当てられます。
- projects#create-project-request を参照してください。
- 同様に、
response本体では、前述のプロパティーがdefinitionブロックで使用可能になりました。- projects#create-project-response を参照してください。
update-project: PATCH /v1/projects/{id}
request&responseでは、name、description、およびdestroy_on_deleteの両方がdefinitionオブジェクト内でラップされるようになりました。- これで、このエンドポイントの呼び出し元は、このラッパー内の定義プロパティーを提供することになります。以下に例を示します。
definition: {“name”: “test_update”, “description”: “This is an updated test project“}.- projects#update-project-request を参照してください。
- 同様に、
response本体では、前述のプロパティーがdefinitionブロックで使用可能になりました。- projects#update-project-response を参照してください。
get-projects: GET /v1/projects/{id}
- この操作の
responseでは、name、description、およびdestroy_on_deleteがdefinitionブロック内でラップされるようになりました。- projects#get-project-response を参照してください。
list-project: GET /v1/projects
response配列で返される各プロジェクトは、definitionブロック内のname、description、およびdestroy_on_deleteプロパティーをラップします。- projects#list-projects-response を参照してください。
構成
create-config: POST /v1/projects/{project_id}/configs
- 両方の
request&responseで、locator_id、name、labels、authorizations、compliance_profile、input、setting、descriptionがdefinitionオブジェクト内でラップされるようになりました。 - これで、このエンドポイントの呼び出し元は、このラッパー内の定義プロパティーを提供することになります。以下に例を示します。
definition: {“name”: “test”, “description”: “This is a test config”, “locator_id”: “1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.cd596f95-95a2-4f21-9b84-477f21fd1e95-global”}.- projects#create-config-request を参照してください。
- 同様に、
response本体では、前述のプロパティーがdefinitionブロックで使用可能になりました。settingプロパティーもdefinitionブロックに含まれています。- projects#create-config-response を参照してください。
update-config: PATCH /v1/projects/{project_id}/configs/{id}
- 両方の
request&responseで、locator_id、name、labels、authorizations、compliance_profile、input、setting、descriptionがdefinitionオブジェクト内でラップされるようになりました。 - これで、このエンドポイントの呼び出し元は、このラッパー内の定義プロパティーを提供することになります。以下に例を示します。
definition: {“name”: “test”, “description”: “This is a test config”, “locator_id”: “1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc.cd596f95-95a2-4f21-9b84-477f21fd1e95-global”}.- projects#update-config-request を参照してください。
- 同様に、
response本体では、前述のプロパティーがdefinitionブロックに移動されます。- projects#update-config-response を参照してください。
get-config: GET /v1/projects/{id}
- この操作の
responseでは、locator_id、name、labels、authorizations、compliance_profile、input、setting、description、およびsettingがdefinitionオブジェクト内でラップされるようになりました。- projects#get-config-response を参照してください。
list-configs: GET /v1/projects/{project_id}/configs
- この操作の
responseでは、nameとdescriptionがdefinitionオブジェクト内でラップされるようになりました。- projects#list-configs-response を参照してください。
2023 年 7 月 6 日
すべてのメソッドの応答モデルで、 state 値に小文字のスネーク・ケース・フォーマットが適用されるようになりました。 この形式は、プロジェクト・エンドポイントおよび構成エンドポイントを呼び出すときに、応答で予期されるものです。 この更新は、互換性のない変更です。
プロジェクトの state 値を ready、 deleting、および deleting_failed にできるようになりました。 例については、 update-project メソッドの応答スキーマ を参照してください。
構成 state 値は、 deleted、 deleting、 deleting_failed、 installed、 installed_failed、 installing、 not_installed、 uninstalling、 uninstalling_failed、および
active にすることができるようになりました。 例については、 get-config メソッドの応答スキーマ を参照してください。