upcoming: [UIE-9343] - Add API endpoints and types for `/v4/images/sharegroups/members` and `/v4/images/sharegroups/tokens` by harsh-akamai · Pull Request #12984 · linode/manager

harsh-akamai · 2025-10-14T06:46:04Z

Description 📝

Add new /v4beta/images/sharegroups/members & /v4beta/images/sharegroups/tokens endpoints for Private Image Sharing feature

This is part of a 2 PR split that covers all the endpoints, validation and type changes for the new Private Image Sharing feature (PR #2)

Changes 🔄

This PR covers the CRUD endpoints for Sharegroup members and tokens

Scope 🚢

Upon production release, changes in this PR will be visible to:

All customers
Some customers (e.g. in Beta or Limited Availability)
No customers / Not applicable

How to test 🧪

Verification steps

Confirm changes match API spec(added in the Parent ticket)

Author Checklists

As an Author, to speed up the review process, I considered 🤔

👀 Doing a self review
❔ Our contribution guidelines
🤏 Splitting feature into small PRs
➕ Adding a changeset
🧪 Providing/improving test coverage
🔐 Removing all sensitive information from the code and PR description
🚩 Using a feature flag to protect the release
👣 Providing comprehensive reproduction steps
📑 Providing or updating our documentation
🕛 Scheduling a pair reviewing session
📱 Providing mobile support
♿ Providing accessibility support

I have read and considered all applicable items listed above.

As an Author, before moving this PR from Draft to Open, I confirmed ✅

All tests and CI checks are passing
TypeScript compilation succeeded without errors
Code passes all linting rules

…aregroups`

abailly-akamai

Looks good, thx for the clean code and good conventions

Left a few comments to consider to wrap this up

abailly-akamai · 2025-10-14T07:45:53Z

packages/api-v4/src/images/images.ts

+    setParams(params),
+    setXFilter(filters),
+  );
+};


I don't think it makes sense to isolate this particular endpoint under images.

It belongs to the sharegroups namespace

abailly-akamai · 2025-10-14T07:45:56Z

packages/api-v4/src/images/sharegroup.ts

We should be consistent with the file naming as well (all lower caps)

I did find nodePool.ts to follow the camelCasing though 🤔

Right but nodePool is camel case everywhere. this file name is the only instance of shareGroups being camel case

It's not a big deal, just a consistency nit. does not matter much to me

abailly-akamai · 2025-10-14T07:51:52Z

packages/api-v4/src/images/sharedGroups.ts

+  sharegroupId: string,
+  imageId: string,
+  data: UpdateSharegroupImagePayload,
+) => {


In general try to use named arguments above two parameters, along with an interface

interface UpdateSharegroupImage { sharegroupId: string; imageId: string; data: UpdateSharegroupImagePayload; } export const updateSharegroupImage = ({ sharegroupId, imageId, data, }: UpdateSharegroupImage) => { [...]

…s/sharegroups/members` and `/v4beta/images/sharegroups/tokens`

abailly-akamai · 2025-10-14T08:14:35Z

@harsh-akamai also don't forget your changesets, exp for new endpoints

…/harsh-akamai/manager into UIE-9311-add-endpoints-to-images

pmakode-akamai · 2025-10-16T05:02:42Z

packages/api-v4/src/images/sharegroup.ts

+) => {
+  Request<Page<SharegroupMember>>(
+    setURL(
+      `${BETA_API_ROOT}/images/sharegroup/${encodeURIComponent(sharegroupId)}/members`,


Suggested change

`${BETA_API_ROOT}/images/sharegroup/${encodeURIComponent(sharegroupId)}/members`,

`${BETA_API_ROOT}/images/sharegroups/${encodeURIComponent(sharegroupId)}/members`,

same here

pmakode-akamai · 2025-10-16T05:04:14Z

packages/api-v4/src/images/sharegroup.ts

+  data: GenerateSharegroupTokenPayload,
+) => {
+  return Request<SharegroupToken>(
+    setURL(`${BETA_API_ROOT}/images/sharegroup/tokens`),


Suggested change

setURL(`${BETA_API_ROOT}/images/sharegroup/tokens`),

setURL(`${BETA_API_ROOT}/images/sharegroups/tokens`),

I think this should be sharegroups (per the specs). Could you double-check?

pmakode-akamai · 2025-10-16T05:31:19Z

packages/api-v4/src/images/sharegroup.ts

+) => {
+  Request<SharegroupMember>(
+    setURL(
+      `${BETA_API_ROOT}/images/sharegroup/${encodeURIComponent(sharegroupId)}/members/${encodeURIComponent(token_uuid)}`,


Suggested change

`${BETA_API_ROOT}/images/sharegroup/${encodeURIComponent(sharegroupId)}/members/${encodeURIComponent(token_uuid)}`,

`${BETA_API_ROOT}/images/sharegroups/${encodeURIComponent(sharegroupId)}/members/${encodeURIComponent(token_uuid)}`,

Updated in cd173b6

pmakode-akamai · 2025-10-16T05:37:15Z

packages/api-v4/src/images/types.ts

+    source_image_id: number;
+  };
+  shared_with: null | {
+    shared_count: number;


Suggested change

shared_count: number;

sharegroup_count: number;

I think this should be sharegroup_count

Nice catch! Thanks @pmakode-akamai

pmakode-akamai · 2025-10-16T05:40:27Z

packages/api-v4/src/images/types.ts

+    sharegroup_label: string;
+    sharegroup_uuid: string;


Suggested change

sharegroup_label: string;

sharegroup_uuid: string;

share_group_label: string;

share_group_uuid: string;

APIs seem to be returning sharegroup_label and sharegroup_uuid. I've posted a question in the APISpec for clarification

Verified: The api returns sharegroup_label and sharegroup_uuid

…nd `/v4/images/sharegroups/tokens`

…regroup Members and Tokens

linode-gh-bot · 2025-10-24T13:22:54Z

Cloud Manager UI test results

🔺 3 failing tests on test run #9 ↗︎

❌ Failing	✅ Passing	↪️ Skipped	🕐 Duration
`3 Failing`	`844 Passing`	`12 Skipped`	`37m 49s`

Details

Failing Tests
	Spec	Test
❌	`firewall-landing-page.spec.ts`	Cloud Manager Cypress Tests→confirms Firewalls landing page empty state is shown when no Firewalls exist » lists all Firewalls
❌	`create-firewall.spec.ts`	Cloud Manager Cypress Tests→create firewall » "before all" hook for "creates a firewall without a linode"
❌	`clone-linode.spec.ts`	Cloud Manager Cypress Tests→clone linode » can clone a Linode from Linode details page

Troubleshooting

Use this command to re-run the failing tests:

pnpm cy:run -s "cypress/e2e/core/firewalls/firewall-landing-page.spec.ts,cypress/e2e/core/firewalls/create-firewall.spec.ts,cypress/e2e/core/linodes/clone-linode.spec.ts"

@pmakode-akamai

…aregroups/members` and `/v4/images/sharegroups/tokens` (linode#12984) * upcoming: [UIE-9311] - Add API endpoints and types for `/v4/images/sharegroups` * Add validation schema * upcoming: [UIE-9343] - Add API endpoints and types for `/v4beta/images/sharegroups/members` and `/v4beta/images/sharegroups/tokens` * rename sharegroup.ts * add named arguments for functions with more than 2 parameters * pr split + validation schema separation * PR feedback @pmakode-akamai * Added changeset: Add endpoints for `/v4/images/sharegroups/members` and `/v4/images/sharegroups/tokens` * Added changeset: Add validation schemas for creating and updating Sharegroup Members and Tokens

harsh-akamai added 2 commits October 14, 2025 11:54

upcoming: [UIE-9311] - Add API endpoints and types for `/v4/images/sh…

8fa8476

…aregroups`

Add validation schema

e2fdce2

harsh-akamai requested a review from a team as a code owner October 14, 2025 06:46

github-project-automation bot added this to Cloud Manager Oct 14, 2025

github-project-automation bot moved this to Review in Cloud Manager Oct 14, 2025

harsh-akamai self-assigned this Oct 14, 2025

harsh-akamai added the Images Relating to Images label Oct 14, 2025

abailly-akamai approved these changes Oct 14, 2025

View reviewed changes

upcoming: [UIE-9343] - Add API endpoints and types for `/v4beta/image…

e96cc59

…s/sharegroups/members` and `/v4beta/images/sharegroups/tokens`

harsh-akamai changed the title ~~upcoming: [UIE-9343] - Add API endpoints and validation schemas for /v4/images/sharegroups~~ upcoming: [UIE-9343] - Add API endpoints and types for /v4beta/images/sharegroups/members and /v4beta/images/sharegroups/tokens Oct 14, 2025

harsh-akamai mentioned this pull request Oct 14, 2025

upcoming: [UIE-9343] - Add API endpoints and types for /v4/images/sharegroups and /v4/images/sharegroups/images #12985

Merged

8 tasks

harsh-akamai added 3 commits October 14, 2025 14:22

rename sharegroup.ts

c12d9ab

add named arguments for functions with more than 2 parameters

ef8a7da

Merge branch 'develop' into UIE-9311-add-endpoints-to-images

a2f46d8

harsh-akamai added the Ready for Review label Oct 14, 2025

harsh-akamai requested a review from pmakode-akamai October 15, 2025 10:27

harsh-akamai added 2 commits October 15, 2025 16:00

pr split + validation schema separation

4cfe29d

Merge branch 'UIE-9311-add-endpoints-to-images' of https://github.com…

cce9401

…/harsh-akamai/manager into UIE-9311-add-endpoints-to-images

pmakode-akamai reviewed Oct 16, 2025

View reviewed changes

PR feedback @pmakode-akamai

cd173b6

pmakode-akamai approved these changes Oct 16, 2025

View reviewed changes

harsh-akamai requested a review from dwiley-akamai October 23, 2025 07:23

bnussman-akamai approved these changes Oct 23, 2025

View reviewed changes

github-project-automation bot moved this from Review to Approved in Cloud Manager Oct 23, 2025

harsh-akamai added Approved Multiple approvals and ready to merge! Private Image Sharing Related to Private Image Sharing feature and removed Images Relating to Images Ready for Review labels Oct 24, 2025

harsh-akamai added 3 commits October 24, 2025 17:55

Added changeset: Add endpoints for /v4/images/sharegroups/members a…

c317f6e

…nd `/v4/images/sharegroups/tokens`

Added changeset: Add validation schemas for creating and updating Sha…

07522b7

…regroup Members and Tokens

Merge branch 'develop' into UIE-9311-add-endpoints-to-images

8cd958e

harsh-akamai merged commit a080bd8 into linode:develop Oct 27, 2025
34 of 35 checks passed

github-project-automation bot moved this from Approved to Merged in Cloud Manager Oct 27, 2025

harsh-akamai deleted the UIE-9311-add-endpoints-to-images branch October 27, 2025 06:15

	`${BETA_API_ROOT}/images/sharegroup/${encodeURIComponent(sharegroupId)}/members`,
	`${BETA_API_ROOT}/images/sharegroups/${encodeURIComponent(sharegroupId)}/members`,

	setURL(`${BETA_API_ROOT}/images/sharegroup/tokens`),
	setURL(`${BETA_API_ROOT}/images/sharegroups/tokens`),

Conversation

harsh-akamai commented Oct 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description 📝

Changes 🔄

Scope 🚢

How to test 🧪

Verification steps

As an Author, to speed up the review process, I considered 🤔

As an Author, before moving this PR from Draft to Open, I confirmed ✅

Uh oh!

abailly-akamai left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

abailly-akamai commented Oct 14, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

linode-gh-bot commented Oct 24, 2025

Cloud Manager UI test results

🔺 3 failing tests on test run #9 ↗︎

Details

Troubleshooting

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

harsh-akamai commented Oct 14, 2025 •

edited

Loading