161 lines
4.1 KiB
YAML
161 lines
4.1 KiB
YAML
openapi: 3.0.3
|
|
info:
|
|
description: Announcing patchnotes for KanzleiApp
|
|
title: announcementService
|
|
version: 1.0.0
|
|
servers:
|
|
- url: /
|
|
paths:
|
|
/patchnotes:
|
|
get:
|
|
description: returns list of all Patch notes
|
|
operationId: patchnotes_get
|
|
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
|
|
tags:
|
|
- Patchnotes
|
|
x-openapi-router-controller: openapi_server.controllers.patchnotes_controller
|
|
post:
|
|
description: creates new Patch notes
|
|
operationId: patchnotes_post
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/patch_notes'
|
|
responses:
|
|
"200":
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/patch_notes'
|
|
description: game created
|
|
"400":
|
|
description: bad payload
|
|
tags:
|
|
- Patchnotes
|
|
x-openapi-router-controller: openapi_server.controllers.patchnotes_controller
|
|
/patchnotes/{date}:
|
|
get:
|
|
description: returns list of all unseen Patch notes from the user
|
|
operationId: patchnotes_date_get
|
|
parameters:
|
|
- example: 2025-01-02
|
|
explode: false
|
|
in: path
|
|
name: date
|
|
required: true
|
|
schema:
|
|
format: date
|
|
type: string
|
|
style: simple
|
|
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
|
|
tags:
|
|
- Patchnotes
|
|
x-openapi-router-controller: openapi_server.controllers.patchnotes_controller
|
|
/patchnotes/{patchID}:
|
|
delete:
|
|
description: deletes one Patch note
|
|
operationId: patchnotes_patch_iddelete
|
|
parameters:
|
|
- explode: false
|
|
in: path
|
|
name: patchID
|
|
required: true
|
|
schema:
|
|
format: uuid
|
|
type: string
|
|
style: simple
|
|
responses:
|
|
"200":
|
|
description: patch successfully deleted
|
|
"404":
|
|
description: patch not found
|
|
tags:
|
|
- Patchnotes
|
|
x-openapi-router-controller: openapi_server.controllers.patchnotes_controller
|
|
put:
|
|
description: Updates one Patch
|
|
operationId: patchnotes_patch_idput
|
|
parameters:
|
|
- explode: false
|
|
in: path
|
|
name: patchID
|
|
required: true
|
|
schema:
|
|
format: uuid
|
|
type: string
|
|
style: simple
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/patch_notes'
|
|
responses:
|
|
"200":
|
|
description: patch updated
|
|
"404":
|
|
description: no patch found
|
|
tags:
|
|
- Patchnotes
|
|
x-openapi-router-controller: openapi_server.controllers.patchnotes_controller
|
|
components:
|
|
schemas:
|
|
patch_notes:
|
|
example:
|
|
patchID: 29e80bcc-5981-4a52-99e1-373442dea9b9
|
|
title: Patch note 1
|
|
changes: changes
|
|
version: 1.0.0
|
|
date: 2025-01-02
|
|
properties:
|
|
patchID:
|
|
format: uuid
|
|
title: patchID
|
|
type: string
|
|
title:
|
|
title: title
|
|
type: string
|
|
changes:
|
|
title: changes
|
|
type: string
|
|
version:
|
|
title: version
|
|
type: string
|
|
patch_date:
|
|
title: patch_date
|
|
type: string
|
|
required:
|
|
- changes
|
|
- patch_date
|
|
- title
|
|
- version
|
|
title: patch_notes
|
|
user:
|
|
example:
|
|
lastSeenDate: 2025-01-02
|
|
properties:
|
|
lastSeenDate:
|
|
format: date
|
|
title: lastNoteChecked
|
|
type: string
|