@profcomff/api-uilib 2024.10.22 → 2024.11.24

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@profcomff/api-uilib",
3
- "version": "2024.10.22",
3
+ "version": "2024.11.24",
4
4
  "description": "API wrappers, autogenerated from openapi.json files",
5
5
  "main": "./src/index.ts",
6
6
  "types": "./src/index.d.ts",
@@ -38,6 +38,106 @@ export interface paths {
38
38
  patch?: never;
39
39
  trace?: never;
40
40
  };
41
+ "/auth/authentic": {
42
+ parameters: {
43
+ query?: never;
44
+ header?: never;
45
+ path?: never;
46
+ cookie?: never;
47
+ };
48
+ get?: never;
49
+ put?: never;
50
+ post?: never;
51
+ /**
52
+ * Unregister
53
+ * @description Отключает для пользователя метод входа
54
+ */
55
+ delete: operations["_unregister_authentic_delete"];
56
+ options?: never;
57
+ head?: never;
58
+ patch?: never;
59
+ trace?: never;
60
+ };
61
+ "/auth/authentic/auth_url": {
62
+ parameters: {
63
+ query?: never;
64
+ header?: never;
65
+ path?: never;
66
+ cookie?: never;
67
+ };
68
+ /**
69
+ * Auth Url
70
+ * @description URL на который происходит редирект из приложения для авторизации на стороне провайдера
71
+ */
72
+ get: operations["_auth_url_authentic_auth_url_get"];
73
+ put?: never;
74
+ post?: never;
75
+ delete?: never;
76
+ options?: never;
77
+ head?: never;
78
+ patch?: never;
79
+ trace?: never;
80
+ };
81
+ "/auth/authentic/login": {
82
+ parameters: {
83
+ query?: never;
84
+ header?: never;
85
+ path?: never;
86
+ cookie?: never;
87
+ };
88
+ get?: never;
89
+ put?: never;
90
+ /**
91
+ * Login
92
+ * @description Вход в пользователя с помощью аккаунта Authentic
93
+ */
94
+ post: operations["_login_authentic_login_post"];
95
+ delete?: never;
96
+ options?: never;
97
+ head?: never;
98
+ patch?: never;
99
+ trace?: never;
100
+ };
101
+ "/auth/authentic/redirect_url": {
102
+ parameters: {
103
+ query?: never;
104
+ header?: never;
105
+ path?: never;
106
+ cookie?: never;
107
+ };
108
+ /**
109
+ * Redirect Url
110
+ * @description URL на который происходит редирект после завершения входа на стороне провайдера
111
+ */
112
+ get: operations["_redirect_url_authentic_redirect_url_get"];
113
+ put?: never;
114
+ post?: never;
115
+ delete?: never;
116
+ options?: never;
117
+ head?: never;
118
+ patch?: never;
119
+ trace?: never;
120
+ };
121
+ "/auth/authentic/registration": {
122
+ parameters: {
123
+ query?: never;
124
+ header?: never;
125
+ path?: never;
126
+ cookie?: never;
127
+ };
128
+ get?: never;
129
+ put?: never;
130
+ /**
131
+ * Register
132
+ * @description Создает аккаунт или привязывает существующий
133
+ */
134
+ post: operations["_register_authentic_registration_post"];
135
+ delete?: never;
136
+ options?: never;
137
+ head?: never;
138
+ patch?: never;
139
+ trace?: never;
140
+ };
41
141
  "/auth/coder/{user_id}/link": {
42
142
  parameters: {
43
143
  query?: never;
@@ -1135,7 +1235,7 @@ export interface paths {
1135
1235
  post?: never;
1136
1236
  /**
1137
1237
  * Delete User
1138
- * @description Scopes: `["auth.user.delete"]`
1238
+ * @description Scopes: `["auth.user.delete"]` or `["auth.user.selfdelete"]` for self delete
1139
1239
  */
1140
1240
  delete: operations["delete_user_user__user_id__delete"];
1141
1241
  options?: never;
@@ -1381,6 +1481,17 @@ export interface components {
1381
1481
  user_id: number;
1382
1482
  };
1383
1483
  /** OauthResponseSchema */
1484
+ auth_backend__auth_plugins__authentic__AuthenticAuth__OauthResponseSchema: {
1485
+ /** Code */
1486
+ code?: string | null;
1487
+ /** Id Token */
1488
+ id_token?: string | null;
1489
+ /** Scopes */
1490
+ scopes?: string[] | null;
1491
+ /** Session Name */
1492
+ session_name?: string | null;
1493
+ };
1494
+ /** OauthResponseSchema */
1384
1495
  auth_backend__auth_plugins__github__GithubAuth__OauthResponseSchema: {
1385
1496
  /** Code */
1386
1497
  code?: string | null;
@@ -1803,6 +1914,132 @@ export interface operations {
1803
1914
  };
1804
1915
  };
1805
1916
  };
1917
+ _unregister_authentic_delete: {
1918
+ parameters: {
1919
+ query?: never;
1920
+ header?: never;
1921
+ path?: never;
1922
+ cookie?: never;
1923
+ };
1924
+ requestBody?: never;
1925
+ responses: {
1926
+ /** @description Successful Response */
1927
+ 200: {
1928
+ headers: {
1929
+ [name: string]: unknown;
1930
+ };
1931
+ content: {
1932
+ "application/json": unknown;
1933
+ };
1934
+ };
1935
+ };
1936
+ };
1937
+ _auth_url_authentic_auth_url_get: {
1938
+ parameters: {
1939
+ query?: never;
1940
+ header?: never;
1941
+ path?: never;
1942
+ cookie?: never;
1943
+ };
1944
+ requestBody?: never;
1945
+ responses: {
1946
+ /** @description Successful Response */
1947
+ 200: {
1948
+ headers: {
1949
+ [name: string]: unknown;
1950
+ };
1951
+ content: {
1952
+ "application/json": components["schemas"]["UrlSchema"];
1953
+ };
1954
+ };
1955
+ };
1956
+ };
1957
+ _login_authentic_login_post: {
1958
+ parameters: {
1959
+ query?: never;
1960
+ header?: never;
1961
+ path?: never;
1962
+ cookie?: never;
1963
+ };
1964
+ requestBody: {
1965
+ content: {
1966
+ "application/json": components["schemas"]["auth_backend__auth_plugins__authentic__AuthenticAuth__OauthResponseSchema"];
1967
+ };
1968
+ };
1969
+ responses: {
1970
+ /** @description Successful Response */
1971
+ 200: {
1972
+ headers: {
1973
+ [name: string]: unknown;
1974
+ };
1975
+ content: {
1976
+ "application/json": components["schemas"]["auth_backend__auth_method__session__Session"];
1977
+ };
1978
+ };
1979
+ /** @description Validation Error */
1980
+ 422: {
1981
+ headers: {
1982
+ [name: string]: unknown;
1983
+ };
1984
+ content: {
1985
+ "application/json": components["schemas"]["HTTPValidationError"];
1986
+ };
1987
+ };
1988
+ };
1989
+ };
1990
+ _redirect_url_authentic_redirect_url_get: {
1991
+ parameters: {
1992
+ query?: never;
1993
+ header?: never;
1994
+ path?: never;
1995
+ cookie?: never;
1996
+ };
1997
+ requestBody?: never;
1998
+ responses: {
1999
+ /** @description Successful Response */
2000
+ 200: {
2001
+ headers: {
2002
+ [name: string]: unknown;
2003
+ };
2004
+ content: {
2005
+ "application/json": components["schemas"]["UrlSchema"];
2006
+ };
2007
+ };
2008
+ };
2009
+ };
2010
+ _register_authentic_registration_post: {
2011
+ parameters: {
2012
+ query?: never;
2013
+ header?: never;
2014
+ path?: never;
2015
+ cookie?: never;
2016
+ };
2017
+ requestBody: {
2018
+ content: {
2019
+ "application/json": components["schemas"]["auth_backend__auth_plugins__authentic__AuthenticAuth__OauthResponseSchema"];
2020
+ };
2021
+ };
2022
+ responses: {
2023
+ /** @description Successful Response */
2024
+ 200: {
2025
+ headers: {
2026
+ [name: string]: unknown;
2027
+ };
2028
+ content: {
2029
+ "application/json": components["schemas"]["auth_backend__auth_method__session__Session"];
2030
+ };
2031
+ };
2032
+ /** @description Validation Error */
2033
+ 422: {
2034
+ headers: {
2035
+ [name: string]: unknown;
2036
+ };
2037
+ content: {
2038
+ "application/json": components["schemas"]["HTTPValidationError"];
2039
+ };
2040
+ };
2041
+ };
2042
+ };
1806
2043
  _get_link_coder__user_id__link_get: {
1807
2044
  parameters: {
1808
2045
  query?: never;
@@ -25,6 +25,8 @@ export interface paths {
25
25
  *
26
26
  * `lecturer_id` - вернет все комментарии для преподавателя с конкретным id, по дефолту возвращает вообще все аппрувнутые комментарии.
27
27
  *
28
+ * `user_id` - вернет все комментарии пользователя с конкретным id
29
+ *
28
30
  * `unreviewed` - вернет все непроверенные комментарии, если True. По дефолту False.
29
31
  */
30
32
  get: operations["get_comments_comment_get"];
@@ -85,22 +87,28 @@ export interface paths {
85
87
  };
86
88
  /**
87
89
  * Get Lecturers
88
- * @description Scopes: `["rating.lecturer.read"]`
89
- *
90
- * `limit` - максимальное количество возвращаемых преподавателей
90
+ * @description `limit` - максимальное количество возвращаемых преподавателей
91
91
  *
92
92
  * `offset` - нижняя граница получения преподавателей, т.е. если по дефолту первым возвращается преподаватель с условным номером N, то при наличии ненулевого offset будет возвращаться преподаватель с номером N + offset
93
93
  *
94
- * `order_by` - возможные значения `'general'`.
95
- * Если передано `'general'` - возвращается список преподавателей отсортированных по общей оценке
94
+ * `order_by` - возможные значения `"mark_kindness", "mark_freebie", "mark_clarity", "mark_general", "last_name"`.
95
+ * Если передано `'last_name'` - возвращается список преподавателей отсортированных по алфавиту по фамилиям
96
+ * Если передано `'mark_...'` - возвращается список преподавателей отсортированных по конкретной оценке
96
97
  *
97
98
  * `info` - возможные значения `'comments'`, `'mark'`.
98
99
  * Если передано `'comments'`, то возвращаются одобренные комментарии к преподавателю.
99
100
  * Если передано `'mark'`, то возвращаются общие средние оценки, а также суммарная средняя оценка по всем одобренным комментариям.
100
101
  *
101
102
  * `subject`
102
- * Если передано `subject` - возвращает всех преподавателей, для которых переданное значение совпадает с их предметом преподавания.
103
+ * Если передано `subject` - возвращает всех преподавателей, для которых переданное значение совпадает с одним из их предметов преподавания.
103
104
  * Также возвращает всех преподавателей, у которых есть комментарий с совпадающим с данным subject.
105
+ *
106
+ * `name`
107
+ * Поле для ФИО. Если передано `name` - возвращает всех преподователей, для которых нашлись совпадения с переданной строкой
108
+ *
109
+ * `asc_order`
110
+ * Если передано true, сортировать в порядке возрастания
111
+ * Иначе - в порядке убывания
104
112
  */
105
113
  get: operations["get_lecturers_lecturer_get"];
106
114
  put?: never;
@@ -170,6 +178,8 @@ export interface components {
170
178
  mark_clarity: number;
171
179
  /** Mark Freebie */
172
180
  mark_freebie: number;
181
+ /** Mark General */
182
+ mark_general: number;
173
183
  /** Mark Kindness */
174
184
  mark_kindness: number;
175
185
  /** Subject */
@@ -181,6 +191,8 @@ export interface components {
181
191
  * Format: date-time
182
192
  */
183
193
  update_ts: string;
194
+ /** User Id */
195
+ user_id?: number | null;
184
196
  /**
185
197
  * Uuid
186
198
  * Format: uuid
@@ -203,6 +215,11 @@ export interface components {
203
215
  };
204
216
  /** CommentPost */
205
217
  CommentPost: {
218
+ /**
219
+ * Is Anonymous
220
+ * @default true
221
+ */
222
+ is_anonymous: boolean;
206
223
  /** Mark Clarity */
207
224
  mark_clarity: number;
208
225
  /** Mark Freebie */
@@ -241,8 +258,8 @@ export interface components {
241
258
  mark_kindness?: number | null;
242
259
  /** Middle Name */
243
260
  middle_name: string;
244
- /** Subject */
245
- subject?: string | null;
261
+ /** Subjects */
262
+ subjects?: string[] | null;
246
263
  /** Timetable Id */
247
264
  timetable_id: number;
248
265
  };
@@ -270,8 +287,6 @@ export interface components {
270
287
  last_name?: string | null;
271
288
  /** Middle Name */
272
289
  middle_name?: string | null;
273
- /** Subject */
274
- subject?: string | null;
275
290
  /** Timetable Id */
276
291
  timetable_id?: number | null;
277
292
  };
@@ -285,8 +300,6 @@ export interface components {
285
300
  last_name: string;
286
301
  /** Middle Name */
287
302
  middle_name: string;
288
- /** Subject */
289
- subject?: string | null;
290
303
  /** Timetable Id */
291
304
  timetable_id: number;
292
305
  };
@@ -325,6 +338,7 @@ export interface operations {
325
338
  offset?: number;
326
339
  order_by?: "create_ts"[];
327
340
  unreviewed?: boolean;
341
+ user_id?: number | null;
328
342
  };
329
343
  header?: never;
330
344
  path?: never;
@@ -485,10 +499,12 @@ export interface operations {
485
499
  get_lecturers_lecturer_get: {
486
500
  parameters: {
487
501
  query?: {
502
+ asc_order?: boolean;
488
503
  info?: ("comments" | "mark")[];
489
504
  limit?: number;
505
+ name?: string;
490
506
  offset?: number;
491
- order_by?: ("general" | "")[];
507
+ order_by?: "mark_kindness" | "mark_freebie" | "mark_clarity" | "mark_general" | "last_name";
492
508
  subject?: string;
493
509
  };
494
510
  header?: never;