Skip to content

Commit 8db455d

Browse files
committed
Add schema and validation info
1 parent cd659e9 commit 8db455d

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

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

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,17 @@ During the metadata extraction phase, the Airdrop snap-in must provide an
33
This file provides a structured way of describing the external system's domain system,
44
including its domain entities, types, relationships, and other metadata.
55

6+
7+
## Validating metadata
8+
69
The extraction function of the snap-in must provide a valid metadata file.
710
DevRev provides a JSON schema and a CLI tool [chef-cli](https://github.com/devrev/adaas-chef-cli)
811
to validate the proposed schema.
912

10-
## Validating metadata
11-
1213
To check the metadata for internal consistency, you should use the following command after every step:
1314

1415
```bash
15-
chef-cli validate-metadata < metadata.json
16+
chef-cli validate-metadata < external_domain_metadata.json
1617
```
1718

1819
This will output any problems there may be with the metadata file.
@@ -432,3 +433,9 @@ be changed by the end user at any time, such as mandatory fields or custom field
432433
- In current metadata format (v0.2.0), the order and human-readable name are taken from the enum values defined on the controlling field
433434
- If the `states` field is not provided, default DevRev states will be used: `open`, `in_progress` and `closed`
434435
</Steps>
436+
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)