Skip to content

Commit

Permalink
Add an example for workspace date/time format.
Browse files Browse the repository at this point in the history
  • Loading branch information
krassowski committed Mar 19, 2024
1 parent 6459bc0 commit 8134d1f
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/source/user/workspaces.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,8 @@ There are two top level keys requires, `data`, and `metadata`.

The `metadata` must be a mapping with an `id`
key that has the same value as the ID of the workspace. This should also be the relative URL path to access the workspace,
like `/lab/workspaces/foo`. Additionally, `metadata` may contain `created` and `last_modified` fields with date and time creation and most recent modification, respectively. The date and time are encoded using ISO 8601 format.
like `/lab/workspaces/foo`. Additionally, `metadata` may contain `created` and `last_modified` fields with date and time creation and most recent modification, respectively.
The date and time are encoded using ISO 8601 format, for example ``2022-06-15T23:41:15.818986+00:00``.

The `data` key maps to the initial state of the ``IStateDB``. Many plugins look in the State DB for the configuration.
Also any plugins that register with the ``ILayoutRestorer`` will look up all keys in the State DB
Expand Down

0 comments on commit 8134d1f

Please sign in to comment.