Skip to content

Commit dbf5ca4

Browse files
authored
Miscellaneous Python SDK ref doc feedback (#500)
1 parent 9f80a91 commit dbf5ca4

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

platform-api/api/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1395,7 +1395,7 @@ query parameters (for `curl` or Postman):
13951395

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

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

platform-api/api/workflows.mdx

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -190,10 +190,17 @@ Replace the preceding placeholders as follows:
190190
- `<destination-connector-id>` (_required_) - The ID of the target destination connector. To get the ID,
191191
use the `UnstructuredClient` object's `destinations.list_destinations` function (for the Python SDK) or
192192
the `GET` method to call the `/destinations` endpoint (for `curl` or Postman). [Learn more](/platform-api/api/overview#list-destination-connectors).
193-
- `<TYPE>` (for the Python SDK) or `<type>` (for `curl` or Postman) (_required_) - The workflow optimization type. [Learn more](/platform/partitioning). Available values include
194-
`ADVANCED`, `BASIC`, `PLATINUM`, and `CUSTOM` (for the Python SDK) or
195-
`advanced`, `basic`, `platinum`, and `custom` (for `curl` or Postman).
193+
- `<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).
194+
196195
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).
196+
197+
<Note>
198+
The previously-available workflow optimization types `ADVANCED`, `BASIC`, and `PLATINUM` (for the Python SDK) and
199+
`advanced`, `basic`, and `platinum` (for `curl` or Postman) are non-operational and planned to be fully removed in a future release.
200+
201+
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.
202+
</Note>
203+
197204
- `<schedule-timeframe>` - The repeating automatic run schedule, specified as a predefined phrase. The available predefined phrases are:
198205

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

0 commit comments

Comments
 (0)