diff --git a/v2/swagger.yaml b/v2/swagger.yaml index 18a98cc..be716ad 100644 --- a/v2/swagger.yaml +++ b/v2/swagger.yaml @@ -695,13 +695,15 @@ paths: in: query schema: { type: string } description: | - Период создания записи в формате `<начало>|<конец>`, - где даты указаны по ISO 8601. + Период создания записи в виде `<начало>|<конец>`, + где каждая дата задаётся в формате `yyyy-MM-dd`. + Указание времени суток не поддерживается. - name: last_login_at in: query schema: { type: string } description: | - Период последнего входа в систему в формате `<начало>|<конец>`. + Период последнего входа в систему в виде `<начало>|<конец>`, + где каждая дата задаётся в формате `yyyy-MM-dd`. - name: user_list_key in: query schema: { type: string, format: uuid } @@ -1748,6 +1750,54 @@ paths: 500: description: Server Error + /user-postcard/seen: + post: + tags: + - postcard + summary: Mark received postcard as opened + operationId: userPostcardSeen + parameters: + - name: id + in: query + description: UserPostcard item ID + schema: + type: string + format: uuid + required: true + responses: + 200: + description: Postcard marked as opened + content: + application/json: + schema: + type: object + properties: + success: + type: boolean + example: true + data: + type: object + nullable: true + example: null + errors: + type: object + nullable: true + example: null + message: + type: object + nullable: true + example: null + 400: + description: Invalid input (malformed id) + 401: + description: Unauthorized request + 403: + description: Unauthorized request + 404: + description: Postcard not found + 500: + description: Server Error + /article/news: get: tags: @@ -2479,6 +2529,7 @@ paths: - updBirthday - updNewbies - updBooks + - updContent - name: info in: query description: > @@ -2491,6 +2542,21 @@ paths: enum: - profileBrief - notificationsBadge + - name: visibility_target_id + in: query + description: > + Content widgets visibility target filter. Used for `updContent` widget. + * `1` - Web + * `2` - Mobile app + * `3` - Everywhere + example: 2 + schema: + type: integer + default: 1 + enum: + - 1 + - 2 + - 3 responses: 200: description: Returns all the dashboard data about requested widgets. In response object only requested info/widgets keys will be presented. If widget is not available for current user, this widget will not exists in response of will be null. @@ -2550,6 +2616,21 @@ paths: updBooks: # description: Company feed - New books in library $ref: '#/components/schemas/dashboardWidget' + updContent: + description: Company feed - Content widgets + allOf: + - $ref: '#/components/schemas/dashboardWidget' + - type: object + properties: + items: + type: array + items: + allOf: + - $ref: '#/components/schemas/dashboardWidgetItem' + - type: object + properties: + data: + $ref: '#/components/schemas/dashboardContentWidgetItemData' 400: description: Invalid input 401: @@ -8386,7 +8467,10 @@ paths: - name: created_at in: query schema: { type: string } - description: 'Диапазон в формате `from|to` (ISO дата/время).' + description: | + Диапазон в виде `<начало>|<конец>`, где каждая дата + задаётся в формате `yyyy-MM-dd`. Указание времени суток + не поддерживается. responses: 200: description: Список кошельков @@ -8519,7 +8603,10 @@ paths: - name: created_at in: query schema: { type: string } - description: 'Диапазон в формате `from|to` (ISO дата/время).' + description: | + Диапазон в виде `<начало>|<конец>`, где каждая дата + задаётся в формате `yyyy-MM-dd`. Указание времени суток + не поддерживается. responses: 200: description: Список транзакций @@ -9309,18 +9396,21 @@ paths: in: query schema: { type: string } description: | - Период создания записи в формате `<начало>|<конец>`, - где даты указаны по ISO 8601. + Период создания записи в виде `<начало>|<конец>`, + где каждая дата задаётся в формате `yyyy-MM-dd`. + Указание времени суток не поддерживается. - name: employment_date in: query schema: { type: string } description: | - Период даты приёма на работу в формате `<начало>|<конец>`. + Период даты приёма на работу в виде `<начало>|<конец>`, + где каждая дата задаётся в формате `yyyy-MM-dd`. - name: fired_date in: query schema: { type: string } description: | - Период даты увольнения в формате `<начало>|<конец>`. + Период даты увольнения в виде `<начало>|<конец>`, + где каждая дата задаётся в формате `yyyy-MM-dd`. - name: user_list_key in: query schema: { type: string, format: uuid } @@ -10383,7 +10473,10 @@ components: type: string is_seen: type: boolean - description: Did user seen this postcard? + description: Whether the recipient has opened this postcard. + needShowEnvelope: + type: boolean + description: Whether the mobile app should show the unopened postcard envelope. userGroup: type: object @@ -10736,6 +10829,31 @@ components: periodLengthText: type: integer description: Продолжительность отпуска в днях + + dashboardContentWidgetItemData: + type: object + properties: + content: + type: string + description: Rendered content widget HTML. + example: 'Open article' + visibility_target_id: + type: integer + description: Content widget visibility target. + enum: + - 1 + - 2 + - 3 + example: 2 + visibilityTargetName: + type: string + description: Human readable visibility target name. + enum: + - Веб + - Мобильное приложение + - Везде + example: Мобильное приложение + feedback: type: object properties: @@ -14808,13 +14926,13 @@ components: employment_date: type: string nullable: true - description: Дата приёма на работу в формате ISO 8601. + description: Дата приёма на работу в формате `yyyy-MM-dd`. fired_date: type: string nullable: true description: | - Дата увольнения в формате ISO 8601. Поле имеет значение `null` - для действующих трудоустройств. + Дата увольнения в формате `yyyy-MM-dd`. Поле имеет значение + `null` для действующих трудоустройств. status_id: type: integer nullable: true