-
Notifications
You must be signed in to change notification settings - Fork 12
/
email-api-spec.yaml
90 lines (77 loc) · 2.41 KB
/
email-api-spec.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
swagger: '2.0'
info:
title: Opwen Cloudserver Email API.
version: '0.1'
basePath: '/api/email'
paths:
'/sendgrid/{client_id}':
post:
operationId: opwen_email_server.api.email_receive.receive
summary: Webhook listening to emails received via Sendgrid.
consumes:
- multipart/form-data
parameters:
- $ref: '#/parameters/ClientId'
- name: email
description: Email represented as a MIME string.
type: string
in: formData
required: true
responses:
200:
description: The email was successfully received. No need to retry it.
403:
description: Request from unregistered client.
'/upload/{client_id}':
post:
operationId: opwen_email_server.api.client_write.upload
summary: Endpoint where Lokole clients notify the server that they wish to send/upload some emails.
consumes:
- application/json
parameters:
- $ref: '#/parameters/ClientId'
- name: upload_info
in: body
required: true
schema:
$ref: '#/definitions/EmailPackage'
responses:
200:
description: The emails were successfully uploaded from the Lokole.
403:
description: Request from unregistered client.
'/download/{client_id}':
get:
operationId: opwen_email_server.api.client_read.download
summary: Endpoint that the Lokole clients call to get their new emails from the server.
produces:
- application/json
parameters:
- $ref: '#/parameters/ClientId'
responses:
200:
description: The emails for the Lokole are ready to be downloaded.
schema:
$ref: '#/definitions/EmailPackage'
403:
description: Request from unregistered client.
parameters:
ClientId:
name: client_id
in: path
required: true
description: Id of the Lokole client.
type: string
definitions:
EmailPackage:
properties:
resource_id:
description: Id of the resource containing the emails (gzip jsonl file).
type: string
resource_container:
description: Container where the resource containing emails can be found.
type: string
resource_type:
description: The provider where the resource containing emails can be found.
type: string
enum: [ 'azure-blob' ]