document-server/docs/swagger.yaml

61 lines
1.3 KiB
YAML

definitions:
models.Contract:
properties:
locale:
enum:
- en
- de
type: string
runners:
items:
$ref: '#/definitions/models.Runner'
type: array
type: object
models.Group:
properties:
id:
type: integer
name:
type: string
parent_group:
$ref: '#/definitions/models.Group'
type: object
models.Runner:
properties:
first_name:
type: string
group:
$ref: '#/definitions/models.Group'
id:
type: integer
last_name:
type: string
middle_name:
type: string
type: object
info:
contact: {}
description: This is the API documentation for the LfK Document Server - a tool
for pdf generation.
title: LfK Document Server API
paths:
/contracts:
post:
consumes:
- application/json
description: Generate a contract based on the provided data
parameters:
- description: Contract data
in: body
name: data
required: true
schema:
$ref: '#/definitions/models.Contract'
produces:
- application/pdf
responses: {}
summary: Generate a contract
tags:
- contracts
swagger: "2.0"