Skip to content

DeepTutor: Lifelong Personalized Tutoring. https://deeptutor.info/.

Regenerate frontend contracts for integrated settings and handoff routes

Bingxi Zhao (Frank)79543b6c69a2
diff --git a/web/contracts/generated/api.ts b/web/contracts/generated/api.ts
index a894c1a3c..225de6d96 100644
--- a/web/contracts/generated/api.ts
+++ b/web/contracts/generated/api.ts
@@ -452,11 +452,7 @@ export interface paths {
readonly put?: never;
/**
* Admin Create User
- * @description Admin-only: create a new user account.
- *
- * Replaces the public ``/register`` flow once the first admin exists. The
- * new account is always created with role=``user``; admins can promote
- * later via ``PUT /users/{username}/role``.
+ * @description Admin-only: create one ordinary user account.
*/
readonly post: operations["admin_create_user_api_auth_users_post"];
readonly delete?: never;
@@ -526,6 +522,49 @@ export interface paths {
readonly patch?: never;
readonly trace?: never;
};
+ readonly "/api/auth/users/batch-delete": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ readonly get?: never;
+ readonly put?: never;
+ /**
+ * Batch Remove Users
+ * @description Delete selected users and report each outcome separately.
+ */
+ readonly post: operations["batch_remove_users_api_auth_users_batch_delete_post"];
+ readonly delete?: never;
+ readonly options?: never;
+ readonly head?: never;
+ readonly patch?: never;
+ readonly trace?: never;
+ };
+ readonly "/api/auth/users/import": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ readonly get?: never;
+ readonly put?: never;
+ /**
+ * Admin Import Users
+ * @description Admin-only: provision ordinary users from a CSV file.
+ *
+ * The response is row-oriented so one invalid record does not erase the
+ * context of the valid records around it. Passwords are never returned.
+ */
+ readonly post: operations["admin_import_users_api_auth_users_import_post"];
+ readonly delete?: never;
+ readonly options?: never;
+ readonly head?: never;
+ readonly patch?: never;
+ readonly trace?: never;
+ };
readonly "/api/books": {
readonly parameters: {
readonly query?: never;
@@ -2179,6 +2218,23 @@ export interface paths {
readonly patch?: never;
readonly trace?: never;
};
+ readonly "/api/knowledge-bases/{kb_name}/web-source-sync": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ /** Get Web Source Sync Jobs */
+ readonly get: operations["get_web_source_sync_jobs_api_knowledge_bases__kb_name__web_source_sync_get"];
+ readonly put?: never;
+ readonly post?: never;
+ readonly delete?: never;
+ readonly options?: never;
+ readonly head?: never;
+ readonly patch?: never;
+ readonly trace?: never;
+ };
readonly "/api/knowledge-bases/{kb_name}/web-source/{source_id}": {
readonly parameters: {
readonly query?: never;
@@ -2196,6 +2252,57 @@ export interface paths {
readonly patch?: never;
readonly trace?: never;
};
+ readonly "/api/knowledge-bases/{kb_name}/web-source/{source_id}/cancel": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ readonly get?: never;
+ readonly put?: never;
+ /** Cancel Web Source Sync */
+ readonly post: operations["cancel_web_source_sync_api_knowledge_bases__kb_name__web_source__source_id__cancel_post"];
+ readonly delete?: never;
+ readonly options?: never;
+ readonly head?: never;
+ readonly patch?: never;
+ readonly trace?: never;
+ };
+ readonly "/api/knowledge-bases/{kb_name}/web-source/{source_id}/retry": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ readonly get?: never;
+ readonly put?: never;
+ /** Retry Web Source Sync */
+ readonly post: operations["retry_web_source_sync_api_knowledge_bases__kb_name__web_source__source_id__retry_post"];
+ readonly delete?: never;
+ readonly options?: never;
+ readonly head?: never;
+ readonly patch?: never;
+ readonly trace?: never;
+ };
+ readonly "/api/knowledge-bases/{kb_name}/web-source/{source_id}/schedule": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ readonly get?: never;
+ /** Update Web Source Schedule */
+ readonly put: operations["update_web_source_schedule_api_knowledge_bases__kb_name__web_source__source_id__schedule_put"];
+ readonly post?: never;
+ readonly delete?: never;
+ readonly options?: never;
+ readonly head?: never;
+ readonly patch?: never;
+ readonly trace?: never;
+ };
readonly "/api/knowledge-bases/{kb_name}/web-sources": {
readonly parameters: {
readonly query?: never;
@@ -7537,6 +7644,46 @@ export interface paths {
readonly patch?: never;
readonly trace?: never;
};
+ readonly "/api/settings/presets": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ /**
+ * Get Settings Presets
+ * @description List value-free starting points for a reviewable draft.
+ */
+ readonly get: operations["get_settings_presets_api_settings_presets_get"];
+ readonly put?: never;
+ readonly post?: never;
+ readonly delete?: never;
+ readonly options?: never;
+ readonly head?: never;
+ readonly patch?: never;
+ readonly trace?: never;
+ };
+ readonly "/api/settings/presets/{preset_id}/draft": {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: never;
+ readonly path?: never;
+ readonly cookie?: never;
+ };
+ readonly get?: never;
+ readonly put?: never;
+ /**
+ * Stage Settings Preset
+ * @description Load a named preset into the existing draft for review.
+ */
+ readonly post: operations["stage_settings_preset_api_settings_presets__preset_id__draft_post"];
+ readonly delete?: never;
+ readonly options?: never;
+ readonly head?: never;
+ readonly patch?: never;
+ readonly trace?: never;
+ };
readonly "/api/settings/profile": {
readonly parameters: {
readonly query?: never;
@@ -9977,6 +10124,14 @@ export interface components {
/** Url */
readonly url: string;
};
+ /**
+ * AdminBatchDeleteRequest
+ * @description Usernames for an admin-initiated batch deletion.
+ */
+ readonly AdminBatchDeleteRequest: {
+ /** Usernames */
+ readonly usernames: readonly string[];
+ };
/**
* AdminCreateUserRequest
* @description Admin user-creation payload.
@@ -10249,6 +10404,11 @@ export interface components {
/** Operation Id */
readonly operation_id: string;
};
+ /** Body_admin_import_users_api_auth_users_import_post */
+ readonly Body_admin_import_users_api_auth_users_import_post: {
+ /** File */
+ readonly file: string;
+ };
/** Body_create_knowledge_base_api_knowledge_bases_post */
readonly Body_create_knowledge_base_api_knowledge_bases_post: {
/**
@@ -12856,6 +13016,18 @@ export interface components {
readonly options: {
readonly [key: string]: string;
};
+ /**
+ * Origin Ref
+ * @default
+ */
+ readonly origin_ref: string;
+ /**
+ * Origin Type
+ * @default conversation
+ * @enum {string}
+ */
+ readonly origin_type:
+ "conversation" | "external_import" | "document_analysis";
/** Practice */
readonly practice?: {
readonly [key: string]: unknown;
@@ -12903,7 +13075,10 @@ export interface components {
* @default
*/
readonly section_title: string;
- /** Session Id */
+ /**
+ * Session Id
+ * @default
+ */
readonly session_id: string;
/**
* Session Title
@@ -13949,6 +14124,20 @@ export interface components {
readonly [key: string]: unknown;
};
};
+ /**
+ * SettingsPresetDraftRequest
+ * @description The current draft envelope submitted alongside a named preset.
+ */
+ readonly SettingsPresetDraftRequest: {
+ /** Catalog */
+ readonly catalog?: {
+ readonly [key: string]: unknown;
+ } | null;
+ /** Extensions */
+ readonly extensions?: {
+ readonly [key: string]: unknown;
+ };
+ };
/**
* SettingsProfileImportPayload
* @description An exported value-free settings profile submitted for review only.
@@ -14987,6 +15176,18 @@ export interface components {
readonly options?: {
readonly [key: string]: string;
} | null;
+ /**
+ * Origin Ref
+ * @default
+ */
+ readonly origin_ref: string;
+ /**
+ * Origin Type
+ * @default conversation
+ * @enum {string}
+ */
+ readonly origin_type:
+ "conversation" | "external_import" | "document_analysis";
/** Quality */
readonly quality?: number | null;
/** Question */
@@ -15015,7 +15216,10 @@ export interface components {
* @default
*/
readonly section_title: string;
- /** Session Id */
+ /**
+ * Session Id
+ * @default
+ */
readonly session_id: string;
/**
* Source
@@ -15225,6 +15429,11 @@ export interface components {
* @default
*/
readonly added_at: string;
+ /**
+ * Auto Sync Enabled
+ * @default true
+ */
+ readonly auto_sync_enabled: boolean;
/**
* Enabled
* @default true
@@ -15263,9 +15472,51 @@ export interface components {
* @default 0
*/
readonly page_count: number;
+ /**
+ * Sync Interval Hours
+ * @default 24
+ */
+ readonly sync_interval_hours: number;
/** Url */
readonly url: string;
};
+ /** WebSourceScheduleUpdate */
+ readonly WebSourceScheduleUpdate: {
+ /** Auto Sync Enabled */
+ readonly auto_sync_enabled: boolean;
+ /**
+ * Sync Interval Hours
+ * @default 24
+ */
+ readonly sync_interval_hours: number;
+ };
+ /** WebSourceSyncJobInfo */
+ readonly WebSourceSyncJobInfo: {
+ /**
+ * Attempt
+ * @default 0
+ */
+ readonly attempt: number;
+ /**
+ * Cancel Requested
+ * @default false
+ */
+ readonly cancel_requested: boolean;
+ /** Error */
+ readonly error?: string | null;
+ /** Kb Name */
+ readonly kb_name: string;
+ /** Last Run At */
+ readonly last_run_at?: number | null;
+ /** Next Run At */
+ readonly next_run_at: number;
+ /** Owner Id */
+ readonly owner_id: string;
+ /** Source Id */
+ readonly source_id: string;
+ /** State */
+ readonly state: string;
+ };
/** WhiteboardPinRequest */
readonly WhiteboardPinRequest: {
/** Event Id */
@@ -15350,6 +15601,8 @@ export type SchemaAddGitHubSourceRequest =
export type SchemaAddRecordRequest = components["schemas"]["AddRecordRequest"];
export type SchemaAddWebSourceRequest =
components["schemas"]["AddWebSourceRequest"];
+export type SchemaAdminBatchDeleteRequest =
+ components["schemas"]["AdminBatchDeleteRequest"];
export type SchemaAdminCreateUserRequest =
components["schemas"]["AdminCreateUserRequest"];
export type SchemaAnnotationInfo = components["schemas"]["AnnotationInfo"];
@@ -15369,6 +15622,8 @@ export type SchemaAuthStatusResponse =
components["schemas"]["AuthStatusResponse"];
export type SchemaAutoMarkRequest = components["schemas"]["AutoMarkRequest"];
export type SchemaAutoMarkResponse = components["schemas"]["AutoMarkResponse"];
+export type SchemaBodyAdminImportUsersApiAuthUsersImportPost =
+ components["schemas"]["Body_admin_import_users_api_auth_users_import_post"];
export type SchemaBodyCreateKnowledgeBaseApiKnowledgeBasesPost =
components["schemas"]["Body_create_knowledge_base_api_knowledge_bases_post"];
export type SchemaBodyImportDocxApiDocumentsImportDocxPost =
@@ -15747,6 +16002,8 @@ export type SchemaSetSyllabusRequest =
components["schemas"]["SetSyllabusRequest"];
export type SchemaSettingsDraftPayload =
components["schemas"]["SettingsDraftPayload"];
+export type SchemaSettingsPresetDraftRequest =
+ components["schemas"]["SettingsPresetDraftRequest"];
export type SchemaSettingsProfileImportPayload =
components["schemas"]["SettingsProfileImportPayload"];
export type SchemaSidebarDescriptionUpdate =
@@ -15847,6 +16104,10 @@ export type SchemaVoiceAutoplayUpdate =
export type SchemaVoicePreviewPayload =
components["schemas"]["VoicePreviewPayload"];
export type SchemaWebSourceInfo = components["schemas"]["WebSourceInfo"];
+export type SchemaWebSourceScheduleUpdate =
+ components["schemas"]["WebSourceScheduleUpdate"];
+export type SchemaWebSourceSyncJobInfo =
+ components["schemas"]["WebSourceSyncJobInfo"];
export type SchemaWhiteboardPinRequest =
components["schemas"]["WhiteboardPinRequest"];
export type SchemaWorkspaceCreateRequest =
@@ -16910,6 +17171,84 @@ export interface operations {
};
};
};
+ readonly batch_remove_users_api_auth_users_batch_delete_post: {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: {
+ readonly Authorization?: string | null;
+ };
+ readonly path?: never;
+ readonly cookie?: {
+ readonly dt_token?: string | null;
+ };
+ };
+ readonly requestBody: {
+ readonly content: {
+ readonly "application/json": components["schemas"]["AdminBatchDeleteRequest"];
+ };
+ };
+ readonly responses: {
+ /** @description Successful Response */
+ readonly 200: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": {
+ readonly [key: string]: unknown;
+ };
+ };
+ };
+ /** @description Validation Error */
+ readonly 422: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": components["schemas"]["HTTPValidationError"];
+ };
+ };
+ };
+ };
+ readonly admin_import_users_api_auth_users_import_post: {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: {
+ readonly Authorization?: string | null;
+ };
+ readonly path?: never;
+ readonly cookie?: {
+ readonly dt_token?: string | null;
+ };
+ };
+ readonly requestBody: {
+ readonly content: {
+ readonly "multipart/form-data": components["schemas"]["Body_admin_import_users_api_auth_users_import_post"];
+ };
+ };
+ readonly responses: {
+ /** @description Successful Response */
+ readonly 200: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": {
+ readonly [key: string]: unknown;
+ };
+ };
+ };
+ /** @description Validation Error */
+ readonly 422: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": components["schemas"]["HTTPValidationError"];
+ };
+ };
+ };
+ };
readonly list_books_api_books_get: {
readonly parameters: {
readonly query?: never;
@@ -20577,6 +20916,41 @@ export interface operations {
};
};
};
+ readonly get_web_source_sync_jobs_api_knowledge_bases__kb_name__web_source_sync_get: {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: {
+ readonly Authorization?: string | null;
+ };
+ readonly path: {
+ readonly kb_name: string;
+ };
+ readonly cookie?: {
+ readonly dt_token?: string | null;
+ };
+ };
+ readonly requestBody?: never;
+ readonly responses: {
+ /** @description Successful Response */
+ readonly 200: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": readonly components["schemas"]["WebSourceSyncJobInfo"][];
+ };
+ };
+ /** @description Validation Error */
+ readonly 422: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": components["schemas"]["HTTPValidationError"];
+ };
+ };
+ };
+ };
readonly remove_web_source_api_knowledge_bases__kb_name__web_source__source_id__delete: {
readonly parameters: {
readonly query?: never;
@@ -20613,6 +20987,118 @@ export interface operations {
};
};
};
+ readonly cancel_web_source_sync_api_knowledge_bases__kb_name__web_source__source_id__cancel_post: {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: {
+ readonly Authorization?: string | null;
+ };
+ readonly path: {
+ readonly kb_name: string;
+ readonly source_id: string;
+ };
+ readonly cookie?: {
+ readonly dt_token?: string | null;
+ };
+ };
+ readonly requestBody?: never;
+ readonly responses: {
+ /** @description Successful Response */
+ readonly 200: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": unknown;
+ };
+ };
+ /** @description Validation Error */
+ readonly 422: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": components["schemas"]["HTTPValidationError"];
+ };
+ };
+ };
+ };
+ readonly retry_web_source_sync_api_knowledge_bases__kb_name__web_source__source_id__retry_post: {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: {
+ readonly Authorization?: string | null;
+ };
+ readonly path: {
+ readonly kb_name: string;
+ readonly source_id: string;
+ };
+ readonly cookie?: {
+ readonly dt_token?: string | null;
+ };
+ };
+ readonly requestBody?: never;
+ readonly responses: {
+ /** @description Successful Response */
+ readonly 200: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": unknown;
+ };
+ };
+ /** @description Validation Error */
+ readonly 422: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": components["schemas"]["HTTPValidationError"];
+ };
+ };
+ };
+ };
+ readonly update_web_source_schedule_api_knowledge_bases__kb_name__web_source__source_id__schedule_put: {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: {
+ readonly Authorization?: string | null;
+ };
+ readonly path: {
+ readonly kb_name: string;
+ readonly source_id: string;
+ };
+ readonly cookie?: {
+ readonly dt_token?: string | null;
+ };
+ };
+ readonly requestBody: {
+ readonly content: {
+ readonly "application/json": components["schemas"]["WebSourceScheduleUpdate"];
+ };
+ };
+ readonly responses: {
+ /** @description Successful Response */
+ readonly 200: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": components["schemas"]["WebSourceInfo"];
+ };
+ };
+ /** @description Validation Error */
+ readonly 422: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": components["schemas"]["HTTPValidationError"];
+ };
+ };
+ };
+ };
readonly get_web_sources_api_knowledge_bases__kb_name__web_sources_get: {
readonly parameters: {
readonly query?: never;
@@ -28404,8 +28890,11 @@ export interface operations {
readonly query: {
/** @description Return 204 No Content instead of 404 when the entry is absent — used by the quiz viewer to probe not-yet-saved questions without logging noisy 404s. */
readonly missing_ok?: boolean;
+ readonly origin_ref?: string;
+ readonly origin_type?:
+ "conversation" | "external_import" | "document_analysis";
readonly question_id: string;
- readonly session_id: string;
+ readonly session_id?: string;
readonly turn_id?: string | null;
};
readonly header?: {
@@ -32846,6 +33335,80 @@ export interface operations {
};
};
};
+ readonly get_settings_presets_api_settings_presets_get: {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: {
+ readonly Authorization?: string | null;
+ };
+ readonly path?: never;
+ readonly cookie?: {
+ readonly dt_token?: string | null;
+ };
+ };
+ readonly requestBody?: never;
+ readonly responses: {
+ /** @description Successful Response */
+ readonly 200: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": unknown;
+ };
+ };
+ /** @description Validation Error */
+ readonly 422: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": components["schemas"]["HTTPValidationError"];
+ };
+ };
+ };
+ };
+ readonly stage_settings_preset_api_settings_presets__preset_id__draft_post: {
+ readonly parameters: {
+ readonly query?: never;
+ readonly header?: {
+ readonly Authorization?: string | null;
+ };
+ readonly path: {
+ readonly preset_id: string;
+ };
+ readonly cookie?: {
+ readonly dt_token?: string | null;
+ };
+ };
+ readonly requestBody: {
+ readonly content: {
+ readonly "application/json": components["schemas"]["SettingsPresetDraftRequest"];
+ };
+ };
+ readonly responses: {
+ /** @description Successful Response */
+ readonly 200: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": {
+ readonly [key: string]: unknown;
+ };
+ };
+ };
+ /** @description Validation Error */
+ readonly 422: {
+ headers: {
+ readonly [name: string]: unknown;
+ };
+ content: {
+ readonly "application/json": components["schemas"]["HTTPValidationError"];
+ };
+ };
+ };
+ };
readonly get_settings_profile_api_settings_profile_get: {
readonly parameters: {
readonly query?: never;
diff --git a/web/contracts/schema/openapi.json b/web/contracts/schema/openapi.json
index 11f8f90cc..98b6a045e 100644
--- a/web/contracts/schema/openapi.json
+++ b/web/contracts/schema/openapi.json
@@ -177,6 +177,25 @@
"title": "AddWebSourceRequest",
"type": "object"
},
+ "AdminBatchDeleteRequest": {
+ "description": "Usernames for an admin-initiated batch deletion.",
+ "properties": {
+ "usernames": {
+ "items": {
+ "type": "string"
+ },
+ "maxItems": 500,
+ "minItems": 1,
+ "title": "Usernames",
+ "type": "array"
+ }
+ },
+ "required": [
+ "usernames"
+ ],
+ "title": "AdminBatchDeleteRequest",
+ "type": "object"
+ },
"AdminCreateUserRequest": {
"description": "Admin user-creation payload.\n\nA preset configures an ordinary account; it never becomes a third role.",
"properties": {
@@ -685,6 +704,20 @@
"title": "AutoMarkResponse",
"type": "object"
},
+ "Body_admin_import_users_api_auth_users_import_post": {
+ "properties": {
+ "file": {
+ "contentMediaType": "application/octet-stream",
+ "title": "File",
+ "type": "string"
+ }
+ },
+ "required": [
+ "file"
+ ],
+ "title": "Body_admin_import_users_api_auth_users_import_post",
+ "type": "object"
+ },
"Body_create_knowledge_base_api_knowledge_bases_post": {
"properties": {
"embedding_model": {
@@ -6092,6 +6125,21 @@
"title": "Options",
"type": "object"
},
+ "origin_ref": {
+ "default": "",
+ "title": "Origin Ref",
+ "type": "string"
+ },
+ "origin_type": {
+ "default": "conversation",
+ "enum": [
+ "conversation",
+ "external_import",
+ "document_analysis"
+ ],
+ "title": "Origin Type",
+ "type": "string"
+ },
"practice": {
"anyOf": [
{
@@ -6186,6 +6234,7 @@
"type": "string"
},
"session_id": {
+ "default": "",
"title": "Session Id",
"type": "string"
},
@@ -6232,7 +6281,6 @@
},
"required": [
"id",
- "session_id",
"question",
"created_at",
"updated_at"
@@ -8508,6 +8556,30 @@
"title": "SettingsDraftPayload",
"type": "object"
},
+ "SettingsPresetDraftRequest": {
+ "description": "The current draft envelope submitted alongside a named preset.",
+ "properties": {
+ "catalog": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Catalog"
+ },
+ "extensions": {
+ "additionalProperties": true,
+ "title": "Extensions",
+ "type": "object"
+ }
+ },
+ "title": "SettingsPresetDraftRequest",
+ "type": "object"
+ },
"SettingsProfileImportPayload": {
"description": "An exported value-free settings profile submitted for review only.",
"properties": {
@@ -11083,6 +11155,21 @@
],
"title": "Options"
},
+ "origin_ref": {
+ "default": "",
+ "title": "Origin Ref",
+ "type": "string"
+ },
+ "origin_type": {
+ "default": "conversation",
+ "enum": [
+ "conversation",
+ "external_import",
+ "document_analysis"
+ ],
+ "title": "Origin Type",
+ "type": "string"
+ },
"quality": {
"anyOf": [
{
@@ -11134,6 +11221,7 @@
"type": "string"
},
"session_id": {
+ "default": "",
"title": "Session Id",
"type": "string"
},
@@ -11176,7 +11264,6 @@
}
},
"required": [
- "session_id",
"question_id",
"question"
],
@@ -11526,6 +11613,11 @@
"title": "Added At",
"type": "string"
},
+ "auto_sync_enabled": {
+ "default": true,
+ "title": "Auto Sync Enabled",
+ "type": "boolean"
+ },
"enabled": {
"default": true,
"title": "Enabled",
@@ -11583,6 +11675,13 @@
"title": "Page Count",
"type": "integer"
},
+ "sync_interval_hours": {
+ "default": 24,
+ "maximum": 168.0,
+ "minimum": 1.0,
+ "title": "Sync Interval Hours",
+ "type": "integer"
+ },
"url": {
"title": "Url",
"type": "string"
@@ -11595,6 +11694,91 @@
"title": "WebSourceInfo",
"type": "object"
},
+ "WebSourceScheduleUpdate": {
+ "properties": {
+ "auto_sync_enabled": {
+ "title": "Auto Sync Enabled",
+ "type": "boolean"
+ },
+ "sync_interval_hours": {
+ "default": 24,
+ "maximum": 168.0,
+ "minimum": 1.0,
+ "title": "Sync Interval Hours",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "auto_sync_enabled"
+ ],
+ "title": "WebSourceScheduleUpdate",
+ "type": "object"
+ },
+ "WebSourceSyncJobInfo": {
+ "properties": {
+ "attempt": {
+ "default": 0,
+ "title": "Attempt",
+ "type": "integer"
+ },
+ "cancel_requested": {
+ "default": false,
+ "title": "Cancel Requested",
+ "type": "boolean"
+ },
+ "error": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Error"
+ },
+ "kb_name": {
+ "title": "Kb Name",
+ "type": "string"
+ },
+ "last_run_at": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Last Run At"
+ },
+ "next_run_at": {
+ "title": "Next Run At",
+ "type": "integer"
+ },
+ "owner_id": {
+ "title": "Owner Id",
+ "type": "string"
+ },
+ "source_id": {
+ "title": "Source Id",
+ "type": "string"
+ },
+ "state": {
+ "title": "State",
+ "type": "string"
+ }
+ },
+ "required": [
+ "owner_id",
+ "kb_name",
+ "source_id",
+ "state",
+ "next_run_at"
+ ],
+ "title": "WebSourceSyncJobInfo",
+ "type": "object"
+ },
"WhiteboardPinRequest": {
"properties": {
"event_id": {
@@ -13376,7 +13560,7 @@
]
},
"post": {
- "description": "Admin-only: create a new user account.\n\nReplaces the public ``/register`` flow once the first admin exists. The\nnew account is always created with role=``user``; admins can promote\nlater via ``PUT /users/{username}/role``.",
+ "description": "Admin-only: create one ordinary user account.",
"operationId": "admin_create_user_api_auth_users_post",
"parameters": [
{
@@ -13452,20 +13636,89 @@
]
}
},
- "/api/auth/users/{username}": {
- "delete": {
- "description": "Delete a user. Admins cannot delete their own account.",
- "operationId": "remove_user_api_auth_users__username__delete",
+ "/api/auth/users/batch-delete": {
+ "post": {
+ "description": "Delete selected users and report each outcome separately.",
+ "operationId": "batch_remove_users_api_auth_users_batch_delete_post",
"parameters": [
{
- "in": "path",
- "name": "username",
- "required": true,
+ "in": "header",
+ "name": "Authorization",
+ "required": false,
"schema": {
- "title": "Username",
- "type": "string"
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Authorization"
}
},
+ {
+ "in": "cookie",
+ "name": "dt_token",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Dt Token"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AdminBatchDeleteRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "additionalProperties": true,
+ "title": "Response Batch Remove Users Api Auth Users Batch Delete Post",
+ "type": "object"
+ }
+ }
+ },
+ "description": "Successful Response"
+ },
+ "422": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ },
+ "description": "Validation Error"
+ }
+ },
+ "summary": "Batch Remove Users",
+ "tags": [
+ "auth"
+ ]
+ }
+ },
+ "/api/auth/users/import": {
+ "post": {
+ "description": "Admin-only: provision ordinary users from a CSV file.\n\nThe response is row-oriented so one invalid record does not erase the\ncontext of the valid records around it. Passwords are never returned.",
+ "operationId": "admin_import_users_api_auth_users_import_post",
+ "parameters": [
{
"in": "header",
"name": "Authorization",
@@ -13499,13 +13752,23 @@
}
}
],
+ "requestBody": {
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "$ref": "#/components/schemas/Body_admin_import_users_api_auth_users_import_post"
+ }
+ }
+ },
+ "required": true
+ },
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
- "title": "Response Remove User Api Auth Users Username Delete",
+ "title": "Response Admin Import Users Api Auth Users Import Post",
"type": "object"
}
}
@@ -13523,16 +13786,16 @@
"description": "Validation Error"
}
},
- "summary": "Remove User",
+ "summary": "Admin Import Users",
"tags": [
"auth"
]
}
},
- "/api/auth/users/{username}/learner-profile": {
- "get": {
- "description": "Return the structured profile managed for an ordinary learner.",
- "operationId": "get_learner_profile_api_auth_users__username__learner_profile_get",
+ "/api/auth/users/{username}": {
+ "delete": {
+ "description": "Delete a user. Admins cannot delete their own account.",
+ "operationId": "remove_user_api_auth_users__username__delete",
"parameters": [
{
"in": "path",
@@ -13582,7 +13845,7 @@
"application/json": {
"schema": {
"additionalProperties": true,
- "title": "Response Get Learner Profile Api Auth Users Username Learner Profile Get",
+ "title": "Response Remove User Api Auth Users Username Delete",
"type": "object"
}
}
@@ -13600,13 +13863,16 @@
"description": "Validation Error"
}
},
- "summary": "Get Learner Profile",
+ "summary": "Remove User",
"tags": [
"auth"
]
- },
- "put": {
- "operationId": "put_learner_profile_api_auth_users__username__learner_profile_put",
+ }
+ },
+ "/api/auth/users/{username}/learner-profile": {
+ "get": {
+ "description": "Return the structured profile managed for an ordinary learner.",
+ "operationId": "get_learner_profile_api_auth_users__username__learner_profile_get",
"parameters": [
{
"in": "path",
@@ -13650,23 +13916,13 @@
}
}
],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/LearnerProfileRequest"
- }
- }
- },
- "required": true
- },
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": true,
- "title": "Response Put Learner Profile Api Auth Users Username Learner Profile Put",
+ "title": "Response Get Learner Profile Api Auth Users Username Learner Profile Get",
"type": "object"
}
}
@@ -13684,16 +13940,100 @@
"description": "Validation Error"
}
},
- "summary": "Put Learner Profile",
+ "summary": "Get Learner Profile",
"tags": [
"auth"
]
- }
- },
- "/api/auth/users/{username}/role": {
+ },
"put": {
- "description": "Change a user's role. Admins cannot change their own role.",
- "operationId": "update_user_role_api_auth_users__username__role_put",
+ "operationId": "put_learner_profile_api_auth_users__username__learner_profile_put",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "username",
+ "required": true,
+ "schema": {
+ "title": "Username",
+ "type": "string"
+ }
+ },
+ {
+ "in": "header",
+ "name": "Authorization",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Authorization"
+ }
+ },
+ {
+ "in": "cookie",
+ "name": "dt_token",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Dt Token"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/LearnerProfileRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "additionalProperties": true,
+ "title": "Response Put Learner Profile Api Auth Users Username Learner Profile Put",
+ "type": "object"
+ }
+ }
+ },
+ "description": "Successful Response"
+ },
+ "422": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ },
+ "description": "Validation Error"
+ }
+ },
+ "summary": "Put Learner Profile",
+ "tags": [
+ "auth"
+ ]
+ }
+ },
+ "/api/auth/users/{username}/role": {
+ "put": {
+ "description": "Change a user's role. Admins cannot change their own role.",
+ "operationId": "update_user_role_api_auth_users__username__role_put",
"parameters": [
{
"in": "path",
@@ -24147,9 +24487,9 @@
]
}
},
- "/api/knowledge-bases/{kb_name}/web-source/{source_id}": {
- "delete": {
- "operationId": "remove_web_source_api_knowledge_bases__kb_name__web_source__source_id__delete",
+ "/api/knowledge-bases/{kb_name}/web-source-sync": {
+ "get": {
+ "operationId": "get_web_source_sync_jobs_api_knowledge_bases__kb_name__web_source_sync_get",
"parameters": [
{
"in": "path",
@@ -24160,15 +24500,6 @@
"type": "string"
}
},
- {
- "in": "path",
- "name": "source_id",
- "required": true,
- "schema": {
- "title": "Source Id",
- "type": "string"
- }
- },
{
"in": "header",
"name": "Authorization",
@@ -24206,7 +24537,13 @@
"200": {
"content": {
"application/json": {
- "schema": {}
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/WebSourceSyncJobInfo"
+ },
+ "title": "Response Get Web Source Sync Jobs Api Knowledge Bases Kb Name Web Source Sync Get",
+ "type": "array"
+ }
}
},
"description": "Successful Response"
@@ -24222,15 +24559,15 @@
"description": "Validation Error"
}
},
- "summary": "Remove Web Source",
+ "summary": "Get Web Source Sync Jobs",
"tags": [
"knowledge-bases"
]
}
},
- "/api/knowledge-bases/{kb_name}/web-sources": {
- "get": {
- "operationId": "get_web_sources_api_knowledge_bases__kb_name__web_sources_get",
+ "/api/knowledge-bases/{kb_name}/web-source/{source_id}": {
+ "delete": {
+ "operationId": "remove_web_source_api_knowledge_bases__kb_name__web_source__source_id__delete",
"parameters": [
{
"in": "path",
@@ -24241,6 +24578,15 @@
"type": "string"
}
},
+ {
+ "in": "path",
+ "name": "source_id",
+ "required": true,
+ "schema": {
+ "title": "Source Id",
+ "type": "string"
+ }
+ },
{
"in": "header",
"name": "Authorization",
@@ -24278,13 +24624,7 @@
"200": {
"content": {
"application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/WebSourceInfo"
- },
- "title": "Response Get Web Sources Api Knowledge Bases Kb Name Web Sources Get",
- "type": "array"
- }
+ "schema": {}
}
},
"description": "Successful Response"
@@ -24300,17 +24640,34 @@
"description": "Validation Error"
}
},
- "summary": "Get Web Sources",
+ "summary": "Remove Web Source",
"tags": [
"knowledge-bases"
]
}
},
- "/api/marginnote4/devices": {
- "get": {
- "description": "List all paired devices.",
- "operationId": "list_devices_api_marginnote4_devices_get",
+ "/api/knowledge-bases/{kb_name}/web-source/{source_id}/cancel": {
+ "post": {
+ "operationId": "cancel_web_source_sync_api_knowledge_bases__kb_name__web_source__source_id__cancel_post",
"parameters": [
+ {
+ "in": "path",
+ "name": "kb_name",
+ "required": true,
+ "schema": {
+ "title": "Kb Name",
+ "type": "string"
+ }
+ },
+ {
+ "in": "path",
+ "name": "source_id",
+ "required": true,
+ "schema": {
+ "title": "Source Id",
+ "type": "string"
+ }
+ },
{
"in": "header",
"name": "Authorization",
@@ -24348,13 +24705,7 @@
"200": {
"content": {
"application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/DeviceInfo"
- },
- "title": "Response List Devices Api Marginnote4 Devices Get",
- "type": "array"
- }
+ "schema": {}
}
},
"description": "Successful Response"
@@ -24370,23 +24721,31 @@
"description": "Validation Error"
}
},
- "summary": "List Devices",
+ "summary": "Cancel Web Source Sync",
"tags": [
- "marginnote4"
+ "knowledge-bases"
]
}
},
- "/api/marginnote4/devices/{device_id}": {
- "delete": {
- "description": "Revoke a paired device.",
- "operationId": "revoke_device_api_marginnote4_devices__device_id__delete",
+ "/api/knowledge-bases/{kb_name}/web-source/{source_id}/retry": {
+ "post": {
+ "operationId": "retry_web_source_sync_api_knowledge_bases__kb_name__web_source__source_id__retry_post",
"parameters": [
{
"in": "path",
- "name": "device_id",
+ "name": "kb_name",
"required": true,
"schema": {
- "title": "Device Id",
+ "title": "Kb Name",
+ "type": "string"
+ }
+ },
+ {
+ "in": "path",
+ "name": "source_id",
+ "required": true,
+ "schema": {
+ "title": "Source Id",
"type": "string"
}
},
@@ -24427,13 +24786,7 @@
"200": {
"content": {
"application/json": {
- "schema": {
- "additionalProperties": {
- "type": "string"
- },
- "title": "Response Revoke Device Api Marginnote4 Devices Device Id Delete",
- "type": "object"
- }
+ "schema": {}
}
},
"description": "Successful Response"
@@ -24449,69 +24802,389 @@
"description": "Validation Error"
}
},
- "summary": "Revoke Device",
+ "summary": "Retry Web Source Sync",
"tags": [
- "marginnote4"
+ "knowledge-bases"
]
}
},
- "/api/marginnote4/heartbeat": {
- "post": {
- "description": "Lightweight liveness check. Updates last_seen for the device.",
- "operationId": "heartbeat_api_marginnote4_heartbeat_post",
+ "/api/knowledge-bases/{kb_name}/web-source/{source_id}/schedule": {
+ "put": {
+ "operationId": "update_web_source_schedule_api_knowledge_bases__kb_name__web_source__source_id__schedule_put",
"parameters": [
{
- "in": "header",
- "name": "authorization",
- "required": false,
+ "in": "path",
+ "name": "kb_name",
+ "required": true,
"schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Authorization"
+ "title": "Kb Name",
+ "type": "string"
+ }
+ },
+ {
+ "in": "path",
+ "name": "source_id",
+ "required": true,
+ "schema": {
+ "title": "Source Id",
+ "type": "string"
}
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "additionalProperties": true,
- "title": "Response Heartbeat Api Marginnote4 Heartbeat Post",
- "type": "object"
- }
- }
- },
- "description": "Successful Response"
},
- "422": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- },
- "description": "Validation Error"
- }
- },
- "summary": "Heartbeat",
- "tags": [
- "marginnote4"
- ]
- }
- },
- "/api/marginnote4/pair": {
- "post": {
- "description": "Pair a new MN4 device. Requires a DeepTutor session.\n\nReturns a one-time token the Add-on stores and presents on every sync.",
- "operationId": "pair_device_api_marginnote4_pair_post",
- "parameters": [
+ {
+ "in": "header",
+ "name": "Authorization",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Authorization"
+ }
+ },
+ {
+ "in": "cookie",
+ "name": "dt_token",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Dt Token"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/WebSourceScheduleUpdate"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/WebSourceInfo"
+ }
+ }
+ },
+ "description": "Successful Response"
+ },
+ "422": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ },
+ "description": "Validation Error"
+ }
+ },
+ "summary": "Update Web Source Schedule",
+ "tags": [
+ "knowledge-bases"
+ ]
+ }
+ },
+ "/api/knowledge-bases/{kb_name}/web-sources": {
+ "get": {
+ "operationId": "get_web_sources_api_knowledge_bases__kb_name__web_sources_get",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "kb_name",
+ "required": true,
+ "schema": {
+ "title": "Kb Name",
+ "type": "string"
+ }
+ },
+ {
+ "in": "header",
+ "name": "Authorization",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Authorization"
+ }
+ },
+ {
+ "in": "cookie",
+ "name": "dt_token",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Dt Token"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/WebSourceInfo"
+ },
+ "title": "Response Get Web Sources Api Knowledge Bases Kb Name Web Sources Get",
+ "type": "array"
+ }
+ }
+ },
+ "description": "Successful Response"
+ },
+ "422": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ },
+ "description": "Validation Error"
+ }
+ },
+ "summary": "Get Web Sources",
+ "tags": [
+ "knowledge-bases"
+ ]
+ }
+ },
+ "/api/marginnote4/devices": {
+ "get": {
+ "description": "List all paired devices.",
+ "operationId": "list_devices_api_marginnote4_devices_get",
+ "parameters": [
+ {
+ "in": "header",
+ "name": "Authorization",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Authorization"
+ }
+ },
+ {
+ "in": "cookie",
+ "name": "dt_token",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Dt Token"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/DeviceInfo"
+ },
+ "title": "Response List Devices Api Marginnote4 Devices Get",
+ "type": "array"
+ }
+ }
+ },
+ "description": "Successful Response"
+ },
+ "422": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ },
+ "description": "Validation Error"
+ }
+ },
+ "summary": "List Devices",
+ "tags": [
+ "marginnote4"
+ ]
+ }
+ },
+ "/api/marginnote4/devices/{device_id}": {
+ "delete": {
+ "description": "Revoke a paired device.",
+ "operationId": "revoke_device_api_marginnote4_devices__device_id__delete",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "device_id",
+ "required": true,
+ "schema": {
+ "title": "Device Id",
+ "type": "string"
+ }
+ },
+ {
+ "in": "header",
+ "name": "Authorization",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Authorization"
+ }
+ },
+ {
+ "in": "cookie",
+ "name": "dt_token",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Dt Token"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "title": "Response Revoke Device Api Marginnote4 Devices Device Id Delete",
+ "type": "object"
+ }
+ }
+ },
+ "description": "Successful Response"
+ },
+ "422": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ },
+ "description": "Validation Error"
+ }
+ },
+ "summary": "Revoke Device",
+ "tags": [
+ "marginnote4"
+ ]
+ }
+ },
+ "/api/marginnote4/heartbeat": {
+ "post": {
+ "description": "Lightweight liveness check. Updates last_seen for the device.",
+ "operationId": "heartbeat_api_marginnote4_heartbeat_post",
+ "parameters": [
+ {
+ "in": "header",
+ "name": "authorization",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Authorization"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "additionalProperties": true,
+ "title": "Response Heartbeat Api Marginnote4 Heartbeat Post",
+ "type": "object"
+ }
+ }
+ },
+ "description": "Successful Response"
+ },
+ "422": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ },
+ "description": "Validation Error"
+ }
+ },
+ "summary": "Heartbeat",
+ "tags": [
+ "marginnote4"
+ ]
+ }
+ },
+ "/api/marginnote4/pair": {
+ "post": {
+ "description": "Pair a new MN4 device. Requires a DeepTutor session.\n\nReturns a one-time token the Add-on stores and presents on every sync.",
+ "operationId": "pair_device_api_marginnote4_pair_post",
+ "parameters": [
{
"in": "header",
"name": "Authorization",
@@ -37505,12 +38178,38 @@
{
"in": "query",
"name": "session_id",
- "required": true,
+ "required": false,
"schema": {
+ "default": "",
"title": "Session Id",
"type": "string"
}
},
+ {
+ "in": "query",
+ "name": "origin_type",
+ "required": false,
+ "schema": {
+ "default": "conversation",
+ "enum": [
+ "conversation",
+ "external_import",
+ "document_analysis"
+ ],
+ "title": "Origin Type",
+ "type": "string"
+ }
+ },
+ {
+ "in": "query",
+ "name": "origin_ref",
+ "required": false,
+ "schema": {
+ "default": "",
+ "title": "Origin Ref",
+ "type": "string"
+ }
+ },
{
"in": "query",
"name": "question_id",
@@ -47363,6 +48062,157 @@
]
}
},
+ "/api/settings/presets": {
+ "get": {
+ "description": "List value-free starting points for a reviewable draft.",
+ "operationId": "get_settings_presets_api_settings_presets_get",
+ "parameters": [
+ {
+ "in": "header",
+ "name": "Authorization",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Authorization"
+ }
+ },
+ {
+ "in": "cookie",
+ "name": "dt_token",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Dt Token"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {}
+ }
+ },
+ "description": "Successful Response"
+ },
+ "422": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ },
+ "description": "Validation Error"
+ }
+ },
+ "summary": "Get Settings Presets",
+ "tags": [
+ "settings"
+ ]
+ }
+ },
+ "/api/settings/presets/{preset_id}/draft": {
+ "post": {
+ "description": "Load a named preset into the existing draft for review.",
+ "operationId": "stage_settings_preset_api_settings_presets__preset_id__draft_post",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "preset_id",
+ "required": true,
+ "schema": {
+ "title": "Preset Id",
+ "type": "string"
+ }
+ },
+ {
+ "in": "header",
+ "name": "Authorization",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Authorization"
+ }
+ },
+ {
+ "in": "cookie",
+ "name": "dt_token",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Dt Token"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SettingsPresetDraftRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "additionalProperties": true,
+ "title": "Response Stage Settings Preset Api Settings Presets Preset Id Draft Post",
+ "type": "object"
+ }
+ }
+ },
+ "description": "Successful Response"
+ },
+ "422": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/HTTPValidationError"
+ }
+ }
+ },
+ "description": "Validation Error"
+ }
+ },
+ "summary": "Stage Settings Preset",
+ "tags": [
+ "settings"
+ ]
+ }
+ },
"/api/settings/profile": {
"get": {
"description": "Export effective settings with credentials and deployment values removed.",