1
0

api-definition subdirectories rbac+test

This commit is contained in:
Michael Hoennig
2022-09-02 13:11:15 +02:00
parent 3541b0c48c
commit cd9be1db75
38 changed files with 373 additions and 329 deletions

View File

@@ -0,0 +1,56 @@
get:
summary: Returns a list of (optionally filtered) customers.
description: Returns the list of (optionally filtered) customers which are visible to the current user or any of it's assumed roles.
tags:
- testCustomers
operationId: listCustomers
parameters:
- $ref: './auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles'
- name: prefix
in: query
required: false
schema:
type: string
description: Customer-prefix to filter the results.
responses:
"200":
description: OK
content:
'application/json':
schema:
type: array
items:
$ref: './test-customer-schemas.yaml#/components/schemas/TestCustomer'
"401":
$ref: './error-responses.yaml#/components/responses/Unauthorized'
"403":
$ref: './error-responses.yaml#/components/responses/Forbidden'
post:
summary: Adds a new customer.
tags:
- testCustomers
operationId: addCustomer
parameters:
- $ref: './auth.yaml#/components/parameters/currentUser'
- $ref: './auth.yaml#/components/parameters/assumedRoles'
requestBody:
content:
'application/json':
schema:
$ref: './test-customer-schemas.yaml#/components/schemas/TestCustomer'
required: true
responses:
"201":
description: Created
content:
'application/json':
schema:
$ref: './test-customer-schemas.yaml#/components/schemas/TestCustomer'
"401":
$ref: './error-responses.yaml#/components/responses/Unauthorized'
"403":
$ref: './error-responses.yaml#/components/responses/Forbidden'
"409":
$ref: './error-responses.yaml#/components/responses/Conflict'