Skip to content

docs: Add information about is loadable to metadata extraction #226

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 15, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions fern/docs/pages/airdrop/metadata-extraction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,41 @@ be changed by the end user at any time, such as mandatory fields or custom field
}
```

### Mark record types as loadable

The record types that will be used in a 2-way sync must be marked with `is_loadable`.
This will allow Airdrop to load the record types to the external system.

<Note>
When mapping record loadable record types use the `--reverse` flag with the `chef-cli configure-mappings` command.
</Note>


```json {6,18}
{
"record_types":{
"issues_stock_epic":{
"name":"Epic",
"category":"issue",
"is_loadable": true
},
"issues_custom2321":{
"name":"Incident report",
"category":"issue"
},
"issues_custom2322":{
"name":"Problem",
"category":"issue"
},
"comments":{
"name":"Comment",
"is_loadable": true
}
}
}
```


### Declare fields for each record type

Fields' keys must match what is actually found in the extracted data in the artifacts.
Expand Down
Loading