-
Notifications
You must be signed in to change notification settings - Fork 12
/
AccountLimit.yaml
104 lines (95 loc) · 2.69 KB
/
AccountLimit.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
openapi: 3.0.3
info:
title: I_AccountLimit_Service
description: Über diese Schnittstelle werden die Limits eines Nutzer-Accounts abgefragt
version: 1.1
### 1.1
# - changed version number in server url
# - removed quotation marks and added minimum value for maxMailSize
### 1.0.0
# - initial Version of I_AccountLimit_Service
externalDocs:
description: GitHub - Dokumentation
url: https://github.com/gematik/api-kim
servers:
- url: https://account-manager.hrst1.kim.telematik/AccountLimit/v1.1/
tags:
- name: AccountLimit
paths:
##--
##------
/limit:
get:
tags:
- AccountLimit
summary: Limits eines Accounts abgefragen
description: Gibt die Limits eines Accounts zurück
operationId: getLimits
security:
- basicAuth: []
responses:
200:
description: OK
# Rückgabe der Metadaten eines Nutzer-Accounts
content:
application/json:
schema:
$ref: '#/components/schemas/AccountLimit'
401:
description: Authentifizierung fehlgeschlagen
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
404:
description: Mail Account nicht vorhanden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
500:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
##--
##------
components:
schemas:
AccountLimit:
type: object
properties:
dataTimeToLive:
type: integer
maxLength: 3
minimum: 10
maximum: 365
default: 90
example: 90
description: Speicherdauer von Mails und Anhängen auf dem KAS Fachdienst/KAS. Angabe in Tagen
maxMailSize:
type: integer
format: int64
minimum: 524288000
example: 734003200
description: Setzt die maximale Größe einer KIM-Mail in Bytes
quota:
type: integer
format: int64
example: 160000000000
description: Gibt das maximale Speichervolumen für einen Nutzer-Account an
remainQuota:
type: integer
format: int64
example: 112000000000
description: Gibt das verbleibende Speichervolumen für einen Nutzer-Account an
Error:
type: object
properties:
message:
type: string
securitySchemes:
basicAuth:
type: http
scheme: basic