@smartspace/api-client 0.1.0-pr.976.50e1dfd → 0.1.0-pr.976.ba8c32f

package/dist/generated/chat/models/accessAccess.d.ts

@@ -6,6 +6,17 @@
  */
 import type { EnumsAccessType } from './enumsAccessType';
 import type { EnumsAppPrincipalType } from './enumsAppPrincipalType';
+/**
+ * Full read shape for an access grant. The model collides on the simple
+name with `SmartSpace.App.Data.Entities.EntityAccess` at the
+namespace alias boundary — but the entity uses a different short name
+(`EntityAccess`), so no alias is required when both are imported.
+            
+Display names (`DisplayName`, `UserEmailAddress`) are not
+columns on the entity — they are resolved at read time from Azure AD via
+`IUserService` / `IAzureADClient` and filled in by the service
+after loading.
+ */
 export interface AccessAccess {
     accessType: EnumsAccessType;
     /** @nullable */

package/dist/generated/chat/models/aiIModelProperty.d.ts

@@ -5,6 +5,12 @@
  * OpenAPI spec version: v1
  */
 import type { EnumsModelPropertyType } from './enumsModelPropertyType';
+/**
+ * Polymorphic AI-model parameter (Number / Boolean / String) — discriminator
+lives on `Type`. The shape is kept because the public JSON contract
+returns the variant-specific fields under one collection; flattening to a
+single record would be a breaking wire-shape change for the admin UI.
+ */
 export interface AiIModelProperty {
     readonly name: string;
     type: EnumsModelPropertyType;

package/dist/generated/chat/models/aiModel.d.ts

@@ -8,6 +8,13 @@ import type { AiModelDeployment } from './aiModelDeployment';
 import type { EnumsModelDeploymentProviderType } from './enumsModelDeploymentProviderType';
 import type { EnumsModelPublisher } from './enumsModelPublisher';
 import type { AiIModelProperty } from './aiIModelProperty';
+/**
+ * Full read model for an AI Model. Collides on the simple name with
+`SmartSpace.App.Data.Entities.Model`; alias
+`DataEntities = SmartSpace.App.Data.Entities` in files that import
+both. The folder is named `AiModels` to avoid the second namespace
+collision with `SmartSpace.App.Business.Models` itself.
+ */
 export interface AiModel {
     /** @nullable */
     createdAt?: string | null;

package/dist/generated/chat/models/aiModelSummary.d.ts

@@ -8,6 +8,11 @@ import type { EnumsModelDeploymentStatus } from './enumsModelDeploymentStatus';
 import type { EnumsModelDeploymentProviderType } from './enumsModelDeploymentProviderType';
 import type { EnumsModelPublisher } from './enumsModelPublisher';
 import type { AiIModelProperty } from './aiIModelProperty';
+/**
+ * Lighter list-endpoint shape — drops the nested `Deployment.Steps`
+collection and keeps a flat `DeploymentStatus` + provider type for
+the AI Models grid.
+ */
 export interface AiModelSummary {
     /** @nullable */
     createdAt?: string | null;

package/dist/generated/chat/models/commentComment.d.ts

@@ -5,6 +5,15 @@
  * OpenAPI spec version: v1
  */
 import type { MentionsMention } from './mentionsMention';
+/**
+ * Model for a Comment. Collides on the simple name with
+`SmartSpace.App.Data.Entities.Comment`; alias
+`DataEntities = SmartSpace.App.Data.Entities` in files that import
+both. `CreatedBy` (display name) sits outside the positional ctor
+because it can't be expression-tree-translated — the service hydrates it
+post-projection via `IUserService`. The nested
+`MentionedUsers[].Name` field follows the same pattern.
+ */
 export interface CommentComment {
     content: string;
     createdAt: string;

package/dist/generated/chat/models/commentCreateComment.d.ts

@@ -4,6 +4,13 @@
  * SmartSpace Chat API
  * OpenAPI spec version: v1
  */
+/**
+ * Request shape for creating a new comment. Posted against either
+`/messages/{id}/comments` or `/messageThreads/{id}/comments` —
+the parent id comes from the route, the body carries content and
+mention list only. Junction-style "no UpdateComment" — edits land as a
+follow-up if/when the feature exists.
+ */
 export interface CommentCreateComment {
     content: string;
     mentionedUsers: string[];

package/dist/generated/chat/models/connectorsConnectorSummary.d.ts

@@ -4,6 +4,12 @@
  * SmartSpace Chat API
  * OpenAPI spec version: v1
  */
+/**
+ * The shape non-admins are allowed to see: enough to pick a connector from a
+dropdown, and nothing more. No URL (that is infrastructure detail) and no
+auth settings. Used by the workspace MCP tab's picker and embedded in the
+workspace detail response so the flow editor can list what is attached.
+ */
 export interface ConnectorsConnectorSummary {
     /** @pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ */
     id: string;

package/dist/generated/chat/models/filesFile.d.ts

@@ -4,6 +4,18 @@
  * SmartSpace Chat API
  * OpenAPI spec version: v1
  */
+/**
+ * Model for a stored file blob. The simple name collides with
+`System.IO.File` and `SmartSpace.App.Data.Entities.FileEntity`
+(which is itself named to side-step the BCL collision); the
+`SmartSpace.App.Business.Models.Files` namespace disambiguates. When
+importing both this model and the entity, alias the entity side:
+```using DataEntities = SmartSpace.App.Data.Entities;```
+`ThreadId` reflects the entity column `MessageThreadId`
+(renamed at the model boundary because the API contract has always called
+it `threadId`). `WorkspaceId` keeps the lower-s spelling that
+matches the entity column and is already on the wire.
+ */
 export interface FilesFile {
     createdAt: string;
     createdByUserId: string;

package/dist/generated/chat/models/filesFileUriResponse.d.ts

@@ -4,6 +4,13 @@
  * SmartSpace Chat API
  * OpenAPI spec version: v1
  */
+/**
+ * Response shape for `GET /files/{id}/uri` on both the chat-api and
+config-api. Frontends call this with whatever URL the server hands them
+(e.g. as the `sourceUri` on a file MessageValue) and expect a JSON
+object — not a bare string — so the wire format stays extensible (we can
+add e.g. an expiry without breaking clients).
+ */
 export interface FilesFileUriResponse {
     uri: string;
 }

package/dist/generated/chat/models/mentionsMention.d.ts

@@ -4,6 +4,13 @@
  * SmartSpace Chat API
  * OpenAPI spec version: v1
  */
+/**
+ * Model for a single user mention inside a comment. `UserId` matches
+the principal id; `Name` sits outside the positional ctor because
+it can't be expression-tree-translated — the service hydrates it
+post-projection via `IUserService`.
+Comment-level association lives on the parent `Comment` record.
+ */
 export interface MentionsMention {
     /** @nullable */
     name?: string | null;

package/dist/generated/chat/models/notificationsNotification.d.ts

@@ -5,6 +5,15 @@
  * OpenAPI spec version: v1
  */
 import type { EnumsNotificationType } from './enumsNotificationType';
+/**
+ * Model for a Notification. Collides on the simple name with
+`SmartSpace.App.Data.Entities.Notification`; alias
+`DataEntities = SmartSpace.App.Data.Entities` in files that import
+both. `CreatedBy` (display name) sits outside the positional ctor
+because it can't be expression-tree-translated — the service hydrates it
+post-projection via `IUserService.GetPrincipalDisplayNameByIdAsync`
+and emits a `with { CreatedBy = ... }`.
+ */
 export interface NotificationsNotification {
     createdAt: string;
     /** @nullable */

package/dist/generated/chat/models/notificationsPagedNotifications.d.ts

@@ -5,6 +5,10 @@
  * OpenAPI spec version: v1
  */
 import type { NotificationsNotification } from './notificationsNotification';
+/**
+ * Notification list response shape. Two counts so callers can render an
+"X unread of Y total" badge without a second round-trip.
+ */
 export interface NotificationsPagedNotifications {
     data: NotificationsNotification[];
     total: number;

package/dist/generated/chat/models/usersAppUser.d.ts

@@ -4,6 +4,11 @@
  * SmartSpace Chat API
  * OpenAPI spec version: v1
  */
+/**
+ * Azure AD user principal model. Externally-sourced (Microsoft Graph) —
+there is no EF entity for this; the database only persists per-user
+junction state via SmartSpace.App.Business.Models.Users.UserPermission and similar.
+ */
 export interface UsersAppUser {
     displayName: string;
     /** @nullable */

package/dist/generated/chat/models/workSpaceInfo.d.ts

@@ -4,6 +4,12 @@
  * SmartSpace Chat API
  * OpenAPI spec version: v1
  */
+/**
+ * Cross-domain lightweight workspace pointer (id + name) embedded in
+shapes owned by other domains (e.g. SmartSpace.App.Business.Models.DataSpace). Stays
+in the legacy `SmartSpace.App.Business.Models` namespace until
+those domains migrate.
+ */
 export interface WorkSpaceInfo {
     /** @pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ */
     id: string;

package/dist/generated/chat/models/workSpacesWorkSpace.d.ts

@@ -9,6 +9,15 @@ import type { DataSpace } from './dataSpace';
 import type { WorkSpacesWorkSpaceInputs } from './workSpacesWorkSpaceInputs';
 import type { ModelConfiguration } from './modelConfiguration';
 import type { WorkSpacesWorkSpaceVariables } from './workSpacesWorkSpaceVariables';
+/**
+ * Full read model for a WorkSpace. Collides on the simple name with
+`SmartSpace.App.Data.Entities.WorkSpace`; alias
+`DataEntities = SmartSpace.App.Data.Entities` in files that import
+both. References pre-existing cross-domain models
+(SmartSpace.App.Business.Models.DataSpace, SmartSpace.App.Business.Models.ModelConfiguration,
+SmartSpace.App.Business.Models.Flows.FlowInput, SmartSpace.App.Business.Models.Flows.FlowVariable) — those are not
+re-modelled by this PR.
+ */
 export interface WorkSpacesWorkSpace {
     connectors: ConnectorsConnectorSummary[];
     createdAt: string;

package/dist/generated/chat/zod.js

@@ -43,7 +43,7 @@ exports.filesUploadFilesResponseItem = zod_1.default.object({
     "size": zod_1.default.number(),
     "threadId": zod_1.default.string().regex(exports.filesUploadFilesResponseThreadIdRegExp).nullish(),
     "workspaceId": zod_1.default.string().regex(exports.filesUploadFilesResponseWorkspaceIdRegExp).nullish()
-});
+}).describe('Model for a stored file blob. The simple name collides with\r\n`System.IO.File` and `SmartSpace.App.Data.Entities.FileEntity`\r\n(which is itself named to side-step the BCL collision); the\r\n`SmartSpace.App.Business.Models.Files` namespace disambiguates. When\r\nimporting both this model and the entity, alias the entity side:\r\n```using DataEntities = SmartSpace.App.Data.Entities;```\n`ThreadId` reflects the entity column `MessageThreadId`\r\n(renamed at the model boundary because the API contract has always called\r\nit `threadId`). `WorkspaceId` keeps the lower-s spelling that\r\nmatches the entity column and is already on the wire.');
 exports.filesUploadFilesResponse = zod_1.default.array(exports.filesUploadFilesResponseItem);
 /**
  * @summary Get details for a file previously uploaded.
@@ -71,7 +71,7 @@ exports.filesGetFileInfoResponse = zod_1.default.object({
     "size": zod_1.default.number(),
     "threadId": zod_1.default.string().regex(exports.filesGetFileInfoResponseThreadIdRegExp).nullish(),
     "workspaceId": zod_1.default.string().regex(exports.filesGetFileInfoResponseWorkspaceIdRegExp).nullish()
-});
+}).describe('Model for a stored file blob. The simple name collides with\r\n`System.IO.File` and `SmartSpace.App.Data.Entities.FileEntity`\r\n(which is itself named to side-step the BCL collision); the\r\n`SmartSpace.App.Business.Models.Files` namespace disambiguates. When\r\nimporting both this model and the entity, alias the entity side:\r\n```using DataEntities = SmartSpace.App.Data.Entities;```\n`ThreadId` reflects the entity column `MessageThreadId`\r\n(renamed at the model boundary because the API contract has always called\r\nit `threadId`). `WorkspaceId` keeps the lower-s spelling that\r\nmatches the entity column and is already on the wire.');
 /**
  * @summary Download a previously uploaded file.
  */
@@ -100,7 +100,7 @@ exports.filesGetUriQueryParams = zod_1.default.strictObject({
 });
 exports.filesGetUriResponse = zod_1.default.object({
     "uri": zod_1.default.string()
-});
+}).describe('Response shape for `GET /files/{id}/uri` on both the chat-api and\r\nconfig-api. Frontends call this with whatever URL the server hands them\r\n(e.g. as the `sourceUri` on a file MessageValue) and expect a JSON\r\nobject — not a bare string — so the wire format stays extensible (we can\r\nadd e.g. an expiry without breaking clients).');
 /**
  * @summary Requests cancellation of a queued or running flow run (the chat
 thread id is the flow run id). Cancellation is cooperative: the
@@ -173,7 +173,7 @@ exports.messageThreadsGetCommentsResponse = zod_1.default.object({
         "mentionedUsers": zod_1.default.array(zod_1.default.object({
             "name": zod_1.default.string().nullish(),
             "userId": zod_1.default.string()
-        })),
+        }).describe('Model for a single user mention inside a comment. `UserId` matches\r\nthe principal id; `Name` sits outside the positional ctor because\r\nit can\'t be expression-tree-translated — the service hydrates it\r\npost-projection via `IUserService`.\r\nComment-level association lives on the parent `Comment` record.')),
         "messageThreadId": zod_1.default.string().regex(exports.messageThreadsGetCommentsResponseDataItemMessageThreadIdRegExp)
     })),
     "total": zod_1.default.number()
@@ -188,7 +188,7 @@ exports.messageThreadsPostCommentParams = zod_1.default.strictObject({
 exports.messageThreadsPostCommentBody = zod_1.default.strictObject({
     "content": zod_1.default.string(),
     "mentionedUsers": zod_1.default.array(zod_1.default.string())
-});
+}).describe('Request shape for creating a new comment. Posted against either\r\n`/messages/{id}/comments` or `/messageThreads/{id}/comments` —\r\nthe parent id comes from the route, the body carries content and\r\nmention list only. Junction-style \"no UpdateComment\" — edits land as a\r\nfollow-up if/when the feature exists.');
 exports.messageThreadsPostCommentResponseIdRegExp = new RegExp('^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$');
 exports.messageThreadsPostCommentResponseMessageIdRegExp = new RegExp('^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$');
 exports.messageThreadsPostCommentResponseMessageThreadIdRegExp = new RegExp('^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$');
@@ -201,10 +201,10 @@ exports.messageThreadsPostCommentResponse = zod_1.default.object({
     "mentionedUsers": zod_1.default.array(zod_1.default.object({
         "name": zod_1.default.string().nullish(),
         "userId": zod_1.default.string()
-    })),
+    }).describe('Model for a single user mention inside a comment. `UserId` matches\r\nthe principal id; `Name` sits outside the positional ctor because\r\nit can\'t be expression-tree-translated — the service hydrates it\r\npost-projection via `IUserService`.\r\nComment-level association lives on the parent `Comment` record.')),
     "messageId": zod_1.default.string().regex(exports.messageThreadsPostCommentResponseMessageIdRegExp).nullish(),
     "messageThreadId": zod_1.default.string().regex(exports.messageThreadsPostCommentResponseMessageThreadIdRegExp)
-});
+}).describe('Model for a Comment. Collides on the simple name with\r\n`SmartSpace.App.Data.Entities.Comment`; alias\r\n`DataEntities = SmartSpace.App.Data.Entities` in files that import\r\nboth. `CreatedBy` (display name) sits outside the positional ctor\r\nbecause it can\'t be expression-tree-translated — the service hydrates it\r\npost-projection via `IUserService`. The nested\r\n`MentionedUsers[].Name` field follows the same pattern.');
 /**
  * @summary Mark a message thread as favorited or not in SmartSpace, using the thread's ID and a boolean value in the request.
  */
@@ -300,7 +300,7 @@ exports.messageThreadsGetThreadUsersResponseItem = zod_1.default.object({
     "emailAddress": zod_1.default.string().nullish(),
     "id": zod_1.default.string(),
     "userId": zod_1.default.string()
-});
+}).describe('Azure AD user principal model. Externally-sourced (Microsoft Graph) —\r\nthere is no EF entity for this; the database only persists per-user\r\njunction state via SmartSpace.App.Business.Models.Users.UserPermission and similar.');
 exports.messageThreadsGetThreadUsersResponse = zod_1.default.array(exports.messageThreadsGetThreadUsersResponseItem);
 /**
  * @summary Add a user to a message thread.
@@ -438,7 +438,7 @@ exports.messagesGetCommentsResponse = zod_1.default.object({
         "mentionedUsers": zod_1.default.array(zod_1.default.object({
             "name": zod_1.default.string().nullish(),
             "userId": zod_1.default.string()
-        })),
+        }).describe('Model for a single user mention inside a comment. `UserId` matches\r\nthe principal id; `Name` sits outside the positional ctor because\r\nit can\'t be expression-tree-translated — the service hydrates it\r\npost-projection via `IUserService`.\r\nComment-level association lives on the parent `Comment` record.')),
         "messageThreadId": zod_1.default.string().regex(exports.messagesGetCommentsResponseDataItemMessageThreadIdRegExp)
     })),
     "total": zod_1.default.number()
@@ -453,7 +453,7 @@ exports.messagesPostCommentParams = zod_1.default.strictObject({
 exports.messagesPostCommentBody = zod_1.default.strictObject({
     "content": zod_1.default.string(),
     "mentionedUsers": zod_1.default.array(zod_1.default.string())
-});
+}).describe('Request shape for creating a new comment. Posted against either\r\n`/messages/{id}/comments` or `/messageThreads/{id}/comments` —\r\nthe parent id comes from the route, the body carries content and\r\nmention list only. Junction-style \"no UpdateComment\" — edits land as a\r\nfollow-up if/when the feature exists.');
 exports.messagesPostCommentResponseIdRegExp = new RegExp('^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$');
 exports.messagesPostCommentResponseMessageIdRegExp = new RegExp('^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$');
 exports.messagesPostCommentResponseMessageThreadIdRegExp = new RegExp('^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$');
@@ -466,10 +466,10 @@ exports.messagesPostCommentResponse = zod_1.default.object({
     "mentionedUsers": zod_1.default.array(zod_1.default.object({
         "name": zod_1.default.string().nullish(),
         "userId": zod_1.default.string()
-    })),
+    }).describe('Model for a single user mention inside a comment. `UserId` matches\r\nthe principal id; `Name` sits outside the positional ctor because\r\nit can\'t be expression-tree-translated — the service hydrates it\r\npost-projection via `IUserService`.\r\nComment-level association lives on the parent `Comment` record.')),
     "messageId": zod_1.default.string().regex(exports.messagesPostCommentResponseMessageIdRegExp).nullish(),
     "messageThreadId": zod_1.default.string().regex(exports.messagesPostCommentResponseMessageThreadIdRegExp)
-});
+}).describe('Model for a Comment. Collides on the simple name with\r\n`SmartSpace.App.Data.Entities.Comment`; alias\r\n`DataEntities = SmartSpace.App.Data.Entities` in files that import\r\nboth. `CreatedBy` (display name) sits outside the positional ctor\r\nbecause it can\'t be expression-tree-translated — the service hydrates it\r\npost-projection via `IUserService`. The nested\r\n`MentionedUsers[].Name` field follows the same pattern.');
 /**
  * @summary Append a new input value to an in-flight message and stream successive
 snapshots back to the client. Each frame is a full M:SmartSpace.App.ChatApi.Controllers.MessagesController.Message(System.Guid)
@@ -511,9 +511,9 @@ exports.modelsGetModelsResponse = zod_1.default.object({
         "properties": zod_1.default.array(zod_1.default.object({
             "name": zod_1.default.string(),
             "type": zod_1.default.enum(['Boolean', 'Number', 'String'])
-        })),
+        }).describe('Polymorphic AI-model parameter (Number / Boolean / String) — discriminator\r\nlives on `Type`. The shape is kept because the public JSON contract\r\nreturns the variant-specific fields under one collection; flattening to a\r\nsingle record would be a breaking wire-shape change for the admin UI.')),
         "virtualMachineUrl": zod_1.default.string().nullish()
-    })),
+    }).describe('Lighter list-endpoint shape — drops the nested `Deployment.Steps`\r\ncollection and keeps a flat `DeploymentStatus` + provider type for\r\nthe AI Models grid.')),
     "total": zod_1.default.number()
 });
 /**
@@ -565,8 +565,8 @@ exports.modelsGetModelResponse = zod_1.default.object({
     "properties": zod_1.default.array(zod_1.default.object({
         "name": zod_1.default.string(),
         "type": zod_1.default.enum(['Boolean', 'Number', 'String'])
-    }))
-});
+    }).describe('Polymorphic AI-model parameter (Number / Boolean / String) — discriminator\r\nlives on `Type`. The shape is kept because the public JSON contract\r\nreturns the variant-specific fields under one collection; flattening to a\r\nsingle record would be a breaking wire-shape change for the admin UI.'))
+}).describe('Full read model for an AI Model. Collides on the simple name with\r\n`SmartSpace.App.Data.Entities.Model`; alias\r\n`DataEntities = SmartSpace.App.Data.Entities` in files that import\r\nboth. The folder is named `AiModels` to avoid the second namespace\r\ncollision with `SmartSpace.App.Business.Models` itself.');
 /**
  * @summary Retrieve notifications for user login.
  */
@@ -591,10 +591,10 @@ exports.notificationGetResponse = zod_1.default.object({
         "notificationType": zod_1.default.enum(['WorkSpaceUpdated', 'MessageThreadUpdated', 'CommentUpdated', 'AddedToThread']),
         "threadId": zod_1.default.string().regex(exports.notificationGetResponseDataItemThreadIdRegExp).nullish(),
         "workSpaceId": zod_1.default.string().regex(exports.notificationGetResponseDataItemWorkSpaceIdRegExp).nullish()
-    })),
+    }).describe('Model for a Notification. Collides on the simple name with\r\n`SmartSpace.App.Data.Entities.Notification`; alias\r\n`DataEntities = SmartSpace.App.Data.Entities` in files that import\r\nboth. `CreatedBy` (display name) sits outside the positional ctor\r\nbecause it can\'t be expression-tree-translated — the service hydrates it\r\npost-projection via `IUserService.GetPrincipalDisplayNameByIdAsync`\r\nand emits a `with { CreatedBy = ... }`.')),
     "total": zod_1.default.number(),
     "totalUnread": zod_1.default.number()
-});
+}).describe('Notification list response shape. Two counts so callers can render an\r\n\"X unread of Y total\" badge without a second round-trip.');
 /**
  * @summary Update: mark read notifications.
  */
@@ -646,7 +646,7 @@ exports.workSpacesGetGetResponse = zod_1.default.object({
             "id": zod_1.default.string().regex(exports.workSpacesGetGetResponseDataItemConnectorsItemIdRegExp),
             "kind": zod_1.default.string(),
             "name": zod_1.default.string()
-        })),
+        }).describe('The shape non-admins are allowed to see: enough to pick a connector from a\r\ndropdown, and nothing more. No URL (that is infrastructure detail) and no\r\nauth settings. Used by the workspace MCP tab\'s picker and embedded in the\r\nworkspace detail response so the flow editor can list what is attached.')),
         "createdAt": zod_1.default.iso.datetime({}),
         "createdByUserId": zod_1.default.string(),
         "dataSpaces": zod_1.default.array(zod_1.default.object({
@@ -748,7 +748,7 @@ exports.workSpacesGetGetResponse = zod_1.default.object({
             "workspacesInfo": zod_1.default.array(zod_1.default.object({
                 "id": zod_1.default.string().regex(exports.workSpacesGetGetResponseDataItemDataSpacesItemWorkspacesInfoItemIdRegExp),
                 "name": zod_1.default.string()
-            })).nullish()
+            }).describe('Cross-domain lightweight workspace pointer (id + name) embedded in\r\nshapes owned by other domains (e.g. SmartSpace.App.Business.Models.DataSpace). Stays\r\nin the legacy `SmartSpace.App.Business.Models` namespace until\r\nthose domains migrate.')).nullish()
         })),
         "favorited": zod_1.default.boolean(),
         "firstPrompt": zod_1.default.string().nullish(),
@@ -817,7 +817,7 @@ exports.workSpacesGetGetResponse = zod_1.default.object({
             "access": zod_1.default.enum(['None', 'Read', 'Write']),
             "schema": zod_1.default.record(zod_1.default.string(), zod_1.default.any())
         }))
-    })),
+    }).describe('Full read model for a WorkSpace. Collides on the simple name with\r\n`SmartSpace.App.Data.Entities.WorkSpace`; alias\r\n`DataEntities = SmartSpace.App.Data.Entities` in files that import\r\nboth. References pre-existing cross-domain models\r\n(SmartSpace.App.Business.Models.DataSpace, SmartSpace.App.Business.Models.ModelConfiguration,\r\nSmartSpace.App.Business.Models.Flows.FlowInput, SmartSpace.App.Business.Models.Flows.FlowVariable) — those are not\r\nre-modelled by this PR.')),
     "total": zod_1.default.number()
 });
 /**
@@ -851,7 +851,7 @@ exports.workSpacesGetIdResponse = zod_1.default.object({
         "id": zod_1.default.string().regex(exports.workSpacesGetIdResponseConnectorsItemIdRegExp),
         "kind": zod_1.default.string(),
         "name": zod_1.default.string()
-    })),
+    }).describe('The shape non-admins are allowed to see: enough to pick a connector from a\r\ndropdown, and nothing more. No URL (that is infrastructure detail) and no\r\nauth settings. Used by the workspace MCP tab\'s picker and embedded in the\r\nworkspace detail response so the flow editor can list what is attached.')),
     "createdAt": zod_1.default.iso.datetime({}),
     "createdByUserId": zod_1.default.string(),
     "dataSpaces": zod_1.default.array(zod_1.default.object({
@@ -953,7 +953,7 @@ exports.workSpacesGetIdResponse = zod_1.default.object({
         "workspacesInfo": zod_1.default.array(zod_1.default.object({
             "id": zod_1.default.string().regex(exports.workSpacesGetIdResponseDataSpacesItemWorkspacesInfoItemIdRegExp),
             "name": zod_1.default.string()
-        })).nullish()
+        }).describe('Cross-domain lightweight workspace pointer (id + name) embedded in\r\nshapes owned by other domains (e.g. SmartSpace.App.Business.Models.DataSpace). Stays\r\nin the legacy `SmartSpace.App.Business.Models` namespace until\r\nthose domains migrate.')).nullish()
     })),
     "favorited": zod_1.default.boolean(),
     "firstPrompt": zod_1.default.string().nullish(),
@@ -1022,7 +1022,7 @@ exports.workSpacesGetIdResponse = zod_1.default.object({
         "access": zod_1.default.enum(['None', 'Read', 'Write']),
         "schema": zod_1.default.record(zod_1.default.string(), zod_1.default.any())
     }))
-});
+}).describe('Full read model for a WorkSpace. Collides on the simple name with\r\n`SmartSpace.App.Data.Entities.WorkSpace`; alias\r\n`DataEntities = SmartSpace.App.Data.Entities` in files that import\r\nboth. References pre-existing cross-domain models\r\n(SmartSpace.App.Business.Models.DataSpace, SmartSpace.App.Business.Models.ModelConfiguration,\r\nSmartSpace.App.Business.Models.Flows.FlowInput, SmartSpace.App.Business.Models.Flows.FlowVariable) — those are not\r\nre-modelled by this PR.');
 /**
  * @summary Retrieves the access control details of a workspace.
  */
@@ -1052,7 +1052,7 @@ exports.workSpacesGetAccessResponse = zod_1.default.object({
         "principalType": zod_1.default.enum(['Unknown', 'User', 'ServicePrincipal', 'Internal']).optional(),
         "userEmailAddress": zod_1.default.string().nullish(),
         "workSpaceId": zod_1.default.string().regex(exports.workSpacesGetAccessResponseDataItemWorkSpaceIdRegExp).nullish()
-    })),
+    }).describe('Full read shape for an access grant. The model collides on the simple\r\nname with `SmartSpace.App.Data.Entities.EntityAccess` at the\r\nnamespace alias boundary — but the entity uses a different short name\r\n(`EntityAccess`), so no alias is required when both are imported.\r\n            \r\nDisplay names (`DisplayName`, `UserEmailAddress`) are not\r\ncolumns on the entity — they are resolved at read time from Azure AD via\r\n`IUserService` / `IAzureADClient` and filled in by the service\r\nafter loading.')),
     "total": zod_1.default.number()
 });
 /**
@@ -1104,7 +1104,7 @@ exports.workSpacesGetUsersResponseItem = zod_1.default.object({
     "emailAddress": zod_1.default.string().nullish(),
     "id": zod_1.default.string(),
     "userId": zod_1.default.string()
-});
+}).describe('Azure AD user principal model. Externally-sourced (Microsoft Graph) —\r\nthere is no EF entity for this; the database only persists per-user\r\njunction state via SmartSpace.App.Business.Models.Users.UserPermission and similar.');
 exports.workSpacesGetUsersResponse = zod_1.default.array(exports.workSpacesGetUsersResponseItem);
 /**
  * @summary Retrieve a Shared Access Signature (SAS) for a specific document in a data space, using the dataSpaceId and optional file parameter.

package/dist/generated/config/models/accessAccess.d.ts

@@ -6,6 +6,17 @@
  */
 import type { EnumsAccessType } from './enumsAccessType';
 import type { EnumsAppPrincipalType } from './enumsAppPrincipalType';
+/**
+ * Full read shape for an access grant. The model collides on the simple
+name with `SmartSpace.App.Data.Entities.EntityAccess` at the
+namespace alias boundary — but the entity uses a different short name
+(`EntityAccess`), so no alias is required when both are imported.
+            
+Display names (`DisplayName`, `UserEmailAddress`) are not
+columns on the entity — they are resolved at read time from Azure AD via
+`IUserService` / `IAzureADClient` and filled in by the service
+after loading.
+ */
 export interface AccessAccess {
     accessType: EnumsAccessType;
     /** @nullable */

package/dist/generated/config/models/accessAccessWorkSpace.d.ts

@@ -6,6 +6,12 @@
  */
 import type { EnumsAccessType } from './enumsAccessType';
 import type { EnumsAppPrincipalType } from './enumsAppPrincipalType';
+/**
+ * Per-workspace access summary surfaced by the "what workspaces does this
+user belong to" lookups. Carries the workspace's name alongside the
+access grant so callers can render the assignment list without an
+additional workspace lookup.
+ */
 export interface AccessAccessWorkSpace {
     accessType: EnumsAccessType;
     /** @nullable */

package/dist/generated/config/models/accessCreateAccess.d.ts

@@ -5,6 +5,10 @@
  * OpenAPI spec version: v1
  */
 import type { EnumsAccessType } from './enumsAccessType';
+/**
+ * Request body for creating an access grant. Access records are junction
+rows — there is no `UpdateAccess`; the convention is delete + create.
+ */
 export interface AccessCreateAccess {
     accessType: EnumsAccessType;
     objectId: string;

package/dist/generated/config/models/activitiesActivityWorkSpace.d.ts

@@ -6,6 +6,14 @@
  */
 import type { EnumsActivityType } from './enumsActivityType';
 import type { ActivitiesLlmUsageMetrics } from './activitiesLlmUsageMetrics';
+/**
+ * Workspace-scoped activity row returned by the activity log endpoint. The
+`EventDescription`, `Prompt`, `Response`, and
+`QueryNumber` are deserialised from the activity's
+`DisplayName` (a JSON-serialised `WorkSpaceConfiguration`);
+`LlmUsages` and `DurationMs` from `MetricsJson`. Build
+happens in service code — see `ActivityService.GetLogWorkSpaceAsync`.
+ */
 export interface ActivitiesActivityWorkSpace {
     activityType?: EnumsActivityType;
     /** @nullable */

package/dist/generated/config/models/aiIModelProperty.d.ts

@@ -5,6 +5,12 @@
  * OpenAPI spec version: v1
  */
 import type { EnumsModelPropertyType } from './enumsModelPropertyType';
+/**
+ * Polymorphic AI-model parameter (Number / Boolean / String) — discriminator
+lives on `Type`. The shape is kept because the public JSON contract
+returns the variant-specific fields under one collection; flattening to a
+single record would be a breaking wire-shape change for the admin UI.
+ */
 export interface AiIModelProperty {
     readonly name: string;
     type: EnumsModelPropertyType;

package/dist/generated/config/models/aiModel.d.ts

@@ -8,6 +8,13 @@ import type { AiModelDeployment } from './aiModelDeployment';
 import type { EnumsModelDeploymentProviderType } from './enumsModelDeploymentProviderType';
 import type { EnumsModelPublisher } from './enumsModelPublisher';
 import type { AiIModelProperty } from './aiIModelProperty';
+/**
+ * Full read model for an AI Model. Collides on the simple name with
+`SmartSpace.App.Data.Entities.Model`; alias
+`DataEntities = SmartSpace.App.Data.Entities` in files that import
+both. The folder is named `AiModels` to avoid the second namespace
+collision with `SmartSpace.App.Business.Models` itself.
+ */
 export interface AiModel {
     /** @nullable */
     createdAt?: string | null;

package/dist/generated/config/models/aiModelSummary.d.ts

@@ -8,6 +8,11 @@ import type { EnumsModelDeploymentStatus } from './enumsModelDeploymentStatus';
 import type { EnumsModelDeploymentProviderType } from './enumsModelDeploymentProviderType';
 import type { EnumsModelPublisher } from './enumsModelPublisher';
 import type { AiIModelProperty } from './aiIModelProperty';
+/**
+ * Lighter list-endpoint shape — drops the nested `Deployment.Steps`
+collection and keeps a flat `DeploymentStatus` + provider type for
+the AI Models grid.
+ */
 export interface AiModelSummary {
     /** @nullable */
     createdAt?: string | null;

package/dist/generated/config/models/blocksBlockInfo.d.ts

@@ -6,6 +6,12 @@
  */
 import type { BlocksBlockInterface } from './blocksBlockInterface';
 import type { EnumsBlockType } from './enumsBlockType';
+/**
+ * Flattened block descriptor — one `BlockInfo` per (name, version) pair
+across every visible `BlockSet`. This is the shape the
+`BlocksController` returns; the dictionary-of-dictionaries layout is
+reconstructed by the service from the underlying interfaces.
+ */
 export interface BlocksBlockInfo {
     /** @pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ */
     blockSetId: string;

package/dist/generated/config/models/blocksBlockInterface.d.ts

@@ -8,6 +8,15 @@ import type { BlocksBlockInterfaceMetadata } from './blocksBlockInterfaceMetadat
 import type { BlocksBlockInterfacePorts } from './blocksBlockInterfacePorts';
 import type { EnumsBlockScope } from './enumsBlockScope';
 import type { BlocksBlockInterfaceState } from './blocksBlockInterfaceState';
+/**
+ * Model for a block interface — the schema that describes a single
+(name, version) pair of a block (ports, state, scope). Collides on the
+simple name with `SmartSpace.App.Data.Entities.BlockInterface`; alias
+`DataEntities = SmartSpace.App.Data.Entities` in files that import
+both. `Name` and `Version` live on the entity but are surfaced
+here too so the wire shape is self-describing (the same model travels via
+SignalR debug payloads where the keys are stripped).
+ */
 export interface BlocksBlockInterface {
     metadata: BlocksBlockInterfaceMetadata;
     ports: BlocksBlockInterfacePorts;

package/dist/generated/config/models/blocksBlockSet.d.ts

@@ -7,6 +7,13 @@
 import type { BlocksBlockSetBlockInterfaces } from './blocksBlockSetBlockInterfaces';
 import type { EnumsBlockType } from './enumsBlockType';
 import type { BlocksUsedInWorkspaceRef } from './blocksUsedInWorkspaceRef';
+/**
+ * Model for a `BlockSet` — a versioned collection of block interfaces.
+Collides on the simple name with `SmartSpace.App.Data.Entities.BlockSet`;
+alias `DataEntities = SmartSpace.App.Data.Entities` in files that
+import both. `BlockInterfaces` is keyed by block name then version to
+match the API shape consumers expect.
+ */
 export interface BlocksBlockSet {
     blockInterfaces: BlocksBlockSetBlockInterfaces;
     /** @nullable */

package/dist/generated/config/models/blocksInputPinInterface.d.ts

@@ -9,6 +9,12 @@ import type { BlocksInputPinInterfaceGenerics } from './blocksInputPinInterfaceG
 import type { BlocksInputPinInterfaceMetadata } from './blocksInputPinInterfaceMetadata';
 import type { BlocksInputPinInterfaceSchema } from './blocksInputPinInterfaceSchema';
 import type { EnumsPinType } from './enumsPinType';
+/**
+ * Model for an input pin on a block port. Mirrors the live
+`SmartSpace.App.Data.Entities.InputPinInterface` shape but exposes the
+parsed JSON payloads (`Metadata`, `Schema`, `Generics`,
+`Default`) rather than the raw `*Json` columns.
+ */
 export interface BlocksInputPinInterface {
     channel: boolean;
     /** @nullable */

package/dist/generated/config/models/blocksOutputPinInterface.d.ts

@@ -8,6 +8,12 @@ import type { BlocksOutputPinInterfaceGenerics } from './blocksOutputPinInterfac
 import type { BlocksOutputPinInterfaceMetadata } from './blocksOutputPinInterfaceMetadata';
 import type { BlocksOutputPinInterfaceSchema } from './blocksOutputPinInterfaceSchema';
 import type { EnumsPinType } from './enumsPinType';
+/**
+ * Model for an output pin on a block port. Mirrors the live
+`SmartSpace.App.Data.Entities.OutputPinInterface` shape but exposes the
+parsed JSON payloads (`Metadata`, `Schema`, `Generics`)
+rather than the raw `*Json` columns.
+ */
 export interface BlocksOutputPinInterface {
     channel: boolean;
     /** @nullable */

package/dist/generated/config/models/blocksPortInterface.d.ts

@@ -8,6 +8,11 @@ import type { BlocksPortInterfaceInputs } from './blocksPortInterfaceInputs';
 import type { BlocksPortInterfaceMetadata } from './blocksPortInterfaceMetadata';
 import type { BlocksPortInterfaceOutputs } from './blocksPortInterfaceOutputs';
 import type { EnumsPortType } from './enumsPortType';
+/**
+ * Model for a block `PortInterface`. Inputs and Outputs are keyed by pin
+name (entities store them as `List<...>` with a `Key`
+column; the model exposes them as dictionaries to match the API shape).
+ */
 export interface BlocksPortInterface {
     inputs: BlocksPortInterfaceInputs;
     isFunction: boolean;