@profcomff/api-uilib 2024.7.28 → 2024.10.22

package/README.md

@@ -2,13 +2,23 @@
 
 Представляет интерфейс для совершения запросов к API по адресу <https://api.profcomff.com>.
 
+Поддерживает типы данных TypeScript и подсветку синтаксиса.
 
 [<img src="https://cdn.profcomff.com/easycode/easycode.svg" width="200"></img>](https://easycode.profcomff.com/templates/docker-node/workspace?mode=manual&param.Repository+URL=https://github.com/profcomff/api-uilib.git&param.Working+directory=api-uilib)
 
+
 ## Использование
 
+Установите библиотеку
+
+```shell
+pnpm install @profcomff/api-uilib
+```
+
+Используйте для совершения запросов к <https://api.test.profcomff.com> и <https://api.profcomff.com>.
+
 ```ts
-import { createClient } from '@profcomff/api-uilib';
+import { createClient } from "@profcomff/api-uilib";
 
 // Setup client with base API path
 // You can use environment `import.meta.env.VITE_API_URL` for example
@@ -20,10 +30,68 @@ setupAuth("myApiTokenHere");
 
 // Make request
 const me_with_scopes = await apiClient.GET("/auth/me", {
-    params: {
-        query: {
-            info: ["session_scopes"]
-        }
-    }
+  params: {
+    query: {
+      info: ["session_scopes"],
+    },
+  },
 });
 ```
+
+
+## Тестирование
+
+_На основе <https://openapi-ts.dev/openapi-fetch/testing>._
+
+```ts
+import { createTestClient } from "@profcomff/api-uilib";
+import { http, HttpResponse } from 'msw';
+import { afterEach, beforeAll, afterAll, expect, test } from 'vitest';
+import { setupServer } from 'msw/node';
+
+export const server = setupServer();
+
+beforeAll(() => {
+	server.listen({
+		onUnhandledRequest: request => {
+			throw new Error(`No request handler found for ${request.method} ${request.url}`);
+		},
+	});
+});
+
+afterEach(() => server.resetHandlers());
+afterAll(() => server.close());
+
+test('Get basic info from Auth API with hardload', async () => {
+	const baseUrl = import.meta.env.VITE_API_URL;
+
+	const rawData = {
+		id: 1,
+		email: 'hello@world.com',
+	};
+
+	server.use(http.get(`${baseUrl}/auth/user/1`, () => HttpResponse.json(rawData, { status: 200 })));
+	const testClient = createTestClient({ baseUrl });  // Клиент API должен быть инициализирован ПОСЛЕ msw сервера
+
+	const { data, error } = await testClient
+        .GET(
+            '/auth/user/{user_id}',
+            { params: { path: { user_id: this.id } },
+        });
+    expect(data).toEqual(rawData);
+    expect(error).toBeUndefined();
+});
+```
+
+
+## Разработка
+
+### Автоматическая генерация
+
+Используйте команду `pnpm generate` или [CI-пайплайн Autogen API bindings](https://github.com/profcomff/api-uilib/actions/workflows/autogen.yaml) для кодогенерации последней версии биндингов с **продового** API <https://api.profcomff.com>.
+
+CI исполняется вручную по нажатии кнопки run workflow. После завершения исполнения новая версия будет доступна для ревью в виде Pull Request с названием "Automated API update".
+
+### Релизный процесс
+
+Библиотека релизится по созданию тега вида `v*`, где вместо звездочки идет описание версии [по правилам semver](https://semver.org/lang/ru/). Менять версию в `package.json` не нужно.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@profcomff/api-uilib",
-  "version": "2024.07.28",
+  "version": "2024.10.22",
   "description": "API wrappers, autogenerated from openapi.json files",
   "main": "./src/index.ts",
   "types": "./src/index.d.ts",

package/scripts/generate.js

@@ -13,6 +13,7 @@ const apis = {
   social: "https://api.profcomff.com/social/openapi.json",
   userdata: "https://api.profcomff.com/userdata/openapi.json",
   achievement: "https://api.profcomff.com/achievement/openapi.json",
+  rating: "https://api.profcomff.com/rating/openapi.json",
 };
 
 const header = `/**

package/src/index.ts

@@ -9,6 +9,7 @@ import type { paths as servicesPaths } from "./openapi/services.ts";
 import type { paths as socialPaths } from "./openapi/social.ts";
 import type { paths as timetablePaths } from "./openapi/timetable.ts";
 import type { paths as userdataPaths } from "./openapi/userdata.ts";
+import type { paths as ratingPaths } from "./openapi/rating.js";
 
 
 export type paths = (
@@ -19,7 +20,8 @@ export type paths = (
     servicesPaths &
     socialPaths &
     timetablePaths &
-    userdataPaths
+    userdataPaths &
+    ratingPaths
 );
 
 let currentClient: ReturnType<typeof Client<paths>> | undefined = undefined;
@@ -27,7 +29,9 @@ let currentToken: string | undefined = undefined;
 
 const authMiddleware: Middleware = {
     async onRequest({ request, options }) {
-        request.headers.set("Authorization", currentToken);
+        if (currentToken) {
+            request.headers.set("Authorization", currentToken);
+        }
         return request;
     },
 };
@@ -38,7 +42,7 @@ export const createClient = (baseUrl: string): ReturnType<typeof Client<paths>>
     }
 
     currentClient = Client<paths>({ baseUrl })
-    if (currentToken !== null) {
+    if (currentToken) {
         currentClient.use(authMiddleware);
     }
     return currentClient;
@@ -48,10 +52,10 @@ export const createTestClient = (baseUrl: string): ReturnType<typeof Client<path
     return Client<paths>({ baseUrl });
 }
 
-export const setupAuth = (newToken: string | null) => {
+export const setupAuth = (newToken: string | undefined) => {
     currentToken = newToken;
     if (currentClient !== undefined) {
-        if (newToken === null) {
+        if (!newToken) {
             currentClient.eject(authMiddleware)
         } else {
             currentClient.use(authMiddleware);

package/src/openapi/rating.ts

@@ -0,0 +1,652 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export interface paths {
+    "/rating/comment": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get Comments
+         * @description Scopes: `["rating.comment.review"]`
+         *
+         *     `limit` - максимальное количество возвращаемых комментариев
+         *
+         *     `offset` -  смещение, определяющее, с какого по порядку комментария начинать выборку.
+         *     Если без смещения возвращается комментарий с условным номером N,
+         *     то при значении offset = X будет возвращаться комментарий с номером N + X
+         *
+         *     `order_by` - возможное значение `'create_ts'` - возвращается список комментариев отсортированных по времени создания
+         *
+         *     `lecturer_id` - вернет все комментарии для преподавателя с конкретным id, по дефолту возвращает вообще все аппрувнутые комментарии.
+         *
+         *     `unreviewed` - вернет все непроверенные комментарии, если True. По дефолту False.
+         */
+        get: operations["get_comments_comment_get"];
+        put?: never;
+        /**
+         * Create Comment
+         * @description Создает комментарий к преподавателю в базе данных RatingAPI
+         *     Для создания комментария нужно быть авторизованным
+         */
+        post: operations["create_comment_comment_post"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/rating/comment/{uuid}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get Comment
+         * @description Возвращает комментарий по его UUID в базе данных RatingAPI
+         */
+        get: operations["get_comment_comment__uuid__get"];
+        put?: never;
+        post?: never;
+        /**
+         * Delete Comment
+         * @description Scopes: `["rating.comment.delete"]`
+         *
+         *     Удаляет комментарий по его UUID в базе данных RatingAPI
+         */
+        delete: operations["delete_comment_comment__uuid__delete"];
+        options?: never;
+        head?: never;
+        /**
+         * Review Comment
+         * @description Scopes: `["rating.comment.review"]`
+         *     Проверка комментария и присваивания ему статуса по его UUID в базе данных RatingAPI
+         *
+         *     `review_status` - возможные значения
+         *     `approved` - комментарий одобрен и возвращается при запросе лектора
+         *     `dismissed` - комментарий отклонен, не отображается в запросе лектора
+         */
+        patch: operations["review_comment_comment__uuid__patch"];
+        trace?: never;
+    };
+    "/rating/lecturer": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get Lecturers
+         * @description Scopes: `["rating.lecturer.read"]`
+         *
+         *     `limit` - максимальное количество возвращаемых преподавателей
+         *
+         *     `offset` - нижняя граница получения преподавателей, т.е. если по дефолту первым возвращается преподаватель с условным номером N, то при наличии ненулевого offset будет возвращаться преподаватель с номером N + offset
+         *
+         *     `order_by` - возможные значения `'general'`.
+         *     Если передано `'general'` - возвращается список преподавателей отсортированных по общей оценке
+         *
+         *     `info` - возможные значения `'comments'`, `'mark'`.
+         *     Если передано `'comments'`, то возвращаются одобренные комментарии к преподавателю.
+         *     Если передано `'mark'`, то возвращаются общие средние оценки, а также суммарная средняя оценка по всем одобренным комментариям.
+         *
+         *     `subject`
+         *     Если передано `subject` - возвращает всех преподавателей, для которых переданное значение совпадает с их предметом преподавания.
+         *     Также возвращает всех преподавателей, у которых есть комментарий с совпадающим с данным subject.
+         */
+        get: operations["get_lecturers_lecturer_get"];
+        put?: never;
+        /**
+         * Create Lecturer
+         * @description Scopes: `["rating.lecturer.create"]`
+         *
+         *     Создает преподавателя в базе данных RatingAPI
+         */
+        post: operations["create_lecturer_lecturer_post"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/rating/lecturer/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get Lecturer
+         * @description Scopes: `["rating.lecturer.read"]`
+         *
+         *     Возвращает преподавателя по его ID в базе данных RatingAPI
+         *
+         *     *QUERY* `info: string` - возможные значения `'comments'`, `'mark'`.
+         *     Если передано `'comments'`, то возвращаются одобренные комментарии к преподавателю.
+         *     Если передано `'mark'`, то возвращаются общие средние оценки, а также суммарная средняя оценка по всем одобренным комментариям.
+         *
+         *     Subject лектора возвращшается либо из базы данных, либо из любого аппрувнутого комментария
+         */
+        get: operations["get_lecturer_lecturer__id__get"];
+        put?: never;
+        post?: never;
+        /**
+         * Delete Lecturer
+         * @description Scopes: `["rating.lecturer.delete"]`
+         */
+        delete: operations["delete_lecturer_lecturer__id__delete"];
+        options?: never;
+        head?: never;
+        /**
+         * Update Lecturer
+         * @description Scopes: `["rating.lecturer.update"]`
+         */
+        patch: operations["update_lecturer_lecturer__id__patch"];
+        trace?: never;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        /** CommentGet */
+        CommentGet: {
+            /**
+             * Create Ts
+             * Format: date-time
+             */
+            create_ts: string;
+            /** Lecturer Id */
+            lecturer_id: number;
+            /** Mark Clarity */
+            mark_clarity: number;
+            /** Mark Freebie */
+            mark_freebie: number;
+            /** Mark Kindness */
+            mark_kindness: number;
+            /** Subject */
+            subject: string;
+            /** Text */
+            text: string;
+            /**
+             * Update Ts
+             * Format: date-time
+             */
+            update_ts: string;
+            /**
+             * Uuid
+             * Format: uuid
+             */
+            uuid: string;
+        };
+        /** CommentGetAll */
+        CommentGetAll: {
+            /**
+             * Comments
+             * @default []
+             */
+            comments: components["schemas"]["CommentGet"][];
+            /** Limit */
+            limit: number;
+            /** Offset */
+            offset: number;
+            /** Total */
+            total: number;
+        };
+        /** CommentPost */
+        CommentPost: {
+            /** Mark Clarity */
+            mark_clarity: number;
+            /** Mark Freebie */
+            mark_freebie: number;
+            /** Mark Kindness */
+            mark_kindness: number;
+            /** Subject */
+            subject: string;
+            /** Text */
+            text: string;
+        };
+        /** HTTPValidationError */
+        HTTPValidationError: {
+            /** Detail */
+            detail?: components["schemas"]["ValidationError"][];
+        };
+        /** LecturerGet */
+        LecturerGet: {
+            /** Avatar Link */
+            avatar_link?: string | null;
+            /** Comments */
+            comments?: components["schemas"]["CommentGet"][] | null;
+            /** First Name */
+            first_name: string;
+            /** Id */
+            id: number;
+            /** Last Name */
+            last_name: string;
+            /** Mark Clarity */
+            mark_clarity?: number | null;
+            /** Mark Freebie */
+            mark_freebie?: number | null;
+            /** Mark General */
+            mark_general?: number | null;
+            /** Mark Kindness */
+            mark_kindness?: number | null;
+            /** Middle Name */
+            middle_name: string;
+            /** Subject */
+            subject?: string | null;
+            /** Timetable Id */
+            timetable_id: number;
+        };
+        /** LecturerGetAll */
+        LecturerGetAll: {
+            /**
+             * Lecturers
+             * @default []
+             */
+            lecturers: components["schemas"]["LecturerGet"][];
+            /** Limit */
+            limit: number;
+            /** Offset */
+            offset: number;
+            /** Total */
+            total: number;
+        };
+        /** LecturerPatch */
+        LecturerPatch: {
+            /** Avatar Link */
+            avatar_link?: string | null;
+            /** First Name */
+            first_name?: string | null;
+            /** Last Name */
+            last_name?: string | null;
+            /** Middle Name */
+            middle_name?: string | null;
+            /** Subject */
+            subject?: string | null;
+            /** Timetable Id */
+            timetable_id?: number | null;
+        };
+        /** LecturerPost */
+        LecturerPost: {
+            /** Avatar Link */
+            avatar_link?: string | null;
+            /** First Name */
+            first_name: string;
+            /** Last Name */
+            last_name: string;
+            /** Middle Name */
+            middle_name: string;
+            /** Subject */
+            subject?: string | null;
+            /** Timetable Id */
+            timetable_id: number;
+        };
+        /** StatusResponseModel */
+        StatusResponseModel: {
+            /** Message */
+            message: string;
+            /** Ru */
+            ru: string;
+            /** Status */
+            status: string;
+        };
+        /** ValidationError */
+        ValidationError: {
+            /** Location */
+            loc: (string | number)[];
+            /** Message */
+            msg: string;
+            /** Error Type */
+            type: string;
+        };
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export interface operations {
+    get_comments_comment_get: {
+        parameters: {
+            query?: {
+                lecturer_id?: number | null;
+                limit?: number;
+                offset?: number;
+                order_by?: "create_ts"[];
+                unreviewed?: boolean;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CommentGetAll"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    create_comment_comment_post: {
+        parameters: {
+            query: {
+                lecturer_id: number;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CommentPost"];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CommentGet"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    get_comment_comment__uuid__get: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                uuid: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CommentGet"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    delete_comment_comment__uuid__delete: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                uuid: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["StatusResponseModel"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    review_comment_comment__uuid__patch: {
+        parameters: {
+            query?: {
+                review_status?: "approved" | "dismissed";
+            };
+            header?: never;
+            path: {
+                uuid: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CommentGet"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    get_lecturers_lecturer_get: {
+        parameters: {
+            query?: {
+                info?: ("comments" | "mark")[];
+                limit?: number;
+                offset?: number;
+                order_by?: ("general" | "")[];
+                subject?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LecturerGetAll"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    create_lecturer_lecturer_post: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["LecturerPost"];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LecturerGet"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    get_lecturer_lecturer__id__get: {
+        parameters: {
+            query?: {
+                info?: ("comments" | "mark")[];
+            };
+            header?: never;
+            path: {
+                id: number;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LecturerGet"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    delete_lecturer_lecturer__id__delete: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: number;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["StatusResponseModel"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    update_lecturer_lecturer__id__patch: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: number;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["LecturerPatch"];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["LecturerGet"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+}

package/src/openapi/services.ts

@@ -163,6 +163,12 @@ export interface components {
              * @description Иконка кнопки
              */
             icon: string;
+            /**
+             * Is Hidden
+             * @description Спрятана ли кнопка от пользователя
+             * @default false
+             */
+            is_hidden: boolean;
             /**
              * Link
              * @description Ссылка, на которую перенаправляет кнопка
@@ -175,12 +181,12 @@ export interface components {
             name: string;
             /**
              * Optional Scopes
-             * @description Каким скоупы желательны
+             * @description Какиеп скоупы желательны
              */
             optional_scopes?: string[] | null;
             /**
              * Required Scopes
-             * @description Каким скоупы нужны, чтобы кнопка была доступна
+             * @description Какие скоупы нужны, чтобы кнопка была доступна
              */
             required_scopes?: string[] | null;
             /** @description Тип открываемой ссылки (Ссылка приложения/Браузер в приложении/Браузер */
@@ -244,6 +250,11 @@ export interface components {
              * @description Иконка кнопки
              */
             icon?: string | null;
+            /**
+             * Is Hidden
+             * @description Спрятана ли кнопка от пользователя
+             */
+            is_hidden?: boolean | null;
             /**
              * Link
              * @description Ссылка, на которую перенаправляет кнопка
@@ -256,7 +267,7 @@ export interface components {
             name?: string | null;
             /**
              * Optional Scopes
-             * @description Каким скоупы желательны
+             * @description Какие скоупы желательны
              */
             optional_scopes?: string[] | null;
             /**
@@ -266,7 +277,7 @@ export interface components {
             order?: number | null;
             /**
              * Required Scopes
-             * @description Каким скоупы нужны, чтобы кнопка была доступна
+             * @description Какие скоупы нужны, чтобы кнопка была доступна
              */
             required_scopes?: string[] | null;
             /** @description Тип открываемой ссылки (Ссылка приложения/Браузер в приложении/Браузер */
@@ -276,7 +287,7 @@ export interface components {
          * ButtonView
          * @enum {string}
          */
-        ButtonView: "active" | "blocked";
+        ButtonView: "active" | "blocked" | "hidden";
         /** CategoryCreate */
         CategoryCreate: {
             /**

package/src/openapi/timetable.ts

@@ -211,11 +211,9 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Get All Lecturer Comments */
-        get: operations["get_all_lecturer_comments_lecturer__lecturer_id__comment__get"];
+        get?: never;
         put?: never;
-        /** Comment Lecturer */
-        post: operations["comment_lecturer_lecturer__lecturer_id__comment__post"];
+        post?: never;
         delete?: never;
         options?: never;
         head?: never;
@@ -229,16 +227,13 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Get Comment */
-        get: operations["get_comment_lecturer__lecturer_id__comment__id__get"];
+        get?: never;
         put?: never;
         post?: never;
-        /** Delete Comment */
-        delete: operations["delete_comment_lecturer__lecturer_id__comment__id__delete"];
+        delete?: never;
         options?: never;
         head?: never;
-        /** Update Comment Lecturer */
-        patch: operations["update_comment_lecturer_lecturer__lecturer_id__comment__id__patch"];
+        patch?: never;
         trace?: never;
     };
     "/timetable/lecturer/{lecturer_id}/comment/{id}/review/": {
@@ -250,8 +245,7 @@ export interface paths {
         };
         get?: never;
         put?: never;
-        /** Review Comment */
-        post: operations["review_comment_lecturer__lecturer_id__comment__id__review__post"];
+        post?: never;
         delete?: never;
         options?: never;
         head?: never;
@@ -265,8 +259,7 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Get Unreviewed Comments */
-        get: operations["get_unreviewed_comments_lecturer__lecturer_id__comment_review__get"];
+        get?: never;
         put?: never;
         post?: never;
         delete?: never;
@@ -1587,240 +1580,6 @@ export interface operations {
             };
         };
     };
-    get_all_lecturer_comments_lecturer__lecturer_id__comment__get: {
-        parameters: {
-            query?: {
-                limit?: number;
-                offset?: number;
-            };
-            header?: never;
-            path: {
-                lecturer_id: number;
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Successful Response */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["LecturerComments"];
-                };
-            };
-            /** @description Validation Error */
-            422: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["HTTPValidationError"];
-                };
-            };
-        };
-    };
-    comment_lecturer_lecturer__lecturer_id__comment__post: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                lecturer_id: number;
-            };
-            cookie?: never;
-        };
-        requestBody: {
-            content: {
-                "application/json": components["schemas"]["LecturerCommentPost"];
-            };
-        };
-        responses: {
-            /** @description Successful Response */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["CommentLecturer"];
-                };
-            };
-            /** @description Validation Error */
-            422: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["HTTPValidationError"];
-                };
-            };
-        };
-    };
-    get_comment_lecturer__lecturer_id__comment__id__get: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                id: number;
-                lecturer_id: number;
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Successful Response */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["CommentLecturer"];
-                };
-            };
-            /** @description Validation Error */
-            422: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["HTTPValidationError"];
-                };
-            };
-        };
-    };
-    delete_comment_lecturer__lecturer_id__comment__id__delete: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                id: number;
-                lecturer_id: number;
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Successful Response */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": unknown;
-                };
-            };
-            /** @description Validation Error */
-            422: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["HTTPValidationError"];
-                };
-            };
-        };
-    };
-    update_comment_lecturer_lecturer__lecturer_id__comment__id__patch: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                id: number;
-                lecturer_id: number;
-            };
-            cookie?: never;
-        };
-        requestBody: {
-            content: {
-                "application/json": components["schemas"]["LecturerCommentPatch"];
-            };
-        };
-        responses: {
-            /** @description Successful Response */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["CommentLecturer"];
-                };
-            };
-            /** @description Validation Error */
-            422: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["HTTPValidationError"];
-                };
-            };
-        };
-    };
-    review_comment_lecturer__lecturer_id__comment__id__review__post: {
-        parameters: {
-            query?: {
-                action?: "Approved" | "Declined";
-            };
-            header?: never;
-            path: {
-                id: number;
-                lecturer_id: number;
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Successful Response */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["CommentLecturer"];
-                };
-            };
-            /** @description Validation Error */
-            422: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["HTTPValidationError"];
-                };
-            };
-        };
-    };
-    get_unreviewed_comments_lecturer__lecturer_id__comment_review__get: {
-        parameters: {
-            query?: never;
-            header?: never;
-            path: {
-                lecturer_id: number;
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description Successful Response */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["CommentLecturer"][];
-                };
-            };
-            /** @description Validation Error */
-            422: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["HTTPValidationError"];
-                };
-            };
-        };
-    };
     get_lecturer_photos_lecturer__lecturer_id__photo_get: {
         parameters: {
             query?: {

package/redocly.yaml

@@ -1,44 +0,0 @@
-resolve:
-  http:
-    headers:
-      - matches: https://api.profcomff.com/**
-        name: Authorization
-        envVariable: SECRET_KEY
-
-apis:
-  auth@latest:
-    root: https://api.profcomff.com/auth/openapi.json
-    x-openapi-ts:
-      output: ./src/openapi/auth.ts
-  marketing@latest:
-    root: https://api.profcomff.com/marketing/openapi.json
-    x-openapi-ts:
-      output: ./src/openapi/marketing.ts
-  timetable@latest:
-    root: https://api.profcomff.com/timetable/openapi.json
-    x-openapi-ts:
-      output: ./src/openapi/timetable.ts
-  services@latest:
-    root: https://api.profcomff.com/services/openapi.json
-    x-openapi-ts:
-      output: ./src/openapi/services.ts
-  print@latest:
-    root: https://api.profcomff.com/print/openapi.json
-    x-openapi-ts:
-      output: ./src/openapi/print.ts
-  social@latest:
-    root: https://api.profcomff.com/social/openapi.json
-    x-openapi-ts:
-      output: ./src/openapi/social.ts
-  userdata@latest:
-    root: https://api.profcomff.com/userdata/openapi.json
-    x-openapi-ts:
-      output: ./src/openapi/userdata.ts
-  achievement@latest:
-    root: https://api.profcomff.com/achievement/openapi.json
-    x-openapi-ts:
-      output: ./src/openapi/achievement.ts
-  pinger@latest:
-    root: https://pinger.profcomff.com/openapi.json
-    x-openapi-ts:
-      output: ./src/openapi/pinger.ts