Skip to content

Commit 2fe2d5c

Browse files
KMKoushikKMKoushik
authored
update package version and response return tyupe for delete domain api (#272)
1 parent 3f6a02a commit 2fe2d5c

File tree

8 files changed

+138
-302
lines changed

8 files changed

+138
-302
lines changed

‎apps/docs/api-reference/openapi.json‎

Lines changed: 43 additions & 140 deletions
Original file line numberDiff line numberDiff line change
@@ -626,10 +626,10 @@
626626
{
627627
"schema": {
628628
"type": "number",
629-
"nullable": false,
629+
"nullable": true,
630630
"example": 1
631631
},
632-
"required": true,
632+
"required": false,
633633
"name": "id",
634634
"in": "path"
635635
}
@@ -643,152 +643,55 @@
643643
"type": "object",
644644
"properties": {
645645
"id": {
646-
"type": "number",
647-
"description": "The ID of the domain",
648-
"example": 1
649-
},
650-
"name": {
651-
"type": "string",
652-
"description": "The name of the domain",
653-
"example": "example.com"
654-
},
655-
"teamId": {
656-
"type": "number",
657-
"description": "The ID of the team",
658-
"example": 1
659-
},
660-
"status": {
661-
"type": "string",
662-
"enum": [
663-
"NOT_STARTED",
664-
"PENDING",
665-
"SUCCESS",
666-
"FAILED",
667-
"TEMPORARY_FAILURE"
668-
]
669-
},
670-
"region": {
671-
"type": "string",
672-
"default": "us-east-1"
673-
},
674-
"clickTracking": {
675-
"type": "boolean",
676-
"default": false
646+
"type": "number"
677647
},
678-
"openTracking": {
679-
"type": "boolean",
680-
"default": false
648+
"success": {
649+
"type": "boolean"
681650
},
682-
"publicKey": {
651+
"message": {
683652
"type": "string"
684-
},
685-
"dkimStatus": {
686-
"type": "string",
687-
"nullable": true
688-
},
689-
"spfDetails": {
690-
"type": "string",
691-
"nullable": true
692-
},
693-
"createdAt": {
653+
}
654+
},
655+
"required": [
656+
"id",
657+
"success",
658+
"message"
659+
]
660+
}
661+
}
662+
}
663+
},
664+
"403": {
665+
"description": "Forbidden - API key doesn't have access",
666+
"content": {
667+
"application/json": {
668+
"schema": {
669+
"type": "object",
670+
"properties": {
671+
"error": {
694672
"type": "string"
695-
},
696-
"updatedAt": {
673+
}
674+
},
675+
"required": [
676+
"error"
677+
]
678+
}
679+
}
680+
}
681+
},
682+
"404": {
683+
"description": "Domain not found",
684+
"content": {
685+
"application/json": {
686+
"schema": {
687+
"type": "object",
688+
"properties": {
689+
"error": {
697690
"type": "string"
698-
},
699-
"dmarcAdded": {
700-
"type": "boolean",
701-
"default": false
702-
},
703-
"isVerifying": {
704-
"type": "boolean",
705-
"default": false
706-
},
707-
"errorMessage": {
708-
"type": "string",
709-
"nullable": true
710-
},
711-
"subdomain": {
712-
"type": "string",
713-
"nullable": true
714-
},
715-
"verificationError": {
716-
"type": "string",
717-
"nullable": true
718-
},
719-
"lastCheckedTime": {
720-
"type": "string",
721-
"nullable": true
722-
},
723-
"dnsRecords": {
724-
"type": "array",
725-
"items": {
726-
"type": "object",
727-
"properties": {
728-
"type": {
729-
"type": "string",
730-
"enum": [
731-
"MX",
732-
"TXT"
733-
],
734-
"description": "DNS record type",
735-
"example": "TXT"
736-
},
737-
"name": {
738-
"type": "string",
739-
"description": "DNS record name",
740-
"example": "mail"
741-
},
742-
"value": {
743-
"type": "string",
744-
"description": "DNS record value",
745-
"example": "v=spf1 include:amazonses.com ~all"
746-
},
747-
"ttl": {
748-
"type": "string",
749-
"description": "DNS record TTL",
750-
"example": "Auto"
751-
},
752-
"priority": {
753-
"type": "string",
754-
"nullable": true,
755-
"description": "DNS record priority",
756-
"example": "10"
757-
},
758-
"status": {
759-
"type": "string",
760-
"enum": [
761-
"NOT_STARTED",
762-
"PENDING",
763-
"SUCCESS",
764-
"FAILED",
765-
"TEMPORARY_FAILURE"
766-
]
767-
},
768-
"recommended": {
769-
"type": "boolean",
770-
"description": "Whether the record is recommended"
771-
}
772-
},
773-
"required": [
774-
"type",
775-
"name",
776-
"value",
777-
"ttl",
778-
"status"
779-
]
780-
}
781691
}
782692
},
783693
"required": [
784-
"id",
785-
"name",
786-
"teamId",
787-
"status",
788-
"publicKey",
789-
"createdAt",
790-
"updatedAt",
791-
"dnsRecords"
694+
"error"
792695
]
793696
}
794697
}

‎apps/docs/docs.json‎

Lines changed: 8 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -34,23 +34,15 @@
3434
},
3535
{
3636
"group": "Self Hosting",
37-
"pages": [
38-
"self-hosting/overview",
39-
"self-hosting/railway"
40-
]
37+
"pages": ["self-hosting/overview", "self-hosting/railway"]
4138
},
4239
{
4340
"group": "Guides",
44-
"pages": [
45-
"guides/use-with-react-email"
46-
]
41+
"pages": ["guides/use-with-react-email"]
4742
},
4843
{
4944
"group": "Community SDKs",
50-
"pages": [
51-
"community-sdk/python",
52-
"community-sdk/go"
53-
]
45+
"pages": ["community-sdk/python", "community-sdk/go"]
5446
}
5547
]
5648
},
@@ -59,9 +51,7 @@
5951
"groups": [
6052
{
6153
"group": "API Reference",
62-
"pages": [
63-
"api-reference/introduction"
64-
]
54+
"pages": ["api-reference/introduction"]
6555
},
6656
{
6757
"group": "Emails",
@@ -91,7 +81,8 @@
9181
"api-reference/domains/get-domain",
9282
"api-reference/domains/list-domains",
9383
"api-reference/domains/create-domain",
94-
"api-reference/domains/verify-domain"
84+
"api-reference/domains/verify-domain",
85+
"api-reference/domains/delete-domain"
9586
]
9687
}
9788
]
@@ -147,12 +138,6 @@
147138
}
148139
},
149140
"contextual": {
150-
"options": [
151-
"copy",
152-
"view",
153-
"chatgpt",
154-
"claude",
155-
"perplexity"
156-
]
141+
"options": ["copy", "view", "chatgpt", "claude", "perplexity"]
157142
}
158-
}
143+
}

0 commit comments

Comments
 (0)