Skip to content

Commit 97c7feb

Browse files
authored
Merge pull request #53 from posit-dev/feature/more-metadata
Add more metadata
2 parents c06685b + 91d19ae commit 97c7feb

17 files changed

Lines changed: 499 additions & 93 deletions

File tree

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

crates/kallichore_api/.openapi-generator/FILES

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ docs/ServerConfiguration.md
1717
docs/ServerConfigurationLogLevel.md
1818
docs/ServerStatus.md
1919
docs/SessionList.md
20+
docs/SessionMode.md
2021
docs/StartupError.md
2122
docs/Status.md
2223
docs/VarAction.md

crates/kallichore_api/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ To see how to make this your own, look here:
1414
[README]((https://openapi-generator.tech))
1515

1616
- API version: 1.0.0
17-
- Build date: 2025-09-26T15:23:57.096174-07:00[America/Los_Angeles]
17+
- Build date: 2025-10-24T10:11:06.911877-07:00[America/Los_Angeles]
1818
- Generator version: 7.13.0
1919

2020
For more information, please visit [https://posit.co](https://posit.co)
@@ -167,6 +167,7 @@ Method | HTTP request | Description
167167
- [ServerConfigurationLogLevel](docs/ServerConfigurationLogLevel.md)
168168
- [ServerStatus](docs/ServerStatus.md)
169169
- [SessionList](docs/SessionList.md)
170+
- [SessionMode](docs/SessionMode.md)
170171
- [StartupError](docs/StartupError.md)
171172
- [Status](docs/Status.md)
172173
- [VarAction](docs/VarAction.md)

crates/kallichore_api/api/openapi.yaml

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -469,6 +469,13 @@ components:
469469
items:
470470
$ref: '#/components/schemas/varAction'
471471
type: array
472+
sessionMode:
473+
description: The mode in which the session is running
474+
enum:
475+
- console
476+
- notebook
477+
- background
478+
type: string
472479
varActionType:
473480
description: The type of action to perform on the environment variable
474481
enum:
@@ -611,9 +618,14 @@ components:
611618
items:
612619
type: string
613620
type: array
621+
session_mode:
622+
$ref: '#/components/schemas/sessionMode'
614623
working_directory:
615624
description: The working directory in which to start the session.
616625
type: string
626+
notebook_uri:
627+
description: "For notebook sessions, the URI of the notebook file"
628+
type: string
617629
env:
618630
description: A list of environment variable actions to perform
619631
items:
@@ -644,6 +656,7 @@ components:
644656
- interrupt_mode
645657
- language
646658
- session_id
659+
- session_mode
647660
- username
648661
- working_directory
649662
type: object
@@ -699,6 +712,7 @@ components:
699712
- argv
700713
- argv
701714
socket_path: socket_path
715+
notebook_uri: notebook_uri
702716
execution_queue:
703717
pending:
704718
- "{}"
@@ -707,6 +721,7 @@ components:
707721
active: "{}"
708722
interrupt_mode: signal
709723
connected: true
724+
session_mode: console
710725
initial_env:
711726
key: initial_env
712727
username: username
@@ -748,9 +763,14 @@ components:
748763
description: An ISO 8601 timestamp of when the session was started
749764
format: date-time
750765
type: string
766+
session_mode:
767+
$ref: '#/components/schemas/sessionMode'
751768
working_directory:
752769
description: The session's current working directory
753770
type: string
771+
notebook_uri:
772+
description: "For notebook sessions, the URI of the notebook file"
773+
type: string
754774
input_prompt:
755775
description: The text to use to prompt for input
756776
type: string
@@ -790,18 +810,21 @@ components:
790810
- kernel_info
791811
- language
792812
- session_id
813+
- session_mode
793814
- started
794815
- status
795816
- username
796817
- working_directory
797818
type: object
798819
serverStatus:
799820
example:
800-
process_id: 5
821+
process_id: 2
801822
sessions: 0
802823
busy_seconds: 5
824+
uptime_seconds: 5
803825
busy: true
804826
active: 6
827+
started: 2000-01-23T04:56:07.000+00:00
805828
version: version
806829
idle_seconds: 1
807830
properties:
@@ -819,19 +842,28 @@ components:
819842
description: "The number of seconds any session has been busy, or 0 if all\
820843
\ sessions are idle"
821844
type: integer
845+
uptime_seconds:
846+
description: The number of seconds the server has been running
847+
type: integer
822848
version:
823849
description: The version of the server
824850
type: string
825851
process_id:
826852
description: The server's operating system process identifier
827853
type: integer
854+
started:
855+
description: An ISO 8601 timestamp of when the server was started
856+
format: date-time
857+
type: string
828858
required:
829859
- active
830860
- busy
831861
- busy_seconds
832862
- idle_seconds
833863
- process_id
834864
- sessions
865+
- started
866+
- uptime_seconds
835867
- version
836868
type: object
837869
sessionList:
@@ -852,6 +884,7 @@ components:
852884
- argv
853885
- argv
854886
socket_path: socket_path
887+
notebook_uri: notebook_uri
855888
execution_queue:
856889
pending:
857890
- "{}"
@@ -860,6 +893,7 @@ components:
860893
active: "{}"
861894
interrupt_mode: signal
862895
connected: true
896+
session_mode: console
863897
initial_env:
864898
key: initial_env
865899
username: username
@@ -879,6 +913,7 @@ components:
879913
- argv
880914
- argv
881915
socket_path: socket_path
916+
notebook_uri: notebook_uri
882917
execution_queue:
883918
pending:
884919
- "{}"
@@ -887,6 +922,7 @@ components:
887922
active: "{}"
888923
interrupt_mode: signal
889924
connected: true
925+
session_mode: console
890926
initial_env:
891927
key: initial_env
892928
username: username

crates/kallichore_api/docs/ActiveSession.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ Name | Type | Description | Notes
1313
**initial_env** | **std::collections::HashMap<String, String>** | The environment variables set when the session was started | [optional] [default to None]
1414
**connected** | **bool** | Whether the session is connected to a client |
1515
**started** | [**chrono::DateTime::<chrono::Utc>**](DateTime.md) | An ISO 8601 timestamp of when the session was started |
16+
**session_mode** | [***models::SessionMode**](sessionMode.md) | |
1617
**working_directory** | **String** | The session's current working directory |
18+
**notebook_uri** | **String** | For notebook sessions, the URI of the notebook file | [optional] [default to None]
1719
**input_prompt** | **String** | The text to use to prompt for input |
1820
**continuation_prompt** | **String** | The text to use to prompt for input continuations |
1921
**execution_queue** | [***models::ExecutionQueue**](execution_queue.md) | |

crates/kallichore_api/docs/NewSession.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ Name | Type | Description | Notes
1010
**input_prompt** | **String** | The text to use to prompt for input |
1111
**continuation_prompt** | **String** | The text to use to prompt for input continuations |
1212
**argv** | **Vec<String>** | The program and command-line parameters for the session |
13+
**session_mode** | [***models::SessionMode**](sessionMode.md) | |
1314
**working_directory** | **String** | The working directory in which to start the session. |
15+
**notebook_uri** | **String** | For notebook sessions, the URI of the notebook file | [optional] [default to None]
1416
**env** | [**Vec<models::VarAction>**](varAction.md) | A list of environment variable actions to perform |
1517
**connection_timeout** | **i32** | The number of seconds to wait for a connection to the session's ZeroMQ sockets before timing out | [optional] [default to Some(30)]
1618
**interrupt_mode** | [***models::InterruptMode**](interrupt_mode.md) | |

crates/kallichore_api/docs/ServerStatus.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,10 @@ Name | Type | Description | Notes
88
**busy** | **bool** | |
99
**idle_seconds** | **i32** | The number of seconds all sessions have been idle, or 0 if any session is busy |
1010
**busy_seconds** | **i32** | The number of seconds any session has been busy, or 0 if all sessions are idle |
11+
**uptime_seconds** | **i32** | The number of seconds the server has been running |
1112
**version** | **String** | The version of the server |
1213
**process_id** | **i32** | The server's operating system process identifier |
14+
**started** | [**chrono::DateTime::<chrono::Utc>**](DateTime.md) | An ISO 8601 timestamp of when the server was started |
1315

1416
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1517

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# SessionMode
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
7+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
8+
9+

0 commit comments

Comments
 (0)