You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This will output any problems there may be with the metadata file.
20
20
21
+
<Info>
22
+
The detailed format of this metadata is defined by the `external_domain_metadata_schema.json` file. The file is available as part of the CLI package.
23
+
There, you can also find an example of a metadata file (`metadata.json`).
24
+
</Info>
25
+
21
26
## Triggering event
22
27
23
28
Airdrop initiates the metadata extraction by starting the snap-in with a message with an event
@@ -186,16 +191,18 @@ be changed by the end user at any time, such as mandatory fields or custom field
186
191
- `bool`
187
192
- `int`
188
193
- `float`
189
-
- `text`
190
-
- `rich_text`: Formatted text with mentions and images.
194
+
- `text`: Interpreted as plain text.
195
+
- `rich_text`: Formatted text with mentions and images, see [rich text](./rich-text.mdx).
191
196
- `reference`: IDs referring to another record. References have to declare what they can refer
192
197
to, which can be one or more record types (`#record:`) or categories (`#category:`).
193
198
- `enum`: A string from a predefined set of values with the optional human-readable names for each value.
194
199
- `date`
195
200
- `timestamp`
196
201
- `struct`
202
+
- `permission`
203
+
- `type_key`
197
204
198
-
For a detailed explanation of these supported types, refer to the [supported types page](./supported_types.md).
205
+
Refer to the metadata schema file (`external_domain_metadata_schema.json`) to help choose appropriate type for your fields.
199
206
200
207
If the external system supports custom fields, the set of custom fields in each record type
201
208
you wish to extract must be declared too.
@@ -434,8 +441,3 @@ be changed by the end user at any time, such as mandatory fields or custom field
434
441
- If the `states` field is not provided, default DevRev states will be used: `open`, `in_progress` and `closed`
435
442
</Steps>
436
443
437
-
## Metadata requirement
438
-
439
-
You are required to provide an `external_domain_metadata.json` file from your extractor, describing the logical schema of the external system.
440
-
The detailed format of this metadata is defined by the `external_domain_metadata_schema.json` file. The file is available as part of the chef-cli package.
441
-
There, you can also find an example of a metadata file (`metadata.json`).
0 commit comments