forked from WEB-IMB-WS2526/lab-development-imb
86 lines
1.7 KiB
YAML
86 lines
1.7 KiB
YAML
openapi: 3.0.x
|
|
info:
|
|
title: Wichteln
|
|
version: 1.0.0
|
|
description: API für Wichtelaktion
|
|
servers:
|
|
- url: http://localhost:8080
|
|
paths:
|
|
/wichtelaktion:
|
|
post:
|
|
summary: Aktion anlegen
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
adminEmail:
|
|
type: string
|
|
format: email
|
|
startDate:
|
|
type: string
|
|
format: date
|
|
endDate:
|
|
type: string
|
|
format: date
|
|
required:
|
|
- name
|
|
- adminEmail
|
|
- startDate
|
|
- endDate
|
|
responses:
|
|
'200':
|
|
description: Aktion erfolgreich erstellt
|
|
'400':
|
|
description: Aktion konnte nicht erstellt werden
|
|
/wichtelaktion/{id}/invite:
|
|
post:
|
|
summary: Teilnehmer einladen und Tokens generieren
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
emails:
|
|
type: array
|
|
items:
|
|
type: string
|
|
reqired:
|
|
- emails
|
|
responses:
|
|
'200':
|
|
description: Teilnehmer erfolgreich eingeladen
|
|
'400':
|
|
description: Teilnehmer konnten nicht eingeladen werden
|
|
/wichtelaktion/{id}/:
|
|
put:
|
|
summary: Wichtelaktion bearbeiten
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: string
|
|
responseBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
|
|
|
|
|
|
|
|
|