Skip to content

update package version and response return tyupe for delete domain api #272

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 10, 2025
Merged

update package version and response return tyupe for delete domain api #272

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ed89398
update package version and response return tyupe for delete domain api
KMKoushik Oct 10, 2025
d2efb3f
update package version and response return tyupe for delete domain api
KMKoushik Oct 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
183 changes: 43 additions & 140 deletions apps/docs/api-reference/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -626,10 +626,10 @@
{
"schema": {
"type": "number",
"nullable": false,
"nullable": true,
"example": 1
},
"required": true,
"required": false,
Copy link

@cubic-dev-ai cubic-dev-ai bot Oct 10, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Path parameters that appear in the URL template must remain required—setting id to optional makes the specification invalid for /v1/domains/{id}. Please keep the path parameter required so generated clients and validators work correctly.

Prompt for AI agents 
Address the following comment on apps/docs/api-reference/openapi.json at line 632:

<comment>Path parameters that appear in the URL template must remain required—setting `id` to optional makes the specification invalid for `/v1/domains/{id}`. Please keep the path parameter required so generated clients and validators work correctly.</comment>

<file context>
@@ -626,10 +626,10 @@
               &quot;example&quot;: 1
             },
-            &quot;required&quot;: true,
+            &quot;required&quot;: false,
             &quot;name&quot;: &quot;id&quot;,
             &quot;in&quot;: &quot;path&quot;
</file context>
Suggested change
"required": false,
"required": true,
Fix with Cubic

"name": "id",
"in": "path"
}
Expand All @@ -643,152 +643,55 @@
"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
"type": "number"
},
"openTracking": {
"type": "boolean",
"default": false
"success": {
"type": "boolean"
},
"publicKey": {
"message": {
"type": "string"
},
"dkimStatus": {
"type": "string",
"nullable": true
},
"spfDetails": {
"type": "string",
"nullable": true
},
"createdAt": {
}
},
"required": [
"id",
"success",
"message"
]
}
}
}
},
"403": {
"description": "Forbidden - API key doesn't have access",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"updatedAt": {
}
},
"required": [
"error"
]
}
}
}
},
"404": {
"description": "Domain not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"dmarcAdded": {
"type": "boolean",
"default": false
},
"isVerifying": {
"type": "boolean",
"default": false
},
"errorMessage": {
"type": "string",
"nullable": true
},
"subdomain": {
"type": "string",
"nullable": true
},
"verificationError": {
"type": "string",
"nullable": true
},
"lastCheckedTime": {
"type": "string",
"nullable": true
},
"dnsRecords": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"MX",
"TXT"
],
"description": "DNS record type",
"example": "TXT"
},
"name": {
"type": "string",
"description": "DNS record name",
"example": "mail"
},
"value": {
"type": "string",
"description": "DNS record value",
"example": "v=spf1 include:amazonses.com ~all"
},
"ttl": {
"type": "string",
"description": "DNS record TTL",
"example": "Auto"
},
"priority": {
"type": "string",
"nullable": true,
"description": "DNS record priority",
"example": "10"
},
"status": {
"type": "string",
"enum": [
"NOT_STARTED",
"PENDING",
"SUCCESS",
"FAILED",
"TEMPORARY_FAILURE"
]
},
"recommended": {
"type": "boolean",
"description": "Whether the record is recommended"
}
},
"required": [
"type",
"name",
"value",
"ttl",
"status"
]
}
}
},
"required": [
"id",
"name",
"teamId",
"status",
"publicKey",
"createdAt",
"updatedAt",
"dnsRecords"
"error"
]
}
}
Expand Down
31 changes: 8 additions & 23 deletions apps/docs/docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,23 +34,15 @@
},
{
"group": "Self Hosting",
"pages": [
"self-hosting/overview",
"self-hosting/railway"
]
"pages": ["self-hosting/overview", "self-hosting/railway"]
},
{
"group": "Guides",
"pages": [
"guides/use-with-react-email"
]
"pages": ["guides/use-with-react-email"]
},
{
"group": "Community SDKs",
"pages": [
"community-sdk/python",
"community-sdk/go"
]
"pages": ["community-sdk/python", "community-sdk/go"]
}
]
},
Expand All @@ -59,9 +51,7 @@
"groups": [
{
"group": "API Reference",
"pages": [
"api-reference/introduction"
]
"pages": ["api-reference/introduction"]
},
{
"group": "Emails",
Expand Down Expand Up @@ -91,7 +81,8 @@
"api-reference/domains/get-domain",
"api-reference/domains/list-domains",
"api-reference/domains/create-domain",
"api-reference/domains/verify-domain"
"api-reference/domains/verify-domain",
"api-reference/domains/delete-domain"
]
}
]
Expand Down Expand Up @@ -147,12 +138,6 @@
}
},
"contextual": {
"options": [
"copy",
"view",
"chatgpt",
"claude",
"perplexity"
]
"options": ["copy", "view", "chatgpt", "claude", "perplexity"]
}
}
}
Loading