Skip to content

OpenAPI: Add storage-credentials to CompletedPlanningResult #14563

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+15 −0
Open

OpenAPI: Add storage-credentials to CompletedPlanningResult #14563

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
961fc6e
update IRC spec add storage-credentials to CompletedPlanningResult
ajreid21 Nov 12, 2025
cbe574f
add description
ajreid21 Nov 12, 2025
a1453db
fix
ajreid21 Nov 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions open-api/rest-catalog-open-api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1493,6 +1493,9 @@ class CompletedPlanningResult(ScanTasks):
"""

status: Literal['completed'] = Field(..., const=True)
storage_credentials: Optional[List[StorageCredential]] = Field(
Copy link
Contributor Author

@ajreid21 ajreid21 Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I put these as optional, anyone have thoughts or opinions if these should be required?

None, alias='storage-credentials'
)


class FetchScanTasksResult(ScanTasks):
Expand Down
4 changes: 4 additions & 0 deletions open-api/rest-catalog-open-api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3372,6 +3372,10 @@ components:
status:
$ref: '#/components/schemas/PlanStatus'
const: "completed"
storage-credentials:
Copy link
Contributor

@singhpk234 singhpk234 Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we should have description here stating these creds are subscoped to scan or something, thoughts ?

Copy link
Contributor Author

@ajreid21 ajreid21 Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure the spec should dictate or be opinionated that the creds are specifically subscoped, just that the client should be able to use these creds to access files returned in the scan result, but if others feel strongly, I'm not totally opposed.

Copy link
Contributor

@nastra nastra Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that we shouldn't have wording in the spec saying that the creds are subscoped. It is up to the server to subscope those or not

Copy link
Contributor

@singhpk234 singhpk234 Nov 12, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

my understanding if the creds are present in the scan response we should not use the creds that were vended in loadTable ? hence some literature around of these cred should be the one used when server returns it irrespective of what was vended from the loadTable ?

Copy link
Contributor Author

@ajreid21 ajreid21 Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a description, let me know if that works or it needs re-wording

type: array
items:
$ref: '#/components/schemas/StorageCredential'

CompletedPlanningWithIDResult:
type: object
Expand Down