Mark embed and process instances as experimental

philippthun · philippthun · commit 589c97335e1a · 2026-02-13T13:54:32.000+01:00
diff --git a/docs/v3/source/includes/concepts/_embed.md.erb b/docs/v3/source/includes/concepts/_embed.md.erb
@@ -1,4 +1,4 @@
-## Embed
+## Embed (experimental)
 
 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.
 
diff --git a/docs/v3/source/includes/resources/processes/_get.md.erb b/docs/v3/source/includes/resources/processes/_get.md.erb
@@ -29,7 +29,7 @@ Content-Type: application/json
 
 Name | Type | Description
 ---- | ---- | ------------
-**embed** | _string_ | Comma-delimited list of resources to embed in the response. Valid values are `process_instances`. See [embed](#embed) for more details.
+**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.
 
 ```
 Example Request with Embedded Process Instances
diff --git a/docs/v3/source/includes/resources/processes/_list.md.erb b/docs/v3/source/includes/resources/processes/_list.md.erb
@@ -39,7 +39,7 @@ Name | Type | Description
 **per_page** | _integer_ | Number of results per page; <br>valid values are 1 through 5000
 **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending. <br>Valid values are `created_at`, `updated_at`
 **label_selector** | _string_ | A query string containing a list of [label selector](#labels-and-selectors) requirements
-**embed** | _string_ | Comma-delimited list of resources to embed in the response. Valid values are `process_instances`. See [embed](#embed) for more details.
+**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.
 **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)
 **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)
 
diff --git a/docs/v3/source/includes/resources/processes/_list_for_app.md.erb b/docs/v3/source/includes/resources/processes/_list_for_app.md.erb
@@ -36,7 +36,7 @@ Name | Type | Description
 **per_page** | _integer_ | Number of results per page; <br>valid values are 1 through 5000
 **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending. <br>Valid values are `created_at`, `updated_at`
 **label_selector** | _string_ | A query string containing a list of [label selector](#labels-and-selectors) requirements
-**embed** | _string_ | Comma-delimited list of resources to embed in the response. Valid values are `process_instances`. See [embed](#embed) for more details.
+**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.
 **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)
 **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)
 
diff --git a/docs/v3/source/includes/resources/processes/_process_instance_object.md.erb b/docs/v3/source/includes/resources/processes/_process_instance_object.md.erb
@@ -1,4 +1,4 @@
-### The process instance object
+### The process instance object (experimental)
 
 ```
 Example Process Instance object
diff --git a/docs/v3/source/includes/resources/processes/_process_instances.md.erb b/docs/v3/source/includes/resources/processes/_process_instances.md.erb
@@ -1,4 +1,4 @@
-### Get process instances for a process
+### Get process instances for a process (experimental)
 
 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.
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-## Embed`
	`1`	`+## Embed (experimental)`
`2`	`2`
`3`	`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.
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-### The process instance object`
	`1`	`+### The process instance object (experimental)`
`2`	`2`
`3`	`3`	```
`4`	`4`	`Example Process Instance object`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-### Get process instances for a process`
	`1`	`+### Get process instances for a process (experimental)`
`2`	`2`
`3`	`3`	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.
`4`	`4`