Publish Notebook to a specific Notebook interface

[santhoshramaraj]

The Notebook publish workflow from JupyterHub on SLE allows users to select the interface to publish to.

The NotebookMetadata.metadata field stores the interface detail though the key is not standardized in the definition

nisystemlink-clients-python/nisystemlink/clients/notebook/models/_notebook_metadata.py

Line 34 in 4a965b4

metadata: Optional[Dict[str, Any]]

Swagger doc for the NotebookMetadata.metadata field,

example: OrderedMap { "interfaces": List [ "interface" ], "outputs": List [ OrderedMap { "display_name": "Output", "id": "output", "type": "scalar" } ], "parameters": List [ OrderedMap { "display_name": "Parameter1", "id": "parameter1", "type": "string" }, OrderedMap { "display_name": "Parameter2", "id": "parameter2", "type": "string[]" } ] }

This feature will enable users to create a CI/CD mechanism to manage published notebooks.

[stefanc18]

@santhoshramaraj The swagger doc for Notebook Service seems to be misleading, the interface presented in SLE that you're referring to is not stored in the notebook's metadata, but rather in the properties.interface of the SLE notebook. And this property is not part of the notebook itself (the .ipynb file), instead it is only in the DB where the notebooks are stored on SLE.

[santhoshramaraj]

@stefanc18, in that case, then properties shouldn't be a generic Dict[str, str], but rather contain the standard fields and be flexible to contain custom fields.

Or, the create_notebook must expose interface as arg and update the NotebookMetadata internally.

nisystemlink-clients-python/nisystemlink/clients/notebook/_notebook_client.py

Line 160 in 4a965b4

def create_notebook(