Skip to content

Commit d4f6edb

Browse files
authored
docs: Add information about is loadable to metadata extraction (#226)
* Add loadable * Fix json hints * Nit
1 parent 929da1c commit d4f6edb

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

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

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,41 @@ be changed by the end user at any time, such as mandatory fields or custom field
216216
}
217217
```
218218

219+
### Mark record types as loadable
220+
221+
The record types that will be used in a 2-way sync must be marked with `is_loadable`.
222+
This will allow Airdrop to load the record types to the external system.
223+
224+
<Note>
225+
When mapping record loadable record types use the `--reverse` flag with the `chef-cli configure-mappings` command.
226+
</Note>
227+
228+
229+
```json {6,18}
230+
{
231+
"record_types":{
232+
"issues_stock_epic":{
233+
"name":"Epic",
234+
"category":"issue",
235+
"is_loadable": true
236+
},
237+
"issues_custom2321":{
238+
"name":"Incident report",
239+
"category":"issue"
240+
},
241+
"issues_custom2322":{
242+
"name":"Problem",
243+
"category":"issue"
244+
},
245+
"comments":{
246+
"name":"Comment",
247+
"is_loadable": true
248+
}
249+
}
250+
}
251+
```
252+
253+
219254
### Declare fields for each record type
220255

221256
Fields' keys must match what is actually found in the extracted data in the artifacts.

0 commit comments

Comments
 (0)