Skip to content

Miscellaneous Python SDK ref doc feedback #500

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.

Sign up for GitHub

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 2 commits into from
Feb 28, 2025
Merged

Miscellaneous Python SDK ref doc feedback #500

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0f4cef1
Miscellaneous Python SDK ref doc feedback
Paul-Cornell Feb 28, 2025
e2f9481
Missed pushing a file
Paul-Cornell Feb 28, 2025
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
2 changes: 1 addition & 1 deletion platform-api/api/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1395,7 +1395,7 @@ query parameters (for `curl` or Postman):

- `workflow_id=<workflow-id>`, replacing `<workflow-id>` with the workflow's unique ID.
To get this ID, see [List workflows](#list-workflows).
- `status=<status>`, replacing `<status>` with one of the following job statuses: `failed`, `finished`, or `running`.
- `status=<status>`, replacing `<status>` with one of the following job statuses: `completed`, `failed`, `im progress`, `scheduled`, and `stopped`.

For `curl` or Postman, you can specify multiple query parameters as `?workflow_id=<workflow-id>&status=<status>`.

Expand Down
13 changes: 10 additions & 3 deletions platform-api/api/workflows.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,10 +190,17 @@ Replace the preceding placeholders as follows:
- `<destination-connector-id>` (_required_) - The ID of the target destination connector. To get the ID,
use the `UnstructuredClient` object's `destinations.list_destinations` function (for the Python SDK) or
the `GET` method to call the `/destinations` endpoint (for `curl` or Postman). [Learn more](/platform-api/api/overview#list-destination-connectors).
- `<TYPE>` (for the Python SDK) or `<type>` (for `curl` or Postman) (_required_) - The workflow optimization type. [Learn more](/platform/partitioning). Available values include
`ADVANCED`, `BASIC`, `PLATINUM`, and `CUSTOM` (for the Python SDK) or
`advanced`, `basic`, `platinum`, and `custom` (for `curl` or Postman).
- `<TYPE>` (for the Python SDK) or `<type>` (for `curl` or Postman) (_required_) - The workflow type. Available values include `CUSTOM` (for the Python SDK) and `custom` (for `curl` or Postman).

If `<TYPE>` is set to `CUSTOM` (for the Python SDK), or if `<type>` is set to `custom` (for `curl` or Postman), you must add a `worfklow_nodes` array. For instructions, see [Custom workflow DAG nodes](#custom-workflow-dag-nodes).

<Note>
The previously-available workflow optimization types `ADVANCED`, `BASIC`, and `PLATINUM` (for the Python SDK) and
`advanced`, `basic`, and `platinum` (for `curl` or Postman) are non-operational and planned to be fully removed in a future release.

The ability to create an [automatic workflow](/platform/workflows#create-an-automatic-workflow) type is currently not available but is planned to be added in a future release.
</Note>

- `<schedule-timeframe>` - The repeating automatic run schedule, specified as a predefined phrase. The available predefined phrases are:

- `every 15 minutes` (for `curl` or Postman): Every 15 minutes (cron expression: `*/15 * * * *`).
Expand Down