Skip to content

Commit 03e97fd

Browse files
committed
Improve metadata extraction
1 parent 4d4331a commit 03e97fd

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

fern/docs/pages/airdrop/metadata-extraction.mdx

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1+
12
During the metadata extraction phase, the Airdrop snap-in must provide an
23
`external_domain_metadata.json` file on each sync run.
34
This file provides a structured way of describing the external system's domain system,
45
including its domain entities, types, relationships, and other metadata.
56

6-
77
## Validating metadata
88

99
The extraction function of the snap-in must provide a valid metadata file.
@@ -18,6 +18,11 @@ chef-cli validate-metadata < external_domain_metadata.json
1818

1919
This will output any problems there may be with the metadata file.
2020

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+
2126
## Triggering event
2227

2328
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
186191
- `bool`
187192
- `int`
188193
- `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).
191196
- `reference`: IDs referring to another record. References have to declare what they can refer
192197
to, which can be one or more record types (`#record:`) or categories (`#category:`).
193198
- `enum`: A string from a predefined set of values with the optional human-readable names for each value.
194199
- `date`
195200
- `timestamp`
196201
- `struct`
202+
- `permission`
203+
- `type_key`
197204

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.
199206

200207
If the external system supports custom fields, the set of custom fields in each record type
201208
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
434441
- If the `states` field is not provided, default DevRev states will be used: `open`, `in_progress` and `closed`
435442
</Steps>
436443

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

Comments
 (0)