An API to create a document room if it does not exist?

[krassowski]

Problem

Currently it is possible for other extensions to get the document (or it's copy - by default) if there is a collaborative session for it. However, it is not currently possible to create the document room when it does not exist. This would be useful to allow server-side execution for notebooks which are not currently open (e.g. user clicks from context menu in the file browser on the notebook and chooses to execute it).

Proposed Solution

Add a new public API for creating the notebook. This could be as simple as a new argument to the existing get_document, a boolean create which would default to false.

Additional context

jupyter-collaboration/projects/jupyter-server-ydoc/jupyter_server_ydoc/app.py

Lines 136 to 145 in bcc36e1

	async def get_document(
	self: YDocExtension,
	*,
	path: str | None = None,
	content_type: str | None = None,
	file_format: Literal["json", "text"] | None = None,
	room_id: str | None = None,
	copy: bool = True,
	) -> YBaseDoc | None:
	"""Get a view of the shared model for the matching document.