From 9a93c0c086801ba1eefac8caad0fb3d6a5d56c8f Mon Sep 17 00:00:00 2001 From: Philipp Thun Date: Fri, 13 Feb 2026 13:54:32 +0100 Subject: [PATCH] Mark embed and process instances as experimental --- docs/v3/source/includes/concepts/_embed.md.erb | 2 +- docs/v3/source/includes/resources/processes/_get.md.erb | 2 +- docs/v3/source/includes/resources/processes/_list.md.erb | 2 +- .../v3/source/includes/resources/processes/_list_for_app.md.erb | 2 +- .../resources/processes/_process_instance_object.md.erb | 2 +- .../includes/resources/processes/_process_instances.md.erb | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/v3/source/includes/concepts/_embed.md.erb b/docs/v3/source/includes/concepts/_embed.md.erb index 0fdddb41c0..be174d0942 100644 --- a/docs/v3/source/includes/concepts/_embed.md.erb +++ b/docs/v3/source/includes/concepts/_embed.md.erb @@ -1,6 +1,6 @@ ## Embed -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. +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. **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. diff --git a/docs/v3/source/includes/resources/processes/_get.md.erb b/docs/v3/source/includes/resources/processes/_get.md.erb index 27996272d2..6b9008114c 100644 --- 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 index bca8803838..982eb32a9b 100644 --- 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;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending.
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 index a90d08ace0..8df713aa47 100644 --- 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;
valid values are 1 through 5000 **order_by** | _string_ | Value to sort by. Defaults to ascending; prepend with `-` to sort descending.
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 index c406c0c2ba..3232db954a 100644 --- 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 index 46baabb8c4..85c33372f0 100644 --- 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.