Files
rostpoliplast/backend/docs/swagger.yaml
T
2026-04-29 14:27:16 +03:00

254 lines
6.8 KiB
YAML

definitions:
gitea_d3m0k1d_ru_d3m0k1d_rostpoliplast_backend_internal_storage.Bale:
description: Тюк - единица готовой продукции
properties:
id:
type: integer
timestamp:
type: string
type:
type: string
typeId:
type: integer
type: object
gitea_d3m0k1d_ru_d3m0k1d_rostpoliplast_backend_internal_storage.BaleType:
description: Тип тюка - характеристики тюка
properties:
height:
type: number
id:
type: integer
length:
type: number
type:
type: string
weight:
type: number
width:
type: number
type: object
info:
contact: {}
paths:
/bale-types:
get:
consumes:
- application/json
description: Возвращает список всех типов тюков
produces:
- application/json
responses:
"200":
description: OK
schema:
items:
$ref: '#/definitions/gitea_d3m0k1d_ru_d3m0k1d_rostpoliplast_backend_internal_storage.BaleType'
type: array
summary: Получить все типы тюков
tags:
- bale-types
post:
consumes:
- application/json
description: Создаёт новый тип тюка
parameters:
- description: Данные типа тюка
in: body
name: bale_type
required: true
schema:
$ref: '#/definitions/gitea_d3m0k1d_ru_d3m0k1d_rostpoliplast_backend_internal_storage.BaleType'
produces:
- application/json
responses:
"201":
description: Created
schema:
$ref: '#/definitions/gitea_d3m0k1d_ru_d3m0k1d_rostpoliplast_backend_internal_storage.BaleType'
summary: Создать тип тюка
tags:
- bale-types
/bale-types/{id}:
delete:
consumes:
- application/json
description: Удаляет тип тюка по ID
parameters:
- description: ID типа тюка
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
additionalProperties:
type: boolean
type: object
summary: Удалить тип тюка
tags:
- bale-types
get:
consumes:
- application/json
description: Возвращает тип тюка по ID
parameters:
- description: ID типа тюка
in: path
name: id
required: true
type: integer
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/gitea_d3m0k1d_ru_d3m0k1d_rostpoliplast_backend_internal_storage.BaleType'
summary: Получить тип тюка по ID
tags:
- bale-types
put:
consumes:
- application/json
description: Обновляет данные типа тюка по ID
parameters:
- description: ID типа тюка
in: path
name: id
required: true
type: integer
- description: Данные типа тюка
in: body
name: bale_type
required: true
schema:
$ref: '#/definitions/gitea_d3m0k1d_ru_d3m0k1d_rostpoliplast_backend_internal_storage.BaleType'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/gitea_d3m0k1d_ru_d3m0k1d_rostpoliplast_backend_internal_storage.BaleType'
summary: Обновить тип тюка
tags:
- bale-types
/bales:
get:
consumes:
- application/json
description: Возвращает список всех тюков
produces:
- application/json
responses:
"200":
description: OK
schema:
items:
$ref: '#/definitions/gitea_d3m0k1d_ru_d3m0k1d_rostpoliplast_backend_internal_storage.Bale'
type: array
summary: Получить все тюки
tags:
- bales
post:
consumes:
- application/json
description: Создаёт новый тюк и отправляет в очередь задач RabbitMQ
parameters:
- description: Данные тюка
in: body
name: bale
required: true
schema:
$ref: '#/definitions/gitea_d3m0k1d_ru_d3m0k1d_rostpoliplast_backend_internal_storage.Bale'
produces:
- application/json
responses:
"201":
description: Created
schema:
$ref: '#/definitions/gitea_d3m0k1d_ru_d3m0k1d_rostpoliplast_backend_internal_storage.Bale'
summary: Создать тюк
tags:
- bales
/bales/{id}:
delete:
consumes:
- application/json
description: Удаляет тюк по ID
parameters:
- description: ID тюка
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
additionalProperties:
type: boolean
type: object
summary: Удалить тюк
tags:
- bales
get:
consumes:
- application/json
description: Возвращает тюк по ID
parameters:
- description: ID тюка
in: path
name: id
required: true
type: string
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/gitea_d3m0k1d_ru_d3m0k1d_rostpoliplast_backend_internal_storage.Bale'
summary: Получить тюк по ID
tags:
- bales
put:
consumes:
- application/json
description: Обновляет данные тюка по ID
parameters:
- description: ID тюка
in: path
name: id
required: true
type: string
- description: Данные тюка
in: body
name: bale
required: true
schema:
$ref: '#/definitions/gitea_d3m0k1d_ru_d3m0k1d_rostpoliplast_backend_internal_storage.Bale'
produces:
- application/json
responses:
"200":
description: OK
schema:
$ref: '#/definitions/gitea_d3m0k1d_ru_d3m0k1d_rostpoliplast_backend_internal_storage.Bale'
summary: Обновить тюк
tags:
- bales
securityDefinitions:
Bearer:
description: Type "Bearer" followed by a space and the JWT token.
in: header
name: Authorization
type: apiKey
swagger: "2.0"