Skip to content

Commit 6d5b46b

Browse files
authored
Mark embed and process instances as experimental (#4847)
1 parent 81d35e4 commit 6d5b46b

File tree

6 files changed

+6
-6
lines changed

6 files changed

+6
-6
lines changed

docs/v3/source/includes/concepts/_embed.md.erb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Embed
22

3-
The `embed` parameter allows clients to fetch resources and include information of related pseudo-resources directly in the response. This is different from the [`include`](#include) parameter, which is used for fetching parent resources.
3+
The experimental `embed` parameter allows clients to fetch resources and include information of related pseudo-resources directly in the response. This is different from the [`include`](#include) parameter, which is used for fetching parent resources.
44

55
**Important:** The `embed` feature is specifically designed for pseudo-resources that, by design, do not have their own list endpoint. These are resources that are tightly coupled to their parent resource and only make sense in the context of that parent. While they may have a GET endpoint to retrieve them individually for a specific parent, they cannot be listed independently across all parents.
66

docs/v3/source/includes/resources/processes/_get.md.erb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Content-Type: application/json
2929

3030
Name | Type | Description
3131
---- | ---- | ------------
32-
**embed** | _string_ | Comma-delimited list of resources to embed in the response. Valid values are `process_instances`. See [embed](#embed) for more details.
32+
**embed** | _string_ | Comma-delimited list of resources to embed in the response. Valid values are `process_instances`. See [embed](#embed) for more details. This parameter is experimental.
3333

3434
```
3535
Example Request with Embedded Process Instances

docs/v3/source/includes/resources/processes/_list.md.erb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Name | Type | Description
3939
**per_page** | _integer_ | Number of results per page; <br>valid values are 1 through 5000
4040
**order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending. <br>Valid values are `created_at`, `updated_at`
4141
**label_selector** | _string_ | A query string containing a list of [label selector](#labels-and-selectors) requirements
42-
**embed** | _string_ | Comma-delimited list of resources to embed in the response. Valid values are `process_instances`. See [embed](#embed) for more details.
42+
**embed** | _string_ | Comma-delimited list of resources to embed in the response. Valid values are `process_instances`. See [embed](#embed) for more details. This parameter is experimental.
4343
**created_ats** | _[timestamp](#timestamps)_ | Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with [relational operators](#relational-operators)
4444
**updated_ats** | _[timestamp](#timestamps)_ | Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with [relational operators](#relational-operators)
4545

docs/v3/source/includes/resources/processes/_list_for_app.md.erb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Name | Type | Description
3636
**per_page** | _integer_ | Number of results per page; <br>valid values are 1 through 5000
3737
**order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending. <br>Valid values are `created_at`, `updated_at`
3838
**label_selector** | _string_ | A query string containing a list of [label selector](#labels-and-selectors) requirements
39-
**embed** | _string_ | Comma-delimited list of resources to embed in the response. Valid values are `process_instances`. See [embed](#embed) for more details.
39+
**embed** | _string_ | Comma-delimited list of resources to embed in the response. Valid values are `process_instances`. See [embed](#embed) for more details. This parameter is experimental.
4040
**created_ats** | _[timestamp](#timestamps)_ | Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with [relational operators](#relational-operators)
4141
**updated_ats** | _[timestamp](#timestamps)_ | Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with [relational operators](#relational-operators)
4242

docs/v3/source/includes/resources/processes/_process_instance_object.md.erb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### The process instance object
1+
### The process instance object (experimental)
22

33
```
44
Example Process Instance object

docs/v3/source/includes/resources/processes/_process_instances.md.erb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### Get process instances for a process
1+
### Get process instances for a process (experimental)
22

33
This endpoint retrieves the instances for a process. This is a pseudo-resource that provides a lightweight view of process instance states, containing only the `index`, `state`, and `since` fields. Unlike the full [process stats](#get-stats-for-a-process) endpoint, this endpoint is designed for embedding into process resources and provides a minimal representation.
44

0 commit comments

Comments
 (0)