Infrastructure/logto
0
Fork 0
mirror of https://github.com/logto-io/logto.git synced 2025-02-17 22:04:19 -05:00
Code Issues Activity

chore(core): add domains api doc descriptions (#5036)

Browse source 
* chore(core): add domains api doc descriptions

* chore(core): polish docs

---------

Co-authored-by: Gao Sun <gao@silverhand.io>
This commit is contained in:
wangsijie 2023-12-02 16:39:43 +09:00 • committed by GitHub
parent fc9c9ea721
commit 484b52cb38
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 73 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

73
packages/core/src/routes/domain.openapi.json Normal file
View file

@ -0,0 +1,73 @@
{
"tags": [
{
"name": "Domains",
"description": "Custom domain lets you present a consistent brand by having your own domain name on the sign-in and registration pages. See [🌍 Custom domain](https://docs.logto.io/docs/recipes/custom-domain/) for more details."
}
],
"paths": {
"/api/domains": {
"get": {
"summary": "Get domains",
"description": "Get all of your custom domains.",
"parameters": [],
"responses": {
"200": {
"description": "A list of domains."
}
}
},
"post": {
"summary": "Create domain",
"description": "Create a new domain with the given data. The maximum domain number is 1, once created, can not be modified, you'll have to delete and recreate one.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"domain": {
"description": "The domain name, e.g. `example.com`."
}
}
}
}
}
},
"responses": {
"201": {
"description": "The domain was created successfully."
},
"422": {
"description": "Validation error. Please check the request body."
}
}
}
},
"/api/domains/{id}": {
"get": {
"summary": "Get domain",
"description": "Get domain details by ID, by calling this API, the domain status will be synced from remote provider.",
"responses": {
"200": {
"description": "Details of the domain."
},
"404": {
"description": "The domain with the specified ID was not found."
}
}
},
"delete": {
"summary": "Delete domain",
"description": "Delete domain by ID.",
"responses": {
"204": {
"description": "The domain was deleted successfully."
},
"404": {
"description": "The domain with the specified ID was not found."
}
}
}
}
}
}