Skip to content

Commit 7c5c970

Browse files
committed
Fix incorrect Javadoc for session option properties
Update 8 Javadoc blocks in SessionConfig and ResumeSessionConfig that incorrectly claimed skipCustomInstructions, customAgentsLocalOnly, coauthorEnabled, and manageScheduleEnabled were not yet propagated to the wire protocol. All reference implementations (Node.js, .NET, Go) propagate these via session.options.update.
1 parent 5a3794e commit 7c5c970

2 files changed

Lines changed: 40 additions & 24 deletions

File tree

src/main/java/com/github/copilot/rpc/ResumeSessionConfig.java

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -297,9 +297,11 @@ public Optional<Boolean> getSkipCustomInstructions() {
297297
/**
298298
* Sets whether to suppress loading of custom instruction files.
299299
* <p>
300-
* <b>Note:</b> This option is not yet propagated to the wire protocol. It is
301-
* reserved for future SDK defaulting behavior. Setting it currently has no
302-
* effect on the session resume request.
300+
* This option is sent to the server via a {@code session.options.update}
301+
* JSON-RPC call immediately after session resume. In
302+
* {@link CopilotClientMode#EMPTY EMPTY} mode the default is {@code true}
303+
* (skip); in {@link CopilotClientMode#COPILOT_CLI COPILOT_CLI} mode the value
304+
* is forwarded only when explicitly set.
303305
*
304306
* @param skipCustomInstructions
305307
* whether to skip custom instructions
@@ -336,9 +338,11 @@ public Optional<Boolean> getCustomAgentsLocalOnly() {
336338
* Sets whether custom-agent discovery is restricted to the session's local
337339
* working directory.
338340
* <p>
339-
* <b>Note:</b> This option is not yet propagated to the wire protocol. It is
340-
* reserved for future SDK defaulting behavior. Setting it currently has no
341-
* effect on the session resume request.
341+
* This option is sent to the server via a {@code session.options.update}
342+
* JSON-RPC call immediately after session resume. In
343+
* {@link CopilotClientMode#EMPTY EMPTY} mode the default is {@code true} (local
344+
* only); in {@link CopilotClientMode#COPILOT_CLI COPILOT_CLI} mode the value is
345+
* forwarded only when explicitly set.
342346
*
343347
* @param customAgentsLocalOnly
344348
* whether to restrict to local agents
@@ -375,9 +379,11 @@ public Optional<Boolean> getCoauthorEnabled() {
375379
* Sets whether the runtime is allowed to append a {@code Co-authored-by}
376380
* trailer.
377381
* <p>
378-
* <b>Note:</b> This option is not yet propagated to the wire protocol. It is
379-
* reserved for future SDK defaulting behavior. Setting it currently has no
380-
* effect on the session resume request.
382+
* This option is sent to the server via a {@code session.options.update}
383+
* JSON-RPC call immediately after session resume. In
384+
* {@link CopilotClientMode#EMPTY EMPTY} mode the default is {@code false}
385+
* (disabled); in {@link CopilotClientMode#COPILOT_CLI COPILOT_CLI} mode the
386+
* value is forwarded only when explicitly set.
381387
*
382388
* @param coauthorEnabled
383389
* whether coauthor is enabled
@@ -413,9 +419,11 @@ public Optional<Boolean> getManageScheduleEnabled() {
413419
/**
414420
* Sets whether to enable the {@code manage_schedule} tool.
415421
* <p>
416-
* <b>Note:</b> This option is not yet propagated to the wire protocol. It is
417-
* reserved for future SDK defaulting behavior. Setting it currently has no
418-
* effect on the session resume request.
422+
* This option is sent to the server via a {@code session.options.update}
423+
* JSON-RPC call immediately after session resume. In
424+
* {@link CopilotClientMode#EMPTY EMPTY} mode the default is {@code false}
425+
* (disabled); in {@link CopilotClientMode#COPILOT_CLI COPILOT_CLI} mode the
426+
* value is forwarded only when explicitly set.
419427
*
420428
* @param manageScheduleEnabled
421429
* whether manage schedule is enabled

src/main/java/com/github/copilot/rpc/SessionConfig.java

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -354,9 +354,11 @@ public Optional<Boolean> getSkipCustomInstructions() {
354354
* {@code .github/copilot-instructions.md}, {@code AGENTS.md}) from the working
355355
* directory.
356356
* <p>
357-
* <b>Note:</b> This option is not yet propagated to the wire protocol. It is
358-
* reserved for future SDK defaulting behavior. Setting it currently has no
359-
* effect on the session creation request.
357+
* This option is sent to the server via a {@code session.options.update}
358+
* JSON-RPC call immediately after session creation. In
359+
* {@link CopilotClientMode#EMPTY EMPTY} mode the default is {@code true}
360+
* (skip); in {@link CopilotClientMode#COPILOT_CLI COPILOT_CLI} mode the value
361+
* is forwarded only when explicitly set.
360362
*
361363
* @param skipCustomInstructions
362364
* whether to skip custom instructions
@@ -394,9 +396,11 @@ public Optional<Boolean> getCustomAgentsLocalOnly() {
394396
* Sets whether custom-agent discovery is restricted to the session's local
395397
* working directory (no organisation-level discovery).
396398
* <p>
397-
* <b>Note:</b> This option is not yet propagated to the wire protocol. It is
398-
* reserved for future SDK defaulting behavior. Setting it currently has no
399-
* effect on the session creation request.
399+
* This option is sent to the server via a {@code session.options.update}
400+
* JSON-RPC call immediately after session creation. In
401+
* {@link CopilotClientMode#EMPTY EMPTY} mode the default is {@code true} (local
402+
* only); in {@link CopilotClientMode#COPILOT_CLI COPILOT_CLI} mode the value is
403+
* forwarded only when explicitly set.
400404
*
401405
* @param customAgentsLocalOnly
402406
* whether to restrict to local agents
@@ -434,9 +438,11 @@ public Optional<Boolean> getCoauthorEnabled() {
434438
* Sets whether the runtime is allowed to append a {@code Co-authored-by}
435439
* trailer when it commits on behalf of the user.
436440
* <p>
437-
* <b>Note:</b> This option is not yet propagated to the wire protocol. It is
438-
* reserved for future SDK defaulting behavior. Setting it currently has no
439-
* effect on the session creation request.
441+
* This option is sent to the server via a {@code session.options.update}
442+
* JSON-RPC call immediately after session creation. In
443+
* {@link CopilotClientMode#EMPTY EMPTY} mode the default is {@code false}
444+
* (disabled); in {@link CopilotClientMode#COPILOT_CLI COPILOT_CLI} mode the
445+
* value is forwarded only when explicitly set.
440446
*
441447
* @param coauthorEnabled
442448
* whether coauthor is enabled
@@ -474,9 +480,11 @@ public Optional<Boolean> getManageScheduleEnabled() {
474480
* Sets whether to enable the {@code manage_schedule} tool (host scheduler
475481
* integration).
476482
* <p>
477-
* <b>Note:</b> This option is not yet propagated to the wire protocol. It is
478-
* reserved for future SDK defaulting behavior. Setting it currently has no
479-
* effect on the session creation request.
483+
* This option is sent to the server via a {@code session.options.update}
484+
* JSON-RPC call immediately after session creation. In
485+
* {@link CopilotClientMode#EMPTY EMPTY} mode the default is {@code false}
486+
* (disabled); in {@link CopilotClientMode#COPILOT_CLI COPILOT_CLI} mode the
487+
* value is forwarded only when explicitly set.
480488
*
481489
* @param manageScheduleEnabled
482490
* whether manage schedule is enabled

0 commit comments

Comments
 (0)