215 lines
4.2 KiB
YAML
215 lines
4.2 KiB
YAML
definitions:
|
|
models.Card:
|
|
properties:
|
|
code:
|
|
type: string
|
|
enabled:
|
|
default: true
|
|
type: boolean
|
|
id:
|
|
type: integer
|
|
runner:
|
|
$ref: '#/definitions/models.Runner'
|
|
required:
|
|
- code
|
|
- id
|
|
- runner
|
|
type: object
|
|
models.CardRequest:
|
|
properties:
|
|
cards:
|
|
items:
|
|
$ref: '#/definitions/models.Card'
|
|
type: array
|
|
locale:
|
|
enum:
|
|
- en
|
|
- de
|
|
type: string
|
|
required:
|
|
- cards
|
|
- locale
|
|
type: object
|
|
models.CertificateRequest:
|
|
properties:
|
|
locale:
|
|
enum:
|
|
- en
|
|
- de
|
|
type: string
|
|
runners:
|
|
items:
|
|
$ref: '#/definitions/models.RunnerWithDonations'
|
|
type: array
|
|
required:
|
|
- locale
|
|
- runners
|
|
type: object
|
|
models.ContractRequest:
|
|
properties:
|
|
locale:
|
|
enum:
|
|
- en
|
|
- de
|
|
type: string
|
|
runners:
|
|
items:
|
|
$ref: '#/definitions/models.Runner'
|
|
type: array
|
|
required:
|
|
- locale
|
|
- runners
|
|
type: object
|
|
models.DistanceDonation:
|
|
properties:
|
|
amount:
|
|
type: integer
|
|
amount_per_distance:
|
|
type: integer
|
|
donor:
|
|
$ref: '#/definitions/models.Donor'
|
|
id:
|
|
type: integer
|
|
paid_amount:
|
|
type: integer
|
|
required:
|
|
- amount_per_distance
|
|
- donor
|
|
- id
|
|
type: object
|
|
models.Donor:
|
|
properties:
|
|
first_name:
|
|
type: string
|
|
id:
|
|
type: integer
|
|
last_name:
|
|
type: string
|
|
middle_name:
|
|
type: string
|
|
required:
|
|
- first_name
|
|
- id
|
|
- last_name
|
|
type: object
|
|
models.Group:
|
|
properties:
|
|
id:
|
|
type: integer
|
|
name:
|
|
type: string
|
|
parent_group:
|
|
$ref: '#/definitions/models.Group'
|
|
required:
|
|
- id
|
|
- name
|
|
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
|
|
required:
|
|
- first_name
|
|
- group
|
|
- id
|
|
- last_name
|
|
type: object
|
|
models.RunnerWithDonations:
|
|
properties:
|
|
distance:
|
|
type: integer
|
|
distance_donations:
|
|
items:
|
|
$ref: '#/definitions/models.DistanceDonation'
|
|
type: array
|
|
first_name:
|
|
type: string
|
|
group:
|
|
$ref: '#/definitions/models.Group'
|
|
id:
|
|
type: integer
|
|
last_name:
|
|
type: string
|
|
middle_name:
|
|
type: string
|
|
total_donations:
|
|
type: integer
|
|
total_per_distance:
|
|
type: integer
|
|
required:
|
|
- distance
|
|
- first_name
|
|
- group
|
|
- id
|
|
- last_name
|
|
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:
|
|
/cards:
|
|
post:
|
|
consumes:
|
|
- application/json
|
|
description: Generate cards based on the provided data
|
|
parameters:
|
|
- description: Card data
|
|
in: body
|
|
name: data
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/models.CardRequest'
|
|
produces:
|
|
- application/pdf
|
|
responses: {}
|
|
summary: Generate runner cards
|
|
tags:
|
|
- cards
|
|
/certificates:
|
|
post:
|
|
consumes:
|
|
- application/json
|
|
description: Generate certificates based on the provided data
|
|
parameters:
|
|
- description: Certificate data
|
|
in: body
|
|
name: data
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/models.CertificateRequest'
|
|
produces:
|
|
- application/pdf
|
|
responses: {}
|
|
summary: Generate runner certificates
|
|
tags:
|
|
- certificates
|
|
/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.ContractRequest'
|
|
produces:
|
|
- application/pdf
|
|
responses: {}
|
|
summary: Generate a contract
|
|
tags:
|
|
- contracts
|
|
swagger: "2.0"
|