102 lines
2.6 KiB
YAML
102 lines
2.6 KiB
YAML
openapi: 3.0.3
|
|
info:
|
|
title: announcementService
|
|
description: Announcing patchnotes for KanzleiApp
|
|
version: 1.0.0
|
|
paths:
|
|
/patchnotes:
|
|
get:
|
|
tags:
|
|
- Patchnotes
|
|
description: returns list of all unseen Patch notes from the user
|
|
operationId: get_patchnotes
|
|
requestBody:
|
|
description: last seen patchnote by the user
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
title: date
|
|
type: string
|
|
responses:
|
|
"200":
|
|
content:
|
|
application/json:
|
|
schema:
|
|
items:
|
|
$ref: '#/components/schemas/patch_notes'
|
|
type: array
|
|
description: returns list of all unseen Patch notes from the user
|
|
"404":
|
|
description: no Patch notes found
|
|
"500":
|
|
description: Internal Server error, Failed to get Patch Notes
|
|
post:
|
|
tags:
|
|
- Patchnotes
|
|
description: creates new Patch notes
|
|
operationId: post_patchnotes
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/patch_notes'
|
|
responses:
|
|
"200":
|
|
description: game created
|
|
content:
|
|
application/json:
|
|
schema:
|
|
items:
|
|
$ref: '#/components/schemas/patch_notes'
|
|
/patchnotes/{patchID}:
|
|
delete:
|
|
tags:
|
|
- Patchnotes
|
|
description: deletes one Patch note
|
|
operationId: patch_note_delete
|
|
parameters:
|
|
- in: path
|
|
name: patchID
|
|
required: true
|
|
schema:
|
|
format: uuid
|
|
type: string
|
|
style: simple
|
|
responses:
|
|
"200":
|
|
description: patch successfully deleted
|
|
"404":
|
|
description: patch not found
|
|
"500":
|
|
description: Internal Server Error, Patch not deleted
|
|
components:
|
|
schemas:
|
|
patch_notes:
|
|
example:
|
|
patchID: 29e80bcc-5981-4a52-99e1-373442dea9b9
|
|
title: Patch note 1
|
|
changes: changes
|
|
date: date
|
|
properties:
|
|
patchID:
|
|
format: uuid
|
|
title: patchID
|
|
type: string
|
|
title:
|
|
type: string
|
|
title: title
|
|
changes:
|
|
type: string
|
|
title: changes
|
|
date:
|
|
title: date
|
|
type: string
|
|
user:
|
|
example:
|
|
lastNoteChecked: f00fa08d-0cd8-4c05-9409-5e75aa2d4f68
|
|
properties:
|
|
lastNoteChecked:
|
|
format: uuid
|
|
title: lastNoteChecked
|
|
type: string |