document-server/docs/swagger.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:
      name:
        type: string
      parent_group:
        properties:
          name:
            type: string
        required:
        - name
        type: object
    required:
    - 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:
    email: info@odit.services
    name: ODIT.Services UG (haftungsbeschränkt)
    url: https://odit.services
  description: This is the API documentation for the LfK Document Server - a tool
    for pdf generation.
  license:
    name: CC BY-NC-SA 4.0
  termsOfService: https://lauf-fuer-kaya.de/datenschutz
  title: LfK Document Server API
paths:
  /v1/barcodes/{type}/{content}:
    get:
      description: Generate barcodes based on the provided data
      parameters:
      - description: Barcode type
        enum:
        - ean13
        - code128
        in: path
        name: type
        required: true
        type: string
      - description: Barcode content
        in: path
        minLength: 1
        name: content
        required: true
        type: string
      - default: 1000
        description: Barcode width
        in: query
        maximum: 10000
        minimum: 1
        name: width
        type: integer
      - default: 1000
        description: Barcode height
        in: query
        maximum: 10000
        minimum: 1
        name: height
        type: integer
      - default: 10
        description: Padding around the barcode (included in image size)
        in: query
        maximum: 100
        minimum: 0
        name: padding
        type: integer
      produces:
      - image/png
      responses: {}
      summary: Generate barcodes
      tags:
      - barcodes
  /v1/pdfs/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: {}
      security:
      - ApiKeyAuth: []
      summary: Generate runner cards
      tags:
      - pdfs
  /v1/pdfs/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: {}
      security:
      - ApiKeyAuth: []
      summary: Generate runner certificates
      tags:
      - pdfs
  /v1/pdfs/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: {}
      security:
      - ApiKeyAuth: []
      summary: Generate a contract
      tags:
      - pdfs
securityDefinitions:
  ApiKeyAuth:
    in: query
    name: key
    type: apiKey
swagger: "2.0"