Ad-Hoc-Email-Server/openapi.json at master · o4oren/Ad-Hoc-Email-Server · GitHub

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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
{
  "openapi": "3.0.0",
  "info": {
    "description": "This is the documentation for the [AHEM Ad Hoc Disposable Temporary Email service API](https://www.ahem.email).  AHEM is a free temp mail service that allows recieving of ad-hoc emails to a mailbox of your choice. No  registration or any other preparation is needed. Just send an email, and it's there.<br> Its simple and intuitive api makes it a perfect tool for testing and automation of any product that use email.",
    "version": "1.0.0",
    "title": "AHEM - Ad Hoc Email Service",
    "termsOfService": "https://www.ahem.email/privacy"
  },
  "servers": [
    {
      "url": "https://www.ahem.email/api"
    }
  ],
  "tags": [
    {
      "name": "properties",
      "description": "System global configuration properties"
    },
    {
      "name": "mailbox",
      "description": "An AHEM mailbox represents the prefix of the email address."
    },
    {
      "name": "store",
      "description": "Access to Petstore orders"
    },
    {
      "name": "user",
      "description": "Operations about user"
    }
  ],
  "paths": {
    "/properties": {
      "get": {
        "tags": [
          "properties"
        ],
        "summary": "System wide global properties",
        "operationId": "getProperties",
        "responses": {
          "200": {
            "description": "Sucessfully get properties object",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Properties"
                }
              }
            }
          },
          "500": {
            "description": "Something went wrong"
          }
        }
      }
    },
    "/mailbox/autocomplete": {
      "post": {
        "tags": [
          "mailbox"
        ],
        "summary": "Returns a list of mailboxs starting with the prefix string.",
        "operationId": "autoComplete",
        "responses": {
          "200": {
            "description": "Successfully fetched results",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/mailboxAutocomplete"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "token": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    },
    "schemas": {
      "Properties": {
        "type": "object",
        "properties": {
          "serverBaseUri": {
            "type": "string",
            "example": "https://www.ahem.email"
          },
          "emailDeleteInterval": {
            "type": "integer",
            "example": "3600"
          },
          "emailDeleteAge": {
            "type": "integer",
            "example": "7200"
          },
          "allowedDomains": {
            "type": "array",
            "items": {
              "type": "string",
              "example": [
                "ahem.email",
                "ahem-email.com"
              ]
            }
          },
          "customText": {
            "type": "string"
          },
          "allowAutocomplete": {
            "type": "boolean",
            "example": "false"
          }
        }
      },
      "mailboxAutocomplete": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "example": [
          "test",
          "test1"
        ]
      }
    }
  }
}