refactored models

- added new plugin settings endpoints
cheshire-cat-ai · Jul 21, 2023 · ab329b4 · ab329b4
1 parent 3edc532
commit ab329b4
Show file tree

Hide file tree

Showing 12 changed files with 280 additions and 67 deletions.
diff --git a/.changeset/stupid-onions-camp.md b/.changeset/stupid-onions-camp.md
@@ -0,0 +1,7 @@
+---
+"ccat-api": minor
+---
+
+Refactored models
+
+- Added new plugin settings endpoints
diff --git a/api/models/ConfigurationsResponse.ts b/api/models/ConfigurationsResponse.ts
@@ -3,14 +3,16 @@
 /* tslint:disable */
 /* eslint-disable */
 
-import type { Schema } from './Schema';
+import type { JsonSchema } from './JsonSchema';
 import type { Setting } from './Setting';
 
 export type ConfigurationsResponse = {
  status: string;
  results: number;
  settings: Array<Setting>;
- schemas: Record<string, Schema>;
+ schemas: Record<string, (JsonSchema & {
+name_human_readable?: string;
+})>;
  allowed_configurations: Array<string>;
  selected_configuration: string;
 };
diff --git a/api/models/FileResponse.ts b/api/models/FileResponse.ts
@@ -4,6 +4,7 @@
 /* eslint-disable */
 
 export type FileResponse = {
+ status: string;
  filename: string;
  content_type: string;
  info: string;

diff --git a/api/models/Schema.ts → api/models/JsonSchema.ts b/api/models/Schema.ts → api/models/JsonSchema.ts
@@ -3,11 +3,11 @@
 /* tslint:disable */
 /* eslint-disable */
 
-export type Schema = {
+export type JsonSchema = {
  title: string;
+ type: string;
  description: string;
  properties: Record<string, any>;
  required?: Array<string>;
  additionalProperties: boolean;
- name_human_readable: string;
 };
diff --git a/api/models/PluginResponse.ts b/api/models/PluginResponse.ts
diff --git a/api/models/PluginSettings.ts b/api/models/PluginSettings.ts
@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+export type PluginSettings = {
+ status: string;
+ settings: Record<string, any>;
+};
diff --git a/api/models/Setting.ts b/api/models/Setting.ts
@@ -3,10 +3,9 @@
 /* tslint:disable */
 /* eslint-disable */
 
-export type Setting = {
- setting_id?: string;
- name: string;
- value: Record<string, any>;
- category?: string;
- updated_at?: number;
-};
+import type { SettingBody } from './SettingBody';
+
+export type Setting = (SettingBody & {
+setting_id: string;
+updated_at: number;
+});
diff --git a/api/models/SettingBody.ts b/api/models/SettingBody.ts
@@ -0,0 +1,10 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+export type SettingBody = {
+ name: string;
+ value: Record<string, any>;
+ category?: string;
+};
diff --git a/api/services/PluginsService.ts b/api/services/PluginsService.ts
@@ -4,8 +4,10 @@
 /* eslint-disable */
 import type { BodyUploadPlugin } from '../models/BodyUploadPlugin';
 import type { DeleteResponse } from '../models/DeleteResponse';
+import type { FileResponse } from '../models/FileResponse';
+import type { JsonSchema } from '../models/JsonSchema';
 import type { Plugin } from '../models/Plugin';
-import type { PluginResponse } from '../models/PluginResponse';
+import type { PluginSettings } from '../models/PluginSettings';
 import type { PluginsList } from '../models/PluginsList';
 
 import type { CancelablePromise } from '../core/CancelablePromise';
@@ -32,12 +34,12 @@ export class PluginsService {
  * Upload Plugin
  * Install a new plugin from a zip file
  * @param formData 
- * @returns PluginResponse Successful Response
+ * @returns FileResponse Successful Response
  * @throws ApiError
  */
  public uploadPlugin(
 formData: BodyUploadPlugin,
-): CancelablePromise<PluginResponse> {
+): CancelablePromise<FileResponse> {
  return this.httpRequest.request({
  method: 'POST',
  url: '/plugins/upload/',
@@ -118,4 +120,54 @@ pluginId: string,
  });
  }
 
+ /**
+ * Get Plugin Settings
+ * Returns the settings of a specific plugin
+ * @param pluginId 
+ * @returns any Successful Response
+ * @throws ApiError
+ */
+ public getPluginSettings(
+pluginId: string,
+): CancelablePromise<(PluginSettings & {
+schema: JsonSchema;
+})> {
+ return this.httpRequest.request({
+ method: 'GET',
+ url: '/plugins/settings/{plugin_id}',
+ path: {
+ 'plugin_id': pluginId,
+ },
+ errors: {
+ 422: `Validation Error`,
+ },
+ });
+ }
+
+ /**
+ * Upsert Plugin Settings
+ * Updates the settings of a specific plugin
+ * @param pluginId 
+ * @param requestBody 
+ * @returns PluginSettings Successful Response
+ * @throws ApiError
+ */
+ public upsertPluginSettings(
+pluginId: string,
+requestBody: Record<string, any>,
+): CancelablePromise<PluginSettings> {
+ return this.httpRequest.request({
+ method: 'PUT',
+ url: '/plugins/settings/{plugin_id}',
+ path: {
+ 'plugin_id': pluginId,
+ },
+ body: requestBody,
+ mediaType: 'application/json',
+ errors: {
+ 422: `Validation Error`,
+ },
+ });
+ }
+
 }
diff --git a/api/services/SettingsGeneralService.ts b/api/services/SettingsGeneralService.ts
@@ -2,7 +2,7 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-import type { Setting } from '../models/Setting';
+import type { SettingBody } from '../models/SettingBody';
 import type { SettingResponse } from '../models/SettingResponse';
 import type { SettingsList } from '../models/SettingsList';
 
@@ -43,7 +43,7 @@ search: string = '',
  * @throws ApiError
  */
  public createSetting(
-requestBody: Setting,
+requestBody: SettingBody,
 ): CancelablePromise<SettingResponse> {
  return this.httpRequest.request({
  method: 'POST',
@@ -110,7 +110,7 @@ settingId: string,
  */
  public updateSetting(
 settingId: string,
-requestBody: Setting,
+requestBody: SettingBody,
 ): CancelablePromise<SettingResponse> {
  return this.httpRequest.request({
  method: 'PUT',