Gnous/mailcow
2
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

Add missing API endpoint to openapi.yaml

Browse Source
This commit is contained in:
Kristian Stöckel 2021-11-12 12:22:15 +01:00
parent 116c7919e3
commit 842cc4297a
No known key found for this signature in database
GPG Key ID: 3CE9C31E33083581
1 changed files with 106 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

149
data/web/api/openapi.yaml
View File

@ -131,6 +131,69 @@ paths:
type: boolean type: boolean
type: object type: object
summary: Create alias summary: Create alias
/api/v1/add/time_limited_alias:
post:
responses:
"401":
$ref: "#/components/responses/Unauthorized"
"200":
content:
application/json:
examples:
response:
value:
- log:
- mailbox
- add
- time_limited_alias
- address: info@domain.tld
domain: domain.tld
- null
msg:
- mailbox_modified
- info@domain.tld
type: success
schema:
properties:
log:
description: contains request object
items: {}
type: array
msg:
items: {}
type: array
type:
enum:
- success
- danger
- error
type: string
type: object
description: OK
headers: {}
tags:
- Aliases
description: >-
You may create a time limited alias using this action. It takes a JSON
object containing a domain and mailbox informations.
Mailcow will generate a random alias.
operationId: Create time limited alias
requestBody:
content:
application/json:
schema:
example:
username: info@domain.tld
domain: domain.tld
properties:
username:
description: 'the mailbox an alias should be created for'
type: string
domain:
description: "the domain"
type: string
type: object
summary: Create time limited alias
/api/v1/add/app-passwd: /api/v1/add/app-passwd:
post: post:
responses: responses:
@ -618,31 +681,31 @@ paths:
value: value:
- type: success - type: success
log: log:
- acl - acl
- edit - edit
- testadmin
- username:
- testadmin - testadmin
da_acl: - username:
- syncjobs - testadmin
- quarantine da_acl:
- login_as - syncjobs
- sogo_access - quarantine
- app_passwds - login_as
- bcc_maps - sogo_access
- pushover - app_passwds
- filters - bcc_maps
- ratelimit - pushover
- spam_policy - filters
- extend_sender_acl - ratelimit
- unlimited_quota - spam_policy
- protocol_access - extend_sender_acl
- smtp_ip_access - unlimited_quota
- alias_domains - protocol_access
- domain_desc - smtp_ip_access
- alias_domains
- domain_desc
msg: msg:
- acl_saved - acl_saved
- testadmin - testadmin
schema: schema:
properties: properties:
log: log:
@ -674,25 +737,25 @@ paths:
schema: schema:
example: example:
items: items:
- testadmin - testadmin
attr: attr:
da_acl: da_acl:
- syncjobs - syncjobs
- quarantine - quarantine
- login_as - login_as
- sogo_access - sogo_access
- app_passwds - app_passwds
- bcc_maps - bcc_maps
- pushover - pushover
- filters - filters
- ratelimit - ratelimit
- spam_policy - spam_policy
- extend_sender_acl - extend_sender_acl
- unlimited_quota - unlimited_quota
- protocol_access - protocol_access
- smtp_ip_access - smtp_ip_access
- alias_domains - alias_domains
- domain_desc - domain_desc
properties: properties:
items: items:
description: contains the domain admin username you want to edit description: contains the domain admin username you want to edit
@ -759,11 +822,11 @@ paths:
schema: schema:
example: example:
items: items:
- testadmin - testadmin
attr: attr:
active: active:
- '0' - '0'
- '1' - '1'
username_new: testadmin username_new: testadmin
domains: ["domain.tld"] domains: ["domain.tld"]
password: supersecurepassword password: supersecurepassword