Skip to content

Commit 477c8c6

Browse files
authored
Merge pull request #342 from StackStorm/document_json_schema_types
Document the difference between the number and integer JSON schema type
2 parents 4b94394 + 0398159 commit 477c8c6

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

docs/source/actions.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,11 @@ compatibility). These attributes can be present in the metadata file:
147147
* ``runner_type`` - The type of runner to execute the action.
148148
* ``enabled`` - Action cannot be invoked when disabled.
149149
* ``entry_point`` - Location of the action launch script relative to the /opt/stackstorm/packs/${pack_name}/actions/.
150-
* ``parameters`` - A dictionary of parameters and optional metadata describing type and default. The metadata is structured data following the `JSON Schema`_ specification draft 4. The common parameter types allowed are ``string``, ``boolean``, ``number``, ``object``, ``integer`` and ``array``. If metadata is provided, input args are validated on action execution. Otherwise, validation is skipped.
150+
* ``parameters`` - A dictionary of parameters and optional metadata describing type and default.
151+
The metadata is structured data following the `JSON Schema`_ specification draft 4. The common parameter types
152+
allowed are ``string``, ``boolean``, ``number`` (whole numbers and decimal numbers - e.g. ``1.0``, ``1``, ``3.3333``,
153+
etc.), ``object``, ``integer`` (whole numbers only - ``1``, ``1000``, etc.) and ``array``. If metadata is provided,
154+
input args are validated on action execution. Otherwise, validation is skipped.
151155

152156
This is a sample metadata file for a Python action which sends an SMS via the Twilio web service:
153157

0 commit comments

Comments
 (0)