[ZEPPELIN-6664] Add notebook core SDK wire fields - #5480
Open
voidmatcha wants to merge 1 commit into
Open
voidmatcha wants to merge 1 commit into
voidmatcha wants to merge 1 commit into
Conversation
voidmatcha
force-pushed
the
ZEPPELIN-6664-sdk-notebook-fields
branch
from
September 20, 2026 06:25
c7212f0 to
15ce4eb
Compare
voidmatcha
marked this pull request as ready for review
September 20, 2026 11:48
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
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.
What is this PR for?
Declare five notebook WebSocket fields that the server already sends but the SDK types omitted, so Shared Notebook Core can build on typed values instead of casts. This PR adds those declarations only; it does not model every payload variant or every nullable nested value.
ParagraphItem.progress: number:zeppelin-server/src/main/java/org/apache/zeppelin/notebook/Paragraph.java:78(primitiveint, always serialized). Declared fields enumerated acrossParagraph.java:73-99,zeppelin-interpreter/src/main/java/org/apache/zeppelin/scheduler/Job.java:84-93andJobWithProgressPoller.java:23.Note.note.version?: string:zeppelin-server/src/main/java/org/apache/zeppelin/notebook/Note.java:77, rangeNote.java:73-98. Optional because a personalizedGET_NOTEreturnsgetUserNote()(Note.java:948-967, reached fromNotebookService.java:147-151), which is built without a version.EditorSettingReceived.editor.completionKey?: string: emitted byNotebookServer.java:2240-2248throughNotebookService.java:1244-1246andInterpreterSettingManager.java:616-685, which returns the interpreter's editor map (for examplelivy/src/main/resources/interpreter-setting.json:137). Optional because many editor blocks and the default map (InterpreterSettingManager.java:111-113) omit it.AngularObjectRemove.angularObject?and.interpreterGroupId?: sent only byNotebookServer.java:1495-1498; the other emit site (NotebookServer.java:2218-2231) omits both. Nested fields come fromzeppelin-interpreter/src/main/java/org/apache/zeppelin/display/AngularObject.java:42-49. Correcting loosely typed payload shapes is tracked by ZEPPELIN-6676.ImportNotekeeps usingImportParagraphItem, whereprogressandversionstay optional, because an imported note file is user input and may not carry them. TypeScript callers that construct a receivedParagraphItemnow have to setprogress; the paragraph test fixture in this PR does so.What type of PR is it?
Improvement
Todos
testphaseWhat is the Jira issue?
https://issues.apache.org/jira/browse/ZEPPELIN-6664
How should this be tested?
The first command typechecks the contract spec and the second executes it. The third checks WebSocket operation names and message-map consistency, not payload fields.
cd zeppelin-web-angular npm run typecheck:sdk-contracts npx vitest run --config vitest.shell.config.mts projects/zeppelin-sdk/src/interfaces/notebook-wire-fields.spec.ts npm run check:websocket-contractScreenshots (if appropriate)
N/A
Questions: