openapi: 3.0.3
info:
title: 'Odinn ML'
description: ''
version: 1.0.0
servers:
-
url: 'https://ml.persomon.odinn.cloud'
paths:
/api/ml-results:
get:
summary: Список
operationId: ''
description: "Получить список экспортов результатов применения ML (с пагинацией)\n\nСтандартный листинг Одинна с возможностью фильтрации"
parameters:
-
in: query
name: page
description: 'Номер страницы.'
example: 1
required: false
schema:
type: integer
description: 'Номер страницы.'
example: 1
-
in: query
name: page-size
description: 'Количество элементов, возвращаемых на странице. По умолчанию 50.'
example: 50
required: false
schema:
type: integer
description: 'Количество элементов, возвращаемых на странице. По умолчанию 50.'
example: 50
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
current_page: 1
data: []
first_page_url: 'https://ml.persomon.odinn.cloud/api/ml-results?page=1'
from: null
last_page: 1
last_page_url: 'https://ml.persomon.odinn.cloud/api/ml-results?page=1'
links:
-
url: null
label: '« Назад'
active: false
-
url: 'https://ml.persomon.odinn.cloud/api/ml-results?page=1'
label: '1'
active: true
-
url: null
label: 'Вперёд »'
active: false
next_page_url: null
path: 'https://ml.persomon.odinn.cloud/api/ml-results'
per_page: 50
prev_page_url: null
to: null
total: 0
properties:
current_page:
type: integer
example: 1
data:
type: array
example: []
first_page_url:
type: string
example: 'https://ml.persomon.odinn.cloud/api/ml-results?page=1'
from:
type: string
example: null
last_page:
type: integer
example: 1
last_page_url:
type: string
example: 'https://ml.persomon.odinn.cloud/api/ml-results?page=1'
links:
type: array
example:
-
url: null
label: '« Назад'
active: false
-
url: 'https://ml.persomon.odinn.cloud/api/ml-results?page=1'
label: '1'
active: true
-
url: null
label: 'Вперёд »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Назад'
active:
type: boolean
example: false
next_page_url:
type: string
example: null
path:
type: string
example: 'https://ml.persomon.odinn.cloud/api/ml-results'
per_page:
type: integer
example: 50
prev_page_url:
type: string
example: null
to:
type: string
example: null
total:
type: integer
example: 0
tags:
- 'ML Results'
security: []
/api/ml-results/ml-data:
get:
summary: 'Получение результатов по применению ML через API'
operationId: MLAPI
description: ''
parameters: []
responses:
500:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Server Error'
properties:
message:
type: string
example: 'Server Error'
tags:
- 'ML Results'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
ids:
type: array
description: 'Значение поля value должно быть корректным UUID.'
example:
- 818d8c20-4342-39a3-9888-b356987a8700
items:
type: string
required:
- ids
security: []
/api/ml-results/export:
post:
summary: 'Экспорт результатов по применению ML в виде файла'
operationId: ML
description: "Начинает выгрузку результатов по применению ML в виде файла.\nМетод только начинает выгрузку, скачать файл можно будет по завершении (статус completed)\n\n"
parameters: []
responses: { }
tags:
- 'ML Results'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
ids:
type: array
description: 'Значение поля value должно быть корректным UUID.'
example:
- 800720db-423b-3dd6-9046-7ef0567c4df8
items:
type: string
with_photo:
type: boolean
description: ''
example: true
required:
- ids
security: []
'/api/ml-results/{id}':
get:
summary: 'Получить информацию об экспорте'
operationId: ''
description: ''
parameters: []
responses:
404:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Ml Results Export #12196d51-9cd6-3ab5-9b90-08fa15fcfe49 Not found'
properties:
message:
type: string
example: 'Ml Results Export #12196d51-9cd6-3ab5-9b90-08fa15fcfe49 Not found'
tags:
- 'ML Results'
security: []
parameters:
-
in: path
name: id
description: 'Идентификатор (UUID)'
example: 12196d51-9cd6-3ab5-9b90-08fa15fcfe49
required: true
schema:
type: uuid
'/api/ml-results/{id}/download':
get:
summary: 'Скачать файл экспорта результатов по применению ML'
operationId: ML
description: ''
parameters: []
responses:
404:
description: ''
content:
application/json:
schema:
type: object
example:
message: ''
properties:
message:
type: string
example: ''
tags:
- 'ML Results'
security: []
parameters:
-
in: path
name: id
description: 'Идентификатор (UUID)'
example: 5b8fd871-1b88-3637-93b1-14e92dd9002a
required: true
schema:
type: uuid
/api/weight:
get:
summary: Список
operationId: ''
description: "Получить список весов (с пагинацией)\nСтандартный листинг Одинна с возможностью фильтрации"
parameters:
-
in: query
name: page
description: 'Номер страницы.'
example: 1
required: false
schema:
type: integer
description: 'Номер страницы.'
example: 1
-
in: query
name: page-size
description: 'Количество элементов, возвращаемых на странице. По умолчанию 50.'
example: 50
required: false
schema:
type: integer
description: 'Количество элементов, возвращаемых на странице. По умолчанию 50.'
example: 50
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
current_page: 1
data: []
first_page_url: 'https://ml.persomon.odinn.cloud/api/weight?page=1'
from: null
last_page: 1
last_page_url: 'https://ml.persomon.odinn.cloud/api/weight?page=1'
links:
-
url: null
label: '« Назад'
active: false
-
url: 'https://ml.persomon.odinn.cloud/api/weight?page=1'
label: '1'
active: true
-
url: null
label: 'Вперёд »'
active: false
next_page_url: null
path: 'https://ml.persomon.odinn.cloud/api/weight'
per_page: 50
prev_page_url: null
to: null
total: 0
properties:
current_page:
type: integer
example: 1
data:
type: array
example: []
first_page_url:
type: string
example: 'https://ml.persomon.odinn.cloud/api/weight?page=1'
from:
type: string
example: null
last_page:
type: integer
example: 1
last_page_url:
type: string
example: 'https://ml.persomon.odinn.cloud/api/weight?page=1'
links:
type: array
example:
-
url: null
label: '« Назад'
active: false
-
url: 'https://ml.persomon.odinn.cloud/api/weight?page=1'
label: '1'
active: true
-
url: null
label: 'Вперёд »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Назад'
active:
type: boolean
example: false
next_page_url:
type: string
example: null
path:
type: string
example: 'https://ml.persomon.odinn.cloud/api/weight'
per_page:
type: integer
example: 50
prev_page_url:
type: string
example: null
to:
type: string
example: null
total:
type: integer
example: 0
tags:
- 'Весы моделей'
security: []
post:
summary: Создать
operationId: ''
description: ''
parameters: []
responses: { }
tags:
- 'Весы моделей'
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: Имя
example: repellat
notes:
type: string
description: Заметки
example: id
models:
type: array
description: 'UUID моделей для этого веса'
example:
- accusantium
items:
type: string
file:
type: string
format: binary
description: 'Файл веса'
required:
- name
- models
- file
security: []
'/api/weight/{id}':
get:
summary: 'Получить информацию о весах модели'
operationId: ''
description: ''
parameters: []
responses:
404:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'Weight #1d393a5e-8745-3ea3-a7b4-66bba0366fc0 Not found'
properties:
message:
type: string
example: 'Weight #1d393a5e-8745-3ea3-a7b4-66bba0366fc0 Not found'
tags:
- 'Весы моделей'
security: []
put:
summary: 'Обновить информацию о весах моделей'
operationId: ''
description: ''
parameters: []
responses: { }
tags:
- 'Весы моделей'
requestBody:
required: false
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: Имя
example: voluptate
notes:
type: string
description: Заметки
example: iure
models:
type: array
description: 'UUID моделей для этого веса'
example:
- consequatur
items:
type: string
file:
type: string
format: binary
description: 'Файл веса'
security: []
delete:
summary: 'Удалить весы модели'
operationId: ''
description: ''
parameters: []
responses: { }
tags:
- 'Весы моделей'
security: []
parameters:
-
in: path
name: id
description: 'Идентификатор (UUID)'
example: 1d393a5e-8745-3ea3-a7b4-66bba0366fc0
required: true
schema:
type: uuid
'/api/weight/{id}/download':
get:
summary: 'Скачать файл весов'
operationId: ''
description: ''
parameters: []
responses:
404:
description: ''
content:
application/json:
schema:
type: object
example:
message: ''
properties:
message:
type: string
example: ''
tags:
- 'Весы моделей'
security: []
parameters:
-
in: path
name: id
description: 'Идентификатор (UUID)'
example: cd82527a-b988-358b-80d4-e21569fdccce
required: true
schema:
type: uuid
/api/ai-model:
get:
summary: Список
operationId: ''
description: "Получить список весов (с пагинацией)\nСтандартный листинг Одинна с возможностью фильтрации"
parameters:
-
in: query
name: page
description: 'Номер страницы.'
example: 1
required: false
schema:
type: integer
description: 'Номер страницы.'
example: 1
-
in: query
name: page-size
description: 'Количество элементов, возвращаемых на странице. По умолчанию 50.'
example: 50
required: false
schema:
type: integer
description: 'Количество элементов, возвращаемых на странице. По умолчанию 50.'
example: 50
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
current_page: 1
data: []
first_page_url: 'https://ml.persomon.odinn.cloud/api/ai-model?page=1'
from: null
last_page: 1
last_page_url: 'https://ml.persomon.odinn.cloud/api/ai-model?page=1'
links:
-
url: null
label: '« Назад'
active: false
-
url: 'https://ml.persomon.odinn.cloud/api/ai-model?page=1'
label: '1'
active: true
-
url: null
label: 'Вперёд »'
active: false
next_page_url: null
path: 'https://ml.persomon.odinn.cloud/api/ai-model'
per_page: 50
prev_page_url: null
to: null
total: 0
properties:
current_page:
type: integer
example: 1
data:
type: array
example: []
first_page_url:
type: string
example: 'https://ml.persomon.odinn.cloud/api/ai-model?page=1'
from:
type: string
example: null
last_page:
type: integer
example: 1
last_page_url:
type: string
example: 'https://ml.persomon.odinn.cloud/api/ai-model?page=1'
links:
type: array
example:
-
url: null
label: '« Назад'
active: false
-
url: 'https://ml.persomon.odinn.cloud/api/ai-model?page=1'
label: '1'
active: true
-
url: null
label: 'Вперёд »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Назад'
active:
type: boolean
example: false
next_page_url:
type: string
example: null
path:
type: string
example: 'https://ml.persomon.odinn.cloud/api/ai-model'
per_page:
type: integer
example: 50
prev_page_url:
type: string
example: null
to:
type: string
example: null
total:
type: integer
example: 0
tags:
- Модели
security: []
post:
summary: Создать
operationId: ''
description: ''
parameters: []
responses: { }
tags:
- Модели
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: Имя
example: rerum
notes:
type: string
description: Заметки
example: necessitatibus
classes:
type: array
description: 'Классы которые модель может обрабатывать'
example:
- perferendis
items:
type: string
file:
type: string
format: binary
description: 'Файл модели'
required:
- name
- file
security: []
'/api/ai-model/{id}':
get:
summary: 'Получить информацию о модели'
operationId: ''
description: ''
parameters: []
responses:
404:
description: ''
content:
application/json:
schema:
type: object
example:
message: 'AI Model #e91204f4-97ac-38e6-a90f-740a28fb44af Not found'
properties:
message:
type: string
example: 'AI Model #e91204f4-97ac-38e6-a90f-740a28fb44af Not found'
tags:
- Модели
security: []
put:
summary: 'Обновить информацию о модели'
operationId: ''
description: ''
parameters: []
responses: { }
tags:
- Модели
requestBody:
required: false
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: Имя
example: quisquam
notes:
type: string
description: Заметки
example: doloremque
classes:
type: array
description: 'Классы которые модель может обрабатывать'
example:
- cum
items:
type: string
file:
type: string
format: binary
description: 'Файл модели'
security: []
delete:
summary: 'Удалить модель'
operationId: ''
description: ''
parameters: []
responses: { }
tags:
- Модели
security: []
parameters:
-
in: path
name: id
description: 'Идентификатор (UUID)'
example: e91204f4-97ac-38e6-a90f-740a28fb44af
required: true
schema:
type: uuid
'/api/ai-model/{id}/download':
get:
summary: 'Скачать файл модели'
operationId: ''
description: ''
parameters: []
responses:
404:
description: ''
content:
application/json:
schema:
type: object
example:
message: ''
properties:
message:
type: string
example: ''
tags:
- Модели
security: []
parameters:
-
in: path
name: id
description: 'Идентификатор (UUID)'
example: 3039498f-c566-35a2-a018-d95660c603ac
required: true
schema:
type: uuid
tags:
-
name: 'ML Results'
description: ''
-
name: 'Весы моделей'
description: ''
-
name: Модели
description: ''