From 14223e515a2d012fa9d45706c1d41958fbb5dce0 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 7 Oct 2026 18:34:51 +0000 Subject: [PATCH] feat: Updated OpenAPI spec --- ...CreateWByWIdAnalyticsConsumptionExport.g.cs | 18 +++++++++++++++--- ...yWIdAnalyticsConsumptionExportAsStream.g.cs | 12 ++++++++++-- ...CreateWByWIdAnalyticsConsumptionExport.g.cs | 18 +++++++++++++++--- ...yWIdAnalyticsConsumptionExportAsStream.g.cs | 12 ++++++++++-- ...nalyticsConsumptionExportRequestFilter.g.cs | 6 ++++-- src/libs/Dust/openapi.yaml | 6 +++--- 6 files changed, 57 insertions(+), 15 deletions(-) diff --git a/src/libs/Dust/Generated/Dust.AnalyticsClient.CreateWByWIdAnalyticsConsumptionExport.g.cs b/src/libs/Dust/Generated/Dust.AnalyticsClient.CreateWByWIdAnalyticsConsumptionExport.g.cs index 1608b6e..a86657a 100644 --- a/src/libs/Dust/Generated/Dust.AnalyticsClient.CreateWByWIdAnalyticsConsumptionExport.g.cs +++ b/src/libs/Dust/Generated/Dust.AnalyticsClient.CreateWByWIdAnalyticsConsumptionExport.g.cs @@ -63,7 +63,11 @@ partial void ProcessCreateWByWIdAnalyticsConsumptionExportResponseContent( /// The export can be filtered by various dimensions (agents, users, API keys, groups, models, tools, skills, sources, tags).
/// The export is limited to a maximum of 30 days per request and times out after 10 seconds: reduce the time range
/// or apply filters to reduce the number of rows if you encounter a timeout.
- /// Results are streamed, if an error occurs, an error message is appended and the stream is closed. + /// Results are streamed, if an error occurs, an error message is appended and the stream is closed.
+ /// An admin API key can export the whole workspace. Any other API key must filter on `groups`, and
+ /// must be allowed to read the analytics of every group listed. The rows then cover the messages of
+ /// the users who were members of those groups when the message was sent, and the `userGroupIds`
+ /// and `userGroupNames` columns only list the requested groups. /// /// /// @@ -94,7 +98,11 @@ partial void ProcessCreateWByWIdAnalyticsConsumptionExportResponseContent( /// The export can be filtered by various dimensions (agents, users, API keys, groups, models, tools, skills, sources, tags).
/// The export is limited to a maximum of 30 days per request and times out after 10 seconds: reduce the time range
/// or apply filters to reduce the number of rows if you encounter a timeout.
- /// Results are streamed, if an error occurs, an error message is appended and the stream is closed. + /// Results are streamed, if an error occurs, an error message is appended and the stream is closed.
+ /// An admin API key can export the whole workspace. Any other API key must filter on `groups`, and
+ /// must be allowed to read the analytics of every group listed. The rows then cover the messages of
+ /// the users who were members of those groups when the message was sent, and the `userGroupIds`
+ /// and `userGroupNames` columns only list the requested groups. /// /// /// @@ -570,7 +578,11 @@ partial void ProcessCreateWByWIdAnalyticsConsumptionExportResponseContent( /// The export can be filtered by various dimensions (agents, users, API keys, groups, models, tools, skills, sources, tags).
/// The export is limited to a maximum of 30 days per request and times out after 10 seconds: reduce the time range
/// or apply filters to reduce the number of rows if you encounter a timeout.
- /// Results are streamed, if an error occurs, an error message is appended and the stream is closed. + /// Results are streamed, if an error occurs, an error message is appended and the stream is closed.
+ /// An admin API key can export the whole workspace. Any other API key must filter on `groups`, and
+ /// must be allowed to read the analytics of every group listed. The rows then cover the messages of
+ /// the users who were members of those groups when the message was sent, and the `userGroupIds`
+ /// and `userGroupNames` columns only list the requested groups. /// /// /// diff --git a/src/libs/Dust/Generated/Dust.AnalyticsClient.CreateWByWIdAnalyticsConsumptionExportAsStream.g.cs b/src/libs/Dust/Generated/Dust.AnalyticsClient.CreateWByWIdAnalyticsConsumptionExportAsStream.g.cs index e722f93..5aea723 100644 --- a/src/libs/Dust/Generated/Dust.AnalyticsClient.CreateWByWIdAnalyticsConsumptionExportAsStream.g.cs +++ b/src/libs/Dust/Generated/Dust.AnalyticsClient.CreateWByWIdAnalyticsConsumptionExportAsStream.g.cs @@ -58,7 +58,11 @@ partial void ProcessCreateWByWIdAnalyticsConsumptionExportAsStreamResponse( /// The export can be filtered by various dimensions (agents, users, API keys, groups, models, tools, skills, sources, tags).
/// The export is limited to a maximum of 30 days per request and times out after 10 seconds: reduce the time range
/// or apply filters to reduce the number of rows if you encounter a timeout.
- /// Results are streamed, if an error occurs, an error message is appended and the stream is closed. + /// Results are streamed, if an error occurs, an error message is appended and the stream is closed.
+ /// An admin API key can export the whole workspace. Any other API key must filter on `groups`, and
+ /// must be allowed to read the analytics of every group listed. The rows then cover the messages of
+ /// the users who were members of those groups when the message was sent, and the `userGroupIds`
+ /// and `userGroupNames` columns only list the requested groups. /// /// /// @@ -414,7 +418,11 @@ partial void ProcessCreateWByWIdAnalyticsConsumptionExportAsStreamResponse( /// The export can be filtered by various dimensions (agents, users, API keys, groups, models, tools, skills, sources, tags).
/// The export is limited to a maximum of 30 days per request and times out after 10 seconds: reduce the time range
/// or apply filters to reduce the number of rows if you encounter a timeout.
- /// Results are streamed, if an error occurs, an error message is appended and the stream is closed. + /// Results are streamed, if an error occurs, an error message is appended and the stream is closed.
+ /// An admin API key can export the whole workspace. Any other API key must filter on `groups`, and
+ /// must be allowed to read the analytics of every group listed. The rows then cover the messages of
+ /// the users who were members of those groups when the message was sent, and the `userGroupIds`
+ /// and `userGroupNames` columns only list the requested groups. /// /// /// diff --git a/src/libs/Dust/Generated/Dust.IAnalyticsClient.CreateWByWIdAnalyticsConsumptionExport.g.cs b/src/libs/Dust/Generated/Dust.IAnalyticsClient.CreateWByWIdAnalyticsConsumptionExport.g.cs index 678b9b2..15bef0a 100644 --- a/src/libs/Dust/Generated/Dust.IAnalyticsClient.CreateWByWIdAnalyticsConsumptionExport.g.cs +++ b/src/libs/Dust/Generated/Dust.IAnalyticsClient.CreateWByWIdAnalyticsConsumptionExport.g.cs @@ -11,7 +11,11 @@ public partial interface IAnalyticsClient /// The export can be filtered by various dimensions (agents, users, API keys, groups, models, tools, skills, sources, tags).
/// The export is limited to a maximum of 30 days per request and times out after 10 seconds: reduce the time range
/// or apply filters to reduce the number of rows if you encounter a timeout.
- /// Results are streamed, if an error occurs, an error message is appended and the stream is closed. + /// Results are streamed, if an error occurs, an error message is appended and the stream is closed.
+ /// An admin API key can export the whole workspace. Any other API key must filter on `groups`, and
+ /// must be allowed to read the analytics of every group listed. The rows then cover the messages of
+ /// the users who were members of those groups when the message was sent, and the `userGroupIds`
+ /// and `userGroupNames` columns only list the requested groups. /// /// /// @@ -31,7 +35,11 @@ public partial interface IAnalyticsClient /// The export can be filtered by various dimensions (agents, users, API keys, groups, models, tools, skills, sources, tags).
/// The export is limited to a maximum of 30 days per request and times out after 10 seconds: reduce the time range
/// or apply filters to reduce the number of rows if you encounter a timeout.
- /// Results are streamed, if an error occurs, an error message is appended and the stream is closed. + /// Results are streamed, if an error occurs, an error message is appended and the stream is closed.
+ /// An admin API key can export the whole workspace. Any other API key must filter on `groups`, and
+ /// must be allowed to read the analytics of every group listed. The rows then cover the messages of
+ /// the users who were members of those groups when the message was sent, and the `userGroupIds`
+ /// and `userGroupNames` columns only list the requested groups. /// /// /// @@ -51,7 +59,11 @@ public partial interface IAnalyticsClient /// The export can be filtered by various dimensions (agents, users, API keys, groups, models, tools, skills, sources, tags).
/// The export is limited to a maximum of 30 days per request and times out after 10 seconds: reduce the time range
/// or apply filters to reduce the number of rows if you encounter a timeout.
- /// Results are streamed, if an error occurs, an error message is appended and the stream is closed. + /// Results are streamed, if an error occurs, an error message is appended and the stream is closed.
+ /// An admin API key can export the whole workspace. Any other API key must filter on `groups`, and
+ /// must be allowed to read the analytics of every group listed. The rows then cover the messages of
+ /// the users who were members of those groups when the message was sent, and the `userGroupIds`
+ /// and `userGroupNames` columns only list the requested groups. /// /// /// diff --git a/src/libs/Dust/Generated/Dust.IAnalyticsClient.CreateWByWIdAnalyticsConsumptionExportAsStream.g.cs b/src/libs/Dust/Generated/Dust.IAnalyticsClient.CreateWByWIdAnalyticsConsumptionExportAsStream.g.cs index d32e9f5..75c6cca 100644 --- a/src/libs/Dust/Generated/Dust.IAnalyticsClient.CreateWByWIdAnalyticsConsumptionExportAsStream.g.cs +++ b/src/libs/Dust/Generated/Dust.IAnalyticsClient.CreateWByWIdAnalyticsConsumptionExportAsStream.g.cs @@ -11,7 +11,11 @@ public partial interface IAnalyticsClient /// The export can be filtered by various dimensions (agents, users, API keys, groups, models, tools, skills, sources, tags).
/// The export is limited to a maximum of 30 days per request and times out after 10 seconds: reduce the time range
/// or apply filters to reduce the number of rows if you encounter a timeout.
- /// Results are streamed, if an error occurs, an error message is appended and the stream is closed. + /// Results are streamed, if an error occurs, an error message is appended and the stream is closed.
+ /// An admin API key can export the whole workspace. Any other API key must filter on `groups`, and
+ /// must be allowed to read the analytics of every group listed. The rows then cover the messages of
+ /// the users who were members of those groups when the message was sent, and the `userGroupIds`
+ /// and `userGroupNames` columns only list the requested groups. /// /// /// @@ -31,7 +35,11 @@ public partial interface IAnalyticsClient /// The export can be filtered by various dimensions (agents, users, API keys, groups, models, tools, skills, sources, tags).
/// The export is limited to a maximum of 30 days per request and times out after 10 seconds: reduce the time range
/// or apply filters to reduce the number of rows if you encounter a timeout.
- /// Results are streamed, if an error occurs, an error message is appended and the stream is closed. + /// Results are streamed, if an error occurs, an error message is appended and the stream is closed.
+ /// An admin API key can export the whole workspace. Any other API key must filter on `groups`, and
+ /// must be allowed to read the analytics of every group listed. The rows then cover the messages of
+ /// the users who were members of those groups when the message was sent, and the `userGroupIds`
+ /// and `userGroupNames` columns only list the requested groups. /// /// /// diff --git a/src/libs/Dust/Generated/Dust.Models.CreateWAnalyticsConsumptionExportRequestFilter.g.cs b/src/libs/Dust/Generated/Dust.Models.CreateWAnalyticsConsumptionExportRequestFilter.g.cs index b967c78..aa19d83 100644 --- a/src/libs/Dust/Generated/Dust.Models.CreateWAnalyticsConsumptionExportRequestFilter.g.cs +++ b/src/libs/Dust/Generated/Dust.Models.CreateWAnalyticsConsumptionExportRequestFilter.g.cs @@ -28,7 +28,8 @@ public sealed partial class CreateWAnalyticsConsumptionExportRequestFilter public global::System.Collections.Generic.IList? ApiKeys { get; set; } /// - /// Group IDs to filter on + /// Group IDs to filter on. Required, with at least one non-empty value, unless the
+ /// API key has admin scope. /// [global::System.Text.Json.Serialization.JsonPropertyName("groups")] public global::System.Collections.Generic.IList? Groups { get; set; } @@ -82,7 +83,8 @@ public sealed partial class CreateWAnalyticsConsumptionExportRequestFilter /// API key names to filter on /// /// - /// Group IDs to filter on + /// Group IDs to filter on. Required, with at least one non-empty value, unless the
+ /// API key has admin scope. /// /// /// Model IDs to filter on diff --git a/src/libs/Dust/openapi.yaml b/src/libs/Dust/openapi.yaml index 85a38dc..9390853 100644 --- a/src/libs/Dust/openapi.yaml +++ b/src/libs/Dust/openapi.yaml @@ -133,7 +133,7 @@ "/api/v1/w/{wId}/analytics/consumption/export": { "post": { "summary": "Export consumption analytics", - "description": "Export per-call consumption analytics for the workspace identified by {wId}.\nEach row represents one unit of billed credit consumption (an LLM call or a tool call).\nThe export can be filtered by various dimensions (agents, users, API keys, groups, models, tools, skills, sources, tags).\nThe export is limited to a maximum of 30 days per request and times out after 10 seconds: reduce the time range\nor apply filters to reduce the number of rows if you encounter a timeout.\nResults are streamed, if an error occurs, an error message is appended and the stream is closed.\n", + "description": "Export per-call consumption analytics for the workspace identified by {wId}.\nEach row represents one unit of billed credit consumption (an LLM call or a tool call).\nThe export can be filtered by various dimensions (agents, users, API keys, groups, models, tools, skills, sources, tags).\nThe export is limited to a maximum of 30 days per request and times out after 10 seconds: reduce the time range\nor apply filters to reduce the number of rows if you encounter a timeout.\nResults are streamed, if an error occurs, an error message is appended and the stream is closed.\n\nAn admin API key can export the whole workspace. Any other API key must filter on `groups`, and\nmust be allowed to read the analytics of every group listed. The rows then cover the messages of\nthe users who were members of those groups when the message was sent, and the `userGroupIds`\nand `userGroupNames` columns only list the requested groups.\n", "tags": [ "Analytics" ], @@ -218,7 +218,7 @@ "type": "string", "maxLength": 256 }, - "description": "Group IDs to filter on" + "description": "Group IDs to filter on. Required, with at least one non-empty value, unless the\nAPI key has admin scope.\n" }, "models": { "type": "array", @@ -288,7 +288,7 @@ "description": "Invalid request body (missing fields, invalid dates, range exceeds 30 days)" }, "403": { - "description": "Requires an API key with admin scope" + "description": "The workspace does not have access to the consumption export API, or the API key has no\nadmin scope and the export is not restricted to groups whose analytics it can read.\n" }, "500": { "description": "Internal Server Error"