Merge branch 'feature/H-936' into 'master'
feature/H-936 See merge request hrbox-public/api!6
This commit was merged in pull request #6.
This commit is contained in:
Кирилл Голодаев
+306
@@ -2755,6 +2755,206 @@ paths:
|
|||||||
500:
|
500:
|
||||||
description: Server Error.
|
description: Server Error.
|
||||||
|
|
||||||
|
/newbies/index:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- MdWidgets
|
||||||
|
summary: Список новичков
|
||||||
|
operationId: /newbies/index
|
||||||
|
parameters:
|
||||||
|
- $ref: '#/components/parameters/boardDateTypeParam'
|
||||||
|
- $ref: '#/components/parameters/boardDateDayParam'
|
||||||
|
- $ref: '#/components/parameters/boardDateWeekParam'
|
||||||
|
- $ref: '#/components/parameters/boardDateMonthParam'
|
||||||
|
- $ref: '#/components/parameters/boardDateYearParam'
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description: MdWidget Items.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
success:
|
||||||
|
description: Result status.
|
||||||
|
type: boolean
|
||||||
|
example: true
|
||||||
|
message:
|
||||||
|
description: Message displayed to user (localized).
|
||||||
|
type: string
|
||||||
|
default: null
|
||||||
|
example: ''
|
||||||
|
errors:
|
||||||
|
description: Array of validation errors.
|
||||||
|
type: array
|
||||||
|
default: null
|
||||||
|
data:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
allOf:
|
||||||
|
- $ref: '#/components/schemas/mdWidgetUserItem'
|
||||||
|
- type: object
|
||||||
|
properties:
|
||||||
|
itemDate:
|
||||||
|
description: Date Birthday
|
||||||
|
type: string
|
||||||
|
format: date
|
||||||
|
example: 18 july
|
||||||
|
_links:
|
||||||
|
$ref: '#/components/schemas/_links'
|
||||||
|
_meta:
|
||||||
|
$ref: '#/components/schemas/_meta'
|
||||||
|
_periodUrls:
|
||||||
|
$ref: '#/components/schemas/_periodUrls'
|
||||||
|
400:
|
||||||
|
description: Bad Request.
|
||||||
|
401:
|
||||||
|
description: Unauthorized request.
|
||||||
|
403:
|
||||||
|
description: Unauthorized request.
|
||||||
|
500:
|
||||||
|
description: Server Error.
|
||||||
|
|
||||||
|
/birthday/index:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- MdWidgets
|
||||||
|
summary: Список дней рождений
|
||||||
|
operationId: /birthday/index
|
||||||
|
parameters:
|
||||||
|
- $ref: '#/components/parameters/boardDateTypeParam'
|
||||||
|
- $ref: '#/components/parameters/boardDateDayParam'
|
||||||
|
- $ref: '#/components/parameters/boardDateWeekParam'
|
||||||
|
- $ref: '#/components/parameters/boardDateMonthParam'
|
||||||
|
- $ref: '#/components/parameters/boardDateYearParam'
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description: MdWidget Items.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
success:
|
||||||
|
description: Result status.
|
||||||
|
type: boolean
|
||||||
|
example: true
|
||||||
|
message:
|
||||||
|
description: Message displayed to user (localized).
|
||||||
|
type: string
|
||||||
|
default: null
|
||||||
|
example: ''
|
||||||
|
errors:
|
||||||
|
description: Array of validation errors.
|
||||||
|
type: array
|
||||||
|
default: null
|
||||||
|
data:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
allOf:
|
||||||
|
- $ref: '#/components/schemas/mdWidgetUserItem'
|
||||||
|
- type: object
|
||||||
|
properties:
|
||||||
|
itemDate:
|
||||||
|
description: Employment date
|
||||||
|
type: string
|
||||||
|
format: date
|
||||||
|
example: 1 july
|
||||||
|
_links:
|
||||||
|
$ref: '#/components/schemas/_links'
|
||||||
|
_meta:
|
||||||
|
$ref: '#/components/schemas/_meta'
|
||||||
|
_periodUrls:
|
||||||
|
$ref: '#/components/schemas/_periodUrls'
|
||||||
|
400:
|
||||||
|
description: Bad Request.
|
||||||
|
401:
|
||||||
|
description: Unauthorized request.
|
||||||
|
403:
|
||||||
|
description: Unauthorized request.
|
||||||
|
500:
|
||||||
|
description: Server Error.
|
||||||
|
|
||||||
|
/experienced/index:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- MdWidgets
|
||||||
|
summary: Список годовщин по стажу в компании
|
||||||
|
operationId: /experienced/index
|
||||||
|
parameters:
|
||||||
|
- $ref: '#/components/parameters/boardDateTypeParam'
|
||||||
|
- $ref: '#/components/parameters/boardDateDayParam'
|
||||||
|
- $ref: '#/components/parameters/boardDateWeekParam'
|
||||||
|
- $ref: '#/components/parameters/boardDateMonthParam'
|
||||||
|
- $ref: '#/components/parameters/boardDateYearParam'
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description: MdWidget Items.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
properties:
|
||||||
|
success:
|
||||||
|
description: Result status.
|
||||||
|
type: boolean
|
||||||
|
example: true
|
||||||
|
message:
|
||||||
|
description: Message displayed to user (localized).
|
||||||
|
type: string
|
||||||
|
default: null
|
||||||
|
example: ''
|
||||||
|
errors:
|
||||||
|
description: Array of validation errors.
|
||||||
|
type: array
|
||||||
|
default: null
|
||||||
|
data:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
allOf:
|
||||||
|
- $ref: '#/components/schemas/mdWidgetUserItem'
|
||||||
|
- type: object
|
||||||
|
properties:
|
||||||
|
itemDate:
|
||||||
|
description: Work anniversary date
|
||||||
|
type: string
|
||||||
|
format: date
|
||||||
|
example: 18 july
|
||||||
|
data:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
date:
|
||||||
|
description: Work anniversary date
|
||||||
|
type: string
|
||||||
|
format: date
|
||||||
|
example: 18 july
|
||||||
|
experience:
|
||||||
|
description: Number of years of experience
|
||||||
|
type: string
|
||||||
|
format: date
|
||||||
|
example: 18 july
|
||||||
|
experienceFormat:
|
||||||
|
description: Number of years of experience formatted
|
||||||
|
type: string
|
||||||
|
format: date
|
||||||
|
example: 2 year
|
||||||
|
_links:
|
||||||
|
$ref: '#/components/schemas/_links'
|
||||||
|
_meta:
|
||||||
|
$ref: '#/components/schemas/_meta'
|
||||||
|
_periodUrls:
|
||||||
|
$ref: '#/components/schemas/_periodUrls'
|
||||||
|
400:
|
||||||
|
description: Bad Request.
|
||||||
|
401:
|
||||||
|
description: Unauthorized request.
|
||||||
|
403:
|
||||||
|
description: Unauthorized request.
|
||||||
|
500:
|
||||||
|
description: Server Error.
|
||||||
|
|
||||||
components:
|
components:
|
||||||
schemas:
|
schemas:
|
||||||
_meta:
|
_meta:
|
||||||
@@ -2805,6 +3005,28 @@ components:
|
|||||||
href:
|
href:
|
||||||
type: string
|
type: string
|
||||||
|
|
||||||
|
_periodUrls:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
currentDate:
|
||||||
|
description: Link to current period.
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
href:
|
||||||
|
type: string
|
||||||
|
nextDate:
|
||||||
|
description: Link to next period.
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
href:
|
||||||
|
type: string
|
||||||
|
prevDate:
|
||||||
|
description: Link to prev period.
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
href:
|
||||||
|
type: string
|
||||||
|
|
||||||
arrayOfIds:
|
arrayOfIds:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
@@ -6094,3 +6316,87 @@ components:
|
|||||||
|
|
||||||
shopOrderCancelResponse:
|
shopOrderCancelResponse:
|
||||||
$ref: '#/components/schemas/apiDefaultResponse'
|
$ref: '#/components/schemas/apiDefaultResponse'
|
||||||
|
|
||||||
|
mdWidgetUserItem:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
description: User ID
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
example: 195e1707-3f5d-4780-8dc1-b1023e1f974f
|
||||||
|
itemTitle:
|
||||||
|
description: User name
|
||||||
|
type: string
|
||||||
|
itemUrl:
|
||||||
|
description: User profile URL
|
||||||
|
type: string
|
||||||
|
example: https://hrenot.hrnox.io/core/user/view?id=5bc40c54-da74-4d5b-ac24-123374dc1a5a
|
||||||
|
itemImageUrl:
|
||||||
|
description: User avatar URL
|
||||||
|
type: string
|
||||||
|
example: https://hrenot.hrnox.io/file/user-face/5bc40c54-da74-4d5b-ac24-123374dc1a5a/300.jpg
|
||||||
|
itemEntityId:
|
||||||
|
description: Entity ID
|
||||||
|
type: number
|
||||||
|
example: 1
|
||||||
|
itemTip:
|
||||||
|
description: User position
|
||||||
|
type: string
|
||||||
|
example: CEO
|
||||||
|
itemDate:
|
||||||
|
description: Date board item
|
||||||
|
type: string
|
||||||
|
format: date
|
||||||
|
example: 19 july
|
||||||
|
data:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
position:
|
||||||
|
description: User position
|
||||||
|
type: string
|
||||||
|
example: CEO
|
||||||
|
departmentName:
|
||||||
|
description: User department name
|
||||||
|
type: string
|
||||||
|
example: 'New Department'
|
||||||
|
|
||||||
|
parameters:
|
||||||
|
boardDateTypeParam:
|
||||||
|
in: query
|
||||||
|
name: type
|
||||||
|
description: 1 - За день, 2 - За неделю, 3 - За месяц.
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: integer
|
||||||
|
enum: [1, 2, 3]
|
||||||
|
example: 2
|
||||||
|
boardDateDayParam:
|
||||||
|
name: day
|
||||||
|
in: query
|
||||||
|
description: Число месяца (обязателен для списка за день)
|
||||||
|
schema:
|
||||||
|
type: integer
|
||||||
|
example: 15
|
||||||
|
boardDateWeekParam:
|
||||||
|
name: week
|
||||||
|
in: query
|
||||||
|
description: Номер недели в году (обязателен для спика за неделю)
|
||||||
|
schema:
|
||||||
|
type: integer
|
||||||
|
example: 27
|
||||||
|
boardDateMonthParam:
|
||||||
|
name: month
|
||||||
|
in: query
|
||||||
|
description: Месяц (обязателен для списка по дням и месяцам)
|
||||||
|
schema:
|
||||||
|
type: integer
|
||||||
|
example: 7
|
||||||
|
boardDateYearParam:
|
||||||
|
name: year
|
||||||
|
in: query
|
||||||
|
description: Год (обязателен всегда)
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: integer
|
||||||
|
example: 2024
|
||||||
Reference in New Issue
Block a user