Skip to content
Open
Show file tree
Hide file tree
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
7 changes: 7 additions & 0 deletions custom-recipes/api-connect/Cobuild.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
- API Connect performs one API call per input row and writes the extracted rows from each response, including paginated responses, to the output dataset.
- Always set `endpoint_url` and select at least one `parameter_columns` column. Selected columns become `{{column_name}}` template variables across request fields; `parameter_renamings` changes their template names.
- `auth_type=null` supports either no authentication (`credential` unset) or a generic credential preset. A secure authentication type requires its corresponding visible preset.
- API Connect automatically injects an API-key preset into the header or query parameter configured by the user in that preset. Do not add the API key again to request fields.
- Use the dot-separated `extraction_key` when response rows are nested under a JSON path.
- Keep `raw_output=true` when each response item should be preserved as raw JSON instead of flattened into columns.
- Select the pagination mechanism from the target API's documentation; do not infer one from the endpoint shape. Relative next-page URLs require `next_page_url_base`, page pagination requires `extraction_key`, and offset or page pagination requires `skip_key`.
3 changes: 3 additions & 0 deletions custom-recipes/api-connect/recipe.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
"icon": "icon-rocket"
},
"kind": "PYTHON",
"cobuild": {
"supported": true
},
"selectableFromDataset": "input_A_role",
"inputRoles": [
{
Expand Down