Skip to content
Draft
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
22 changes: 22 additions & 0 deletions custom-recipes/api-connect/Cobuild.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Cobuild guidance

Role-specific behavior:
- `input_A_role` supplies one API call per row and the column values available to request templates.
- `api_output` collects the response rows extracted from those calls and any paginated responses.

Request behavior:
- Columns selected in `parameter_columns` become `{{column_name}}` template variables across the URL, headers, query parameters, body, and pagination settings; `parameter_renamings` changes their template names.
- `should_use_user_secrets=true` also exposes the current user's Profile > My account > Other credentials as template variables.
- `body_format=RAW` uses `text_body`; `FORM_DATA` and `MULTIPART_FORM_DATA` use `key_value_body`.
- `auth_type=null` selects the generic `credential` preset path; each secure authentication type selects its corresponding preset field.
- For API-key presets, API Connect automatically injects the key into either a request header or query parameter, as configured by the user in the preset.

Response extraction:
- 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.

Pagination:
- Select the pagination mechanism from the target API's documentation; do not infer one from the endpoint shape.
- For next-page pagination, `next_page_url_key` is the dot-separated response path containing the following request URL. When that URL is relative, enable `is_next_page_url_relative` and provide `next_page_url_base`.
- Page pagination requires `extraction_key` so the recipe can locate and count the returned data array.
- For offset and page pagination, `skip_key` is the query parameter carrying the next offset or page number.
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