Skip to content

Commit c65e708

Browse files
authored
docs: Float number support in input schema (#2014)
Instead of adding new "Number" section which will be almost the same as "Integer" one, I decided to put both under one section called "Numeric types"
1 parent fa5e30c commit c65e708

File tree

1 file changed

+14
-8
lines changed
  • sources/platform/actors/development/actor_definition/input_schema

1 file changed

+14
-8
lines changed

sources/platform/actors/development/actor_definition/input_schema/specification.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,12 @@ Properties:
308308
| `groupDescription` | String | No | Description displayed as help text <br/>displayed of group title. |
309309
| `nullable` | Boolean | No | Specifies whether null is <br/>an allowed value. |
310310

311-
### Integer
311+
### Numeric types
312+
313+
There are two numeric types supported in the input schema: `integer` and `number`.
314+
315+
- The `integer` type represents whole numbers.
316+
- The `number` type can represent both integers and floating-point numbers.
312317

313318
Example:
314319

@@ -329,13 +334,14 @@ Rendered input:
329334

330335
Properties:
331336

332-
| Property | Value | Required | Description |
333-
| --- | --- | --- | --- |
334-
| `editor` | One of: <ul><li>`number`</li><li>`hidden`</li></ul> | No | Visual editor used for input field. |
335-
| `maximum` | Integer | No | Maximum allowed value. |
336-
| `minimum` | Integer | No | Minimum allowed value. |
337-
| `unit` | String | No | Unit displayed next to the field in UI, <br/>for example _second_, _MB_, etc. |
338-
| `nullable` | Boolean | No | Specifies whether null is an allowed value. |
337+
| Property | Value | Required | Description |
338+
|------------|-----------------------------------------------------|----------|-------------------------------------------------------------------------------|
339+
| `type` | One of <ul><li>`integer`</li><li>`number`</li></ul> | Yes | Defines the type of the field — either an integer or a floating-point number. |
340+
| `editor` | One of: <ul><li>`number`</li><li>`hidden`</li></ul> | No | Visual editor used for input field. |
341+
| `maximum` | Integer or Number <br/>(based on the `type`) | No | Maximum allowed value. |
342+
| `minimum` | Integer or Number <br/>(based on the `type`) | No | Minimum allowed value. |
343+
| `unit` | String | No | Unit displayed next to the field in UI, <br/>for example _second_, _MB_, etc. |
344+
| `nullable` | Boolean | No | Specifies whether null is an allowed value. |
339345

340346
### Object
341347

0 commit comments

Comments
 (0)