2021-11-23 18:38:08 +01:00

125 lines
3.6 KiB
YAML

openapi: 3.0.0
info:
title: Generic Database API Service
version: "0.0.2"
paths:
/pdb/v2/test1:
get:
tags: [ "Regular" ]
operationId: Regular.test1all
summary: Returns all entries from table test1
responses:
200:
description: Here are your test1 items
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/test1"
404:
description: No test1 items available
# post:
# tags: [ "Regular" ]
# operationId: Regular.test1insert
# summary: Inserts an item into table test1
# requestBody:
# description: test1
# content:
# application/json:
# schema:
# $ref: "#/components/schemas/test1"
# responses:
# 201:
# description: Your items has been inserted
/pdb/v2/test1/{id}:
get:
tags: [ "Regular" ]
operationId: Regular.test1byid
summary: Returns one entry from table test1 by id
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
200:
description: Here is your test1 item
content:
application/json:
schema:
$ref: "#/components/schemas/test1"
404:
description: No such test1 item available
/pdb/v2/test1/specificSelectName:
get:
tags: [ "Regular" ]
operationId: Regular.test1specificSelectName
summary: Returns entries from table test1 using a dedicated select statement
description:
STATEMENTBEGIN
select txt
from test1
where nr = ?
STATEMENTEND
INPUTMAPPINGBEGIN
nr = Nummer
INPUTMAPPINGEND
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod
tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At
vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren,
no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet,
consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et
dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo
dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem
ipsum dolor sit amet.
requestBody:
description: specificSelectNameType
content:
application/json:
schema:
$ref: "#/components/schemas/specificSelectNameType"
responses:
200:
description: Here are your test1 items
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/specificResultType"
404:
description: No such test1 item available
components:
schemas:
test1:
description: A test1 item
type: object
required:
- id
properties:
id:
type: integer
txt:
type: string
nr:
type: integer
specificSelectNameType:
description: Specific type to defintion select condition
type: object
required:
- nr
properties:
nr:
type: integer
specificResultType:
description: Specific result type to defintion select clause
type: object
properties:
txt:
type: string