diff --git a/custom-recipes/api-connect/Cobuild.md b/custom-recipes/api-connect/Cobuild.md new file mode 100644 index 0000000..5685154 --- /dev/null +++ b/custom-recipes/api-connect/Cobuild.md @@ -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`. diff --git a/custom-recipes/api-connect/recipe.json b/custom-recipes/api-connect/recipe.json index f836ed9..c4793de 100644 --- a/custom-recipes/api-connect/recipe.json +++ b/custom-recipes/api-connect/recipe.json @@ -5,6 +5,9 @@ "icon": "icon-rocket" }, "kind": "PYTHON", + "cobuild": { + "supported": true + }, "selectableFromDataset": "input_A_role", "inputRoles": [ {