Skip to content

Commit 8526692

Browse files
authored
Merge pull request #34 from mnfst/help-text
Help texts
2 parents 0795548 + 057d46e commit 8526692

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

entities.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,7 @@ You can pass arguments using the long syntax:
163163
| **hidden** | `false` | boolean | If the property should be hidden in the API response |
164164
| **options** | - | Object | Specific options depending on [property type](#property-types) |
165165
| **validation** | - | Object | The [property validators](./validation.md) that each request compares against |
166+
| **helpText** | - | string | Optional help text to display in admin UI |
166167
| **default** | - | any | The default value. When creating an item, if the property is not specified it will default to this value. |
167168

168169
### Property types
@@ -396,8 +397,9 @@ When you define a **belongsTo** relationship, it implicitly set the opposite _ha
396397

397398
You can pass arguments using the long syntax:
398399

399-
| Option | Default | Type | Description |
400-
| ---------- | ----------- | ------- | -------------------------------------------------------------------------------------------------------------------------------- |
401-
| **name** | Entity name | string | The name of the relation |
402-
| **entity** | - | string | The class name of the entity that the relationship is with |
403-
| **eager** | `false` | boolean | Whether the relationship should be eager loaded. Otherwise, you need to explicitly request the relation in the client SDK or API |
400+
| Option | Default | Type | Description |
401+
| ------------ | ----------- | ------- | -------------------------------------------------------------------------------------------------------------------------------- |
402+
| **name** | Entity name | string | The name of the relation |
403+
| **entity** | - | string | The class name of the entity that the relationship is with |
404+
| **helpText** | - | string | Optional help text to display in admin UI |
405+
| **eager** | `false` | boolean | Whether the relationship should be eager loaded. Otherwise, you need to explicitly request the relation in the client SDK or API |

0 commit comments

Comments
 (0)