feat: implement `podtemplate` details endpoint for workspace overlay by Snehadas2005 · Pull Request #1119 · kubeflow/notebooks

Snehadas2005 · 2026-05-22T13:11:19Z

Description
This PR implements a dedicated details endpoint (GET /api/v1/workspaces/{namespace}/{name}/podtemplate/details) for the workspace details overlay. This decouples the frontend overlay layout from the generic workspace list endpoint, allowing richer data to be fetched efficiently on-demand.

Key Changes:

Constants: Added route path constants for the new endpoint in api/constants/paths.go.
Models: Defined response schemas and implemented the clean CR-to-Model transformation mapping in types_details.go and funcs_details.go (including conditional null mapping for paused workspaces).
Repository: Extended WorkspaceRepository with a GetWorkspaceDetails method fetching both the core Workspace CR and its associated WorkspaceKind.
API Handler: Implemented GetWorkspaceDetailsHandler with strict RBAC authentication (requireAuth) and namespace/name path verification.
Testing: Added isolated handler unit tests verifying running/paused states and validation paths.

Related Issue
Closes #1029

Verification Results

Ran go fmt ./... and go vet ./... successfully (no syntax/static analysis errors).

Isolated handler unit tests passed successfully:

go test ./api -run TestGetWorkspaceDetailsHandler -v

AI Policy Compliance
Assisted-by: Gemini gemini@google.com
Co-authored-by: Claude claude@anthropic.com

Note: AI assistance was utilized specifically to debug Windows-vs-Linux environment line-ending constraints in the auto-generated Swagger schema pipeline, as well as to accelerate the test-suite refactoring from traditional tables to the native Ginkgo/Gomega syntax structure.

google-oss-prow · 2026-05-22T13:12:49Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign andyatmiami for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

workspaces/backend/OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

christian-heusel

Thanks a lot for your contribution, I have left you a few review comments below! 🤗

Also did you use AI in any capacity while creating this contribution? I see that your commit does not carry any Assisted-By: <...> / Co-authored-by: <...> tags, so I wanted to make sure that you're aware of the Kubeflow AI Policy. 🤗 🤖

christian-heusel · 2026-05-23T04:21:27Z

You'll also need to generate the new relevant swagger files for this endpoint:

$ make -C workspaces/backend/ swag

christian-heusel · 2026-05-23T04:34:29Z

+type WorkspaceDetailVolume struct {
+	PVCName   string `json:"pvcName"`
+	MountPath string `json:"mountPath"`
+	ReadOnly  bool   `json:"readOnly"`
+}
+
+type WorkspaceDetailSecret struct {
+	SecretName  string `json:"secretName"`
+	MountPath   string `json:"mountPath"`
+	DefaultMode int32  `json:"defaultMode,omitempty"`
+}


We already have models for those datatypes that we could potentially reuse for these implementations instead of defining new types inline.

christian-heusel · 2026-05-23T04:35:40Z

Please do not introduce a new testing framework and reuse the pre-existing infrastructure around gomega

christian-heusel · 2026-05-23T04:47:56Z

+		readOnly := false
+		if v.ReadOnly != nil {
+			readOnly = *v.ReadOnly
+		}


We usually use ptr.Deref(volume.ReadOnly, false) for something like this:

Suggested change

readOnly := false

if v.ReadOnly != nil {

readOnly = *v.ReadOnly

}

readOnly := ptr.Deref(volume.ReadOnly, false)

christian-heusel · 2026-05-23T04:50:04Z

+	WorkspacePodTemplatePath        = WorkspacesByNamePath + "/podtemplate"
+	WorkspacePodTemplateDetailsPath = WorkspacePodTemplatePath + "/details"


This is a unused exported variable, you can just fold those two declarations into one.

christian-heusel · 2026-05-23T04:53:58Z

+type WorkspaceDetailVolumes struct {
+	Home    *WorkspaceDetailVolume  `json:"home"`
+	Data    []WorkspaceDetailVolume `json:"data"`
+	Secrets []WorkspaceDetailSecret `json:"secrets"`


This is not consistent with the Secrets API contract, the other one uses omitempty.

PodSecretInfo in types.go has omitempty on the slice. WorkspaceDetailSecret.Data and WorkspaceDetailSecret.Secrets (in WorkspaceDetailVolumes) omit this tag, which means the JSON response always includes "data": [] and "secrets": [] even when empty, unlike the rest of the API.

christian-heusel · 2026-05-23T04:55:42Z

+	// secret volumes — DefaultMode is int32 (not *int32), use directly
+	secretVolumes := make([]WorkspaceDetailSecret, len(ws.Spec.PodTemplate.Volumes.Secrets))
+	for i, s := range ws.Spec.PodTemplate.Volumes.Secrets {
+		secretVolumes[i] = WorkspaceDetailSecret{
+			SecretName:  s.SecretName,
+			MountPath:   s.MountPath,
+			DefaultMode: s.DefaultMode, // int32 directly, no dereference needed
+		}
+	}


The comments around int32 don't make sense to me, why did you add them? 😅

Signed-off-by: Sneha Das <154408198+Snehadas2005@users.noreply.github.com>

Snehadas2005 · 2026-05-27T17:40:55Z

Hi @christian-heusel! Thank you for your feedback. I have addressed your comments and refactored the branch into a clean commit.

Key updates include:

Added Assisted-by: Gemini and Co-authored-by: Claude tags for AI policy compliance.
Removed redundant structs in types_details.go, reusing standard models.
Added ,omitempty tags for API contract consistency.
Refactored the test suite to use Ginkgo and Gomega properly.
Cleaned up code with standard utilities and removed unnecessary comments.
Regenerated OpenAPI spec configurations.

Ready for your review! 🤗

github-project-automation Bot added this to Kubeflow Notebooks May 22, 2026

github-project-automation Bot moved this to Needs Triage in Kubeflow Notebooks May 22, 2026

Snehadas2005 changed the title ~~chore(frontend): update ts-jest to 29.4.9~~ feat: implement podtemplate details endpoint for workspace overlay May 22, 2026

google-oss-prow Bot added size/L area/backend area - related to backend components labels May 22, 2026

google-oss-prow Bot requested review from andyatmiami and thesuperzapper May 22, 2026 13:12

google-oss-prow Bot added the area/v2 area - version - kubeflow notebooks v2 label May 22, 2026

Snehadas2005 force-pushed the task-get-podtemplate branch 2 times, most recently from af21305 to 4398ca0 Compare May 22, 2026 13:39

christian-heusel suggested changes May 23, 2026

View reviewed changes

google-oss-prow Bot assigned christian-heusel May 23, 2026

google-oss-prow Bot added size/XXL and removed size/L labels May 26, 2026

Snehadas2005 marked this pull request as draft May 26, 2026 15:23

google-oss-prow Bot added the do-not-merge/work-in-progress label May 26, 2026

Snehadas2005 force-pushed the task-get-podtemplate branch 6 times, most recently from 1ee8a36 to 78eb914 Compare May 27, 2026 16:48

Snehadas2005 marked this pull request as ready for review May 27, 2026 17:30

google-oss-prow Bot removed the do-not-merge/work-in-progress label May 27, 2026

Snehadas2005 force-pushed the task-get-podtemplate branch from 3d38c1b to eee1f2a Compare May 27, 2026 17:35

feat: implement podtemplate details endpoint for workspace overlay

2fc9aac

Signed-off-by: Sneha Das <154408198+Snehadas2005@users.noreply.github.com>

Snehadas2005 force-pushed the task-get-podtemplate branch from eee1f2a to 2fc9aac Compare May 27, 2026 17:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: implement `podtemplate` details endpoint for workspace overlay#1119

feat: implement `podtemplate` details endpoint for workspace overlay#1119
Snehadas2005 wants to merge 1 commit into
kubeflow:notebooks-v2from
Snehadas2005:task-get-podtemplate

Snehadas2005 commented May 22, 2026 •

edited

Loading

Uh oh!

google-oss-prow Bot commented May 22, 2026

Uh oh!

christian-heusel left a comment

Uh oh!

christian-heusel May 23, 2026

Uh oh!

christian-heusel May 23, 2026

Uh oh!

christian-heusel May 23, 2026

Uh oh!

christian-heusel May 23, 2026

Uh oh!

christian-heusel May 23, 2026

Uh oh!

christian-heusel May 23, 2026

Uh oh!

christian-heusel May 23, 2026

Uh oh!

Snehadas2005 commented May 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		WorkspacePodTemplatePath = WorkspacesByNamePath + "/podtemplate"
		WorkspacePodTemplateDetailsPath = WorkspacePodTemplatePath + "/details"

Conversation

Snehadas2005 commented May 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

google-oss-prow Bot commented May 22, 2026

Uh oh!

christian-heusel left a comment

Choose a reason for hiding this comment

Uh oh!

christian-heusel May 23, 2026

Choose a reason for hiding this comment

Uh oh!

christian-heusel May 23, 2026

Choose a reason for hiding this comment

Uh oh!

christian-heusel May 23, 2026

Choose a reason for hiding this comment

Uh oh!

christian-heusel May 23, 2026

Choose a reason for hiding this comment

Uh oh!

christian-heusel May 23, 2026

Choose a reason for hiding this comment

Uh oh!

christian-heusel May 23, 2026

Choose a reason for hiding this comment

Uh oh!

christian-heusel May 23, 2026

Choose a reason for hiding this comment

Uh oh!

Snehadas2005 commented May 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Snehadas2005 commented May 22, 2026 •

edited

Loading