From 961fc6e842bca08659739d7a0d8177d7a1b91c4a Mon Sep 17 00:00:00 2001 From: Alex Reid <5721775+ajreid21@users.noreply.github.com> Date: Tue, 11 Nov 2025 16:39:25 -0800 Subject: [PATCH 1/3] update IRC spec add storage-credentials to CompletedPlanningResult --- open-api/rest-catalog-open-api.py | 3 +++ open-api/rest-catalog-open-api.yaml | 4 ++++ 2 files changed, 7 insertions(+) diff --git a/open-api/rest-catalog-open-api.py b/open-api/rest-catalog-open-api.py index 1709ba260feb..4bcf6d9678c1 100644 --- a/open-api/rest-catalog-open-api.py +++ b/open-api/rest-catalog-open-api.py @@ -1493,6 +1493,9 @@ class CompletedPlanningResult(ScanTasks): """ status: Literal['completed'] = Field(..., const=True) + storage_credentials: Optional[List[StorageCredential]] = Field( + None, alias='storage-credentials' + ) class FetchScanTasksResult(ScanTasks): diff --git a/open-api/rest-catalog-open-api.yaml b/open-api/rest-catalog-open-api.yaml index a75ade7eaeca..a66c163e1abc 100644 --- a/open-api/rest-catalog-open-api.yaml +++ b/open-api/rest-catalog-open-api.yaml @@ -3372,6 +3372,10 @@ components: status: $ref: '#/components/schemas/PlanStatus' const: "completed" + storage-credentials: + type: array + items: + $ref: '#/components/schemas/StorageCredential' CompletedPlanningWithIDResult: type: object From cbe574f0dcd55f0f7e33c2a6e0b7cebf288dc3ad Mon Sep 17 00:00:00 2001 From: Alex Reid <5721775+ajreid21@users.noreply.github.com> Date: Wed, 12 Nov 2025 08:11:47 -0800 Subject: [PATCH 2/3] add description --- open-api/rest-catalog-open-api.yaml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/open-api/rest-catalog-open-api.yaml b/open-api/rest-catalog-open-api.yaml index a66c163e1abc..0877b44e728a 100644 --- a/open-api/rest-catalog-open-api.yaml +++ b/open-api/rest-catalog-open-api.yaml @@ -3374,6 +3374,12 @@ components: const: "completed" storage-credentials: type: array + description: + Storage credentials for accessing the files returned in the scan result. + + If the server returns storage credentials as part of the completed scan + planning response, the expectation is for the client to use these credentials + to read the files returned in the FileScanTasks as part of the scan result. items: $ref: '#/components/schemas/StorageCredential' From a1453db652737a10fd9621f1c7656ee871896bd6 Mon Sep 17 00:00:00 2001 From: Alex Reid <5721775+ajreid21@users.noreply.github.com> Date: Wed, 12 Nov 2025 08:40:28 -0800 Subject: [PATCH 3/3] fix --- open-api/rest-catalog-open-api.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/open-api/rest-catalog-open-api.py b/open-api/rest-catalog-open-api.py index 4bcf6d9678c1..ba8825cb2a27 100644 --- a/open-api/rest-catalog-open-api.py +++ b/open-api/rest-catalog-open-api.py @@ -1494,7 +1494,9 @@ class CompletedPlanningResult(ScanTasks): status: Literal['completed'] = Field(..., const=True) storage_credentials: Optional[List[StorageCredential]] = Field( - None, alias='storage-credentials' + None, + alias='storage-credentials', + description='Storage credentials for accessing the files returned in the scan result.\nIf the server returns storage credentials as part of the completed scan planning response, the expectation is for the client to use these credentials to read the files returned in the FileScanTasks as part of the scan result.', )