add openapi yaml
This commit is contained in:
parent
5e050590fa
commit
4362b79507
1 changed files with 105 additions and 0 deletions
105
ervu_lkrp_fl-openapi.yaml
Normal file
105
ervu_lkrp_fl-openapi.yaml
Normal file
|
|
@ -0,0 +1,105 @@
|
|||
openapi: 3.0.3
|
||||
info:
|
||||
title: ervu-lkrp-fl API
|
||||
description: API сервиса ervu-lkrp-fl
|
||||
version: 1.9.1
|
||||
servers:
|
||||
- url: https://fl-lkrp-ervu-test.pgs.rtlabs.ru
|
||||
paths:
|
||||
/esia/auth:
|
||||
get:
|
||||
summary: Получение маркера доступа
|
||||
operationId: esiaAuth
|
||||
description: Получение маркера доступа в обмен на код от ЕСИА и создание внутреннего токена
|
||||
parameters:
|
||||
- name: code
|
||||
in: query
|
||||
required: true
|
||||
description: Код, присланный ЕСИА после успешной авторизации
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
"200":
|
||||
description: Authentication successful
|
||||
/esia/person:
|
||||
get:
|
||||
summary: Получение информации о пользователе
|
||||
operationId: getPersonModel
|
||||
description: Получение информации о пользователе ЕСИА
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
/esia/refresh:
|
||||
post:
|
||||
summary: Обновление токена
|
||||
operationId: refreshToken
|
||||
description: Обновление токена
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
/esia/url:
|
||||
get:
|
||||
summary: Получение URL ЕСИА
|
||||
operationId: getEsiaUrl
|
||||
description: Получение URL ЕСИА
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: string
|
||||
/esia/userfullname:
|
||||
get:
|
||||
summary: Получение полного имени пользователя
|
||||
operationId: getUserFullname
|
||||
description: Получение полного имени пользователя ЕСИА
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: string
|
||||
/extract/{formatRegistry}:
|
||||
get:
|
||||
summary: Получение выписки
|
||||
operationId: getExtract
|
||||
description: Получение выписки из реестров повесток и воинского учета
|
||||
parameters:
|
||||
- name: formatRegistry
|
||||
in: path
|
||||
required: true
|
||||
description: Формат выписки (1 - по воинскому учету; 2 - по повесткам)
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
headers:
|
||||
Content-Disposition:
|
||||
schema:
|
||||
type: string
|
||||
example: attachment; filename*=UTF-8''encodedfilename.zip
|
||||
content:
|
||||
application/octet-stream:
|
||||
schema:
|
||||
type: object
|
||||
"204":
|
||||
description: No Content
|
||||
/recruit:
|
||||
get:
|
||||
summary: Получение информации о повестке, временных мерах и воинскому учету
|
||||
operationId: getData
|
||||
description: Получение информации о повестке, временных мерах и воинскому учету
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
Loading…
Add table
Add a link
Reference in a new issue