diff --git a/CHANGELOG.md b/CHANGELOG.md index 98670a276990412700b1123e4478682feb102653..9b084f01c704801957fa473294859ac045ee955a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1 +1,4 @@ # v2.16.4 + +* added embedding configuration documentation in schema JSON + * this functionality does not require updating satella diff --git a/docs/configuration/schema.rst b/docs/configuration/schema.rst index 575a41eb0d238ea73bb6b3fc6fd3bfe92388f761..5fda5cfece6778028da32e317868c21db57423f3 100644 --- a/docs/configuration/schema.rst +++ b/docs/configuration/schema.rst @@ -173,3 +173,19 @@ In which case cast_to will be displayed as a which will be eval()ed, and this value will be output. The input value will be called **x**. +You can also provide a commentary for your entries: + +.. code-block:: json + + + { + "contents": { + "type": "file_contents", + "encoding": "utf-8, + "description": "Encryption key (private key) + }, + "max_workers": { + "type": "int", + "description": "Maximum parallel instances of service" + } + } diff --git a/satella/__init__.py b/satella/__init__.py index 64fe3086678099a5d85d9ac1653b3306adbf7f4e..e8803eec7538a60cf636fc655b72ce8b00989fef 100644 --- a/satella/__init__.py +++ b/satella/__init__.py @@ -1 +1 @@ -__version__ = '2.16.4a1' +__version__ = '2.16.4a2' diff --git a/tests/test_configuration/test_schema.py b/tests/test_configuration/test_schema.py index 2a8d2f50d5e1ba9ee570b0c86e546bc5a6e85680..adf466d8d9cfcc8645dd21f589225b55ce734c76 100644 --- a/tests/test_configuration/test_schema.py +++ b/tests/test_configuration/test_schema.py @@ -93,7 +93,10 @@ class TestSchema(unittest.TestCase): def test_descriptor_from_schema(self): schema = { "key_s": "str", - "key_i": "int", + "key_i": { + "type": "int", + "description": "Value of key I" + }, "key_f": "float", "ip_addr": "ipv4", "nested": {