[ENG-8143] Add GravyValet page #79
Open
+11,235
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cslzchen
reviewed
Jul 9, 2025
futa-ikeda
approved these changes
Jul 10, 2025
| - addon-operation-invocations | ||
| /v1/addon-operation-invocations/{id}/: | ||
| get: | ||
| description: Get singular instance of addon operation invocation by it's pk. |
There was a problem hiding this comment.
Suggested change
| description: Get singular instance of addon operation invocation by it's pk. | |
| description: Get singular instance of addon operation invocation by its pk. |
Comment on lines
+6752
to
+6867
| - account_owner | ||
| - api_base_url | ||
| - auth_url | ||
| - authorized_capabilities | ||
| - authorized_operations | ||
| - authorized_operation_names | ||
| - configured_storage_addons | ||
| - credentials | ||
| - default_root_folder | ||
| - external_storage_service | ||
| - initiate_oauth | ||
| - credentials_available | ||
| type: string | ||
| type: array | ||
| - description: A UUID string identifying this Authorized Storage Account. | ||
| in: path | ||
| name: id | ||
| required: true | ||
| schema: | ||
| format: uuid | ||
| type: string | ||
| - description: include query parameter to allow the client to customize which | ||
| related resources should be returned. | ||
| explode: false | ||
| in: query | ||
| name: include | ||
| schema: | ||
| items: | ||
| enum: | ||
| - account_owner | ||
| - external_storage_service | ||
| - configured_storage_addons | ||
| - authorized_operations | ||
| type: string | ||
| type: array | ||
| responses: | ||
| '200': | ||
| content: | ||
| application/vnd.api+json: | ||
| schema: | ||
| $ref: '#/components/schemas/AuthorizedStorageAccountResponse' | ||
| description: '' | ||
| tags: *id001 | ||
| /v1/addon-operation-invocations/{id}/thru_addon: | ||
| get: | ||
| description: Fetch AddonOperationInvocation's ConfiguredStorageAddon | ||
| operationId: addon_operation_invocations_retrieve_2_related_thru_addon | ||
| parameters: | ||
| - description: endpoint return only specific fields in the response on a per-type | ||
| basis by including a fields[TYPE] query parameter. | ||
| explode: false | ||
| in: query | ||
| name: fields[configured-storage-addons] | ||
| schema: | ||
| items: | ||
| enum: | ||
| - id | ||
| - url | ||
| - display_name | ||
| - root_folder | ||
| - base_account | ||
| - authorized_resource | ||
| - authorized_resource_uri | ||
| - connected_capabilities | ||
| - connected_operations | ||
| - connected_operation_names | ||
| - external_storage_service | ||
| - current_user_is_owner | ||
| - external_service_name | ||
| type: string | ||
| type: array | ||
| - description: A UUID string identifying this Configured Storage Addon. | ||
| in: path | ||
| name: id | ||
| required: true | ||
| schema: | ||
| format: uuid | ||
| type: string | ||
| - description: include query parameter to allow the client to customize which | ||
| related resources should be returned. | ||
| explode: false | ||
| in: query | ||
| name: include | ||
| schema: | ||
| items: | ||
| enum: | ||
| - base_account | ||
| - external_storage_service | ||
| - authorized_resource | ||
| - connected_operations | ||
| type: string | ||
| type: array | ||
| responses: | ||
| '200': | ||
| content: | ||
| application/vnd.api+json: | ||
| schema: | ||
| $ref: '#/components/schemas/ConfiguredStorageAddonResponse' | ||
| description: '' | ||
| tags: *id001 |
There was a problem hiding this comment.
These two section seem to imply that the thru_account and thru_addon relationships are only AuthorizedStorageAccount and ConfiguredStorageAddons. Is it the case that these could eventually be any kind of AuthorizedAccount or ConfiguredAddon?
| type: string | ||
| type: array | ||
| responses: | ||
| '200' |
There was a problem hiding this comment.
Suggested change
| '200' | |
| description: Get resource reference by its pk |
| type: string | ||
| type: array | ||
| responses: | ||
| '200' |
There was a problem hiding this comment.
Similar typo and question here re: list endpoint returning only one thing
Suggested change
| '200' | |
| description: Get user reference by user_uri. Even though this is a list method, |
| type: string | ||
| type: array | ||
| responses: | ||
| '200' |
There was a problem hiding this comment.
Suggested change
| '200' | |
| description: Get user reference by its pk |
|
Huh, some of my review comments are not pointing at the correct lines... let me see if I can fix that |
futa-ikeda
reviewed
Jul 10, 2025
Comment on lines
7446
to
8681
| - authorized_operations | ||
| type: string | ||
| type: array | ||
| responses: | ||
| '200' |
There was a problem hiding this comment.
I don't think I've set up a computing account but is this true that you need a root_folder for setting up a configured-computing-addon?
futa-ikeda
reviewed
Jul 10, 2025
| type: string | ||
| type: array | ||
| responses: | ||
| '200' |
There was a problem hiding this comment.
One typo and one comment. Not really within the scope of this PR, but this feels a bit strange to me that this is a list view, but we only expect to show one item. Maybe it's not too weird though 🤷
Suggested change
| '200' | |
| description: Get resource reference by resource_uri. Even though this is a |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
Add API documentation for GV
Ticket
https://openscience.atlassian.net/browse/ENG-8143