gib/GibSend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add basic documentation (#14)

Browse Source 
* Docs MVP

* Change to mintlify

* Add more docs

* Init docs
This commit is contained in:
KM Koushik
2024-05-21 20:51:53 +10:00
committed by GitHub
parent 052c29a515
commit b9643f41e1
16 changed files with 6323 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

280
apps/docs/api-reference/openapi.json Normal file
View File

@@ -0,0 +1,280 @@
{
"openapi": "3.0.0",
"info": {
"version": "1.0.0",
"title": "Unsend API"
},
"servers": [
{
"url": "https://app.unsend.dev/api"
}
],
"components": {
"securitySchemes": {
"Bearer": {
"type": "http",
"scheme": "bearer"
}
},
"schemas": {},
"parameters": {}
},
"paths": {
"/v1/domains": {
"get": {
"responses": {
"200": {
"description": "Retrieve the user",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"description": "The ID of the domain",
"example": 1
},
"name": {
"type": "string",
"description": "The name of the domain",
"example": "example.com"
},
"teamId": {
"type": "number",
"description": "The ID of the team",
"example": 1
},
"status": {
"type": "string",
"enum": [
"NOT_STARTED",
"PENDING",
"SUCCESS",
"FAILED",
"TEMPORARY_FAILURE"
]
},
"region": {
"type": "string",
"default": "us-east-1"
},
"clickTracking": {
"type": "boolean",
"default": false
},
"openTracking": {
"type": "boolean",
"default": false
},
"publicKey": {
"type": "string"
},
"dkimStatus": {
"type": "string",
"nullable": true
},
"spfDetails": {
"type": "string",
"nullable": true
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"required": [
"id",
"name",
"teamId",
"status",
"publicKey",
"createdAt",
"updatedAt"
]
}
}
}
}
}
}
}
},
"/v1/emails/{emailId}": {
"get": {
"responses": {
"200": {
"description": "Retrieve the user",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"teamId": {
"type": "number"
},
"to": {
"type": "string"
},
"from": {
"type": "string"
},
"subject": {
"type": "string"
},
"html": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"createdAt": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"emailEvents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"emailId": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"QUEUED",
"SENT",
"OPENED",
"CLICKED",
"BOUNCED",
"COMPLAINED",
"DELIVERED",
"REJECTED",
"RENDERING_FAILURE",
"DELIVERY_DELAYED"
]
},
"createdAt": {
"type": "string"
},
"data": {
"nullable": true
}
},
"required": [
"emailId",
"status",
"createdAt"
]
}
}
},
"required": [
"id",
"teamId",
"to",
"from",
"subject",
"html",
"text",
"createdAt",
"updatedAt",
"emailEvents"
]
}
}
}
}
}
}
},
"/v1/emails": {
"post": {
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"to": {
"type": "string",
"format": "email"
},
"from": {
"type": "string",
"format": "email"
},
"subject": {
"type": "string"
},
"replyTo": {
"type": "string"
},
"text": {
"type": "string"
},
"html": {
"type": "string"
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"filename": {
"type": "string"
},
"content": {
"type": "string"
}
},
"required": [
"filename",
"content"
]
}
}
},
"required": [
"to",
"from",
"subject"
]
}
}
}
},
"responses": {
"200": {
"description": "Retrieve the user",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"emailId": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
}