Add missing API endpoint to openapi.yaml
This commit is contained in:
		
							parent
							
								
									116c7919e3
								
							
						
					
					
						commit
						842cc4297a
					
				| @ -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: | ||||||
|  | |||||||
		Loading…
	
		Reference in New Issue
	
	Block a user
	 Kristian Stöckel
						Kristian Stöckel