mirror of
https://github.com/logto-io/logto.git
synced 2025-04-07 23:01:25 -05:00
chore(core): update description
This commit is contained in:
parent
22e6c9d99e
commit
86f4860a03
8 changed files with 23 additions and 23 deletions
|
@ -8,7 +8,7 @@
|
|||
}
|
||||
},
|
||||
"summary": "Get user's MFA verifications",
|
||||
"description": "Get a user's existing MFA verifications for a given user ID"
|
||||
"description": "Get a user's existing MFA verifications for a given user ID."
|
||||
},
|
||||
"post": {
|
||||
"requestBody": {
|
||||
|
@ -30,7 +30,7 @@
|
|||
}
|
||||
},
|
||||
"summary": "Create an MFA verification for a user",
|
||||
"description": "Create a new MFA verification for a given user ID"
|
||||
"description": "Create a new MFA verification for a given user ID."
|
||||
}
|
||||
},
|
||||
"/api/users/{userId}/mfa-verifications/{verificationId}": {
|
||||
|
|
|
@ -39,7 +39,7 @@
|
|||
"/api/applications/{id}": {
|
||||
"get": {
|
||||
"summary": "Get application",
|
||||
"description": "Get application details.",
|
||||
"description": "Get application details by ID.",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Details of the application."
|
||||
|
@ -51,7 +51,7 @@
|
|||
},
|
||||
"patch": {
|
||||
"summary": "Update application",
|
||||
"description": "Update application details with the given data.",
|
||||
"description": "Update application details by ID with the given data.",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
|
@ -82,7 +82,7 @@
|
|||
},
|
||||
"delete": {
|
||||
"summary": "Delete application",
|
||||
"description": "Delete application.",
|
||||
"description": "Delete application by ID.",
|
||||
"responses": {
|
||||
"204": {
|
||||
"description": "The application was deleted successfully."
|
||||
|
|
|
@ -57,7 +57,7 @@
|
|||
"/api/hooks/{id}": {
|
||||
"get": {
|
||||
"summary": "Get hook",
|
||||
"description": "Get hook details.",
|
||||
"description": "Get hook details by ID.",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "includeExecutionStats",
|
||||
|
@ -73,7 +73,7 @@
|
|||
},
|
||||
"patch": {
|
||||
"summary": "Update hook",
|
||||
"description": "Update hook details with the given data.",
|
||||
"description": "Update hook details by ID with the given data.",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
|
@ -103,7 +103,7 @@
|
|||
},
|
||||
"delete": {
|
||||
"summary": "Delete hook",
|
||||
"description": "Delete hook.",
|
||||
"description": "Delete hook by ID.",
|
||||
"responses": {
|
||||
"204": {
|
||||
"description": "The hook was deleted successfully."
|
||||
|
|
|
@ -57,7 +57,7 @@
|
|||
"/api/organizations/{id}": {
|
||||
"get": {
|
||||
"summary": "Get organization",
|
||||
"description": "Get organization details.",
|
||||
"description": "Get organization details by ID.",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Details of the organization."
|
||||
|
@ -66,7 +66,7 @@
|
|||
},
|
||||
"patch": {
|
||||
"summary": "Update organization",
|
||||
"description": "Update organization details with the given data.",
|
||||
"description": "Update organization details by ID with the given data.",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
|
@ -91,7 +91,7 @@
|
|||
},
|
||||
"delete": {
|
||||
"summary": "Delete organization",
|
||||
"description": "Delete organization.",
|
||||
"description": "Delete organization by ID.",
|
||||
"responses": {
|
||||
"204": {
|
||||
"description": "The organization was deleted successfully."
|
||||
|
|
|
@ -48,7 +48,7 @@
|
|||
"/api/organization-roles/{id}": {
|
||||
"get": {
|
||||
"summary": "Get organization role",
|
||||
"description": "Get organization role details.",
|
||||
"description": "Get organization role details by ID.",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Details of the organization role."
|
||||
|
@ -57,7 +57,7 @@
|
|||
},
|
||||
"patch": {
|
||||
"summary": "Update organization role",
|
||||
"description": "Update organization role details with the given data.",
|
||||
"description": "Update organization role details by ID with the given data.",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
|
@ -85,7 +85,7 @@
|
|||
},
|
||||
"delete": {
|
||||
"summary": "Delete organization role",
|
||||
"description": "Delete organization role.",
|
||||
"description": "Delete organization role by ID.",
|
||||
"responses": {
|
||||
"204": {
|
||||
"description": "The organization role was deleted successfully."
|
||||
|
|
|
@ -48,7 +48,7 @@
|
|||
"/api/organization-scopes/{id}": {
|
||||
"get": {
|
||||
"summary": "Get organization scope",
|
||||
"description": "Get organization scope details.",
|
||||
"description": "Get organization scope details by ID.",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "The organization scope data for the given ID."
|
||||
|
@ -57,7 +57,7 @@
|
|||
},
|
||||
"patch": {
|
||||
"summary": "Update organization scope",
|
||||
"description": "Update organization scope details with the given data.",
|
||||
"description": "Update organization scope details by ID with the given data.",
|
||||
"requestBody": {
|
||||
"content": {
|
||||
"application/json": {
|
||||
|
@ -85,7 +85,7 @@
|
|||
},
|
||||
"delete": {
|
||||
"summary": "Delete organization scope",
|
||||
"description": "Delete organization scope.",
|
||||
"description": "Delete organization scope by ID.",
|
||||
"responses": {
|
||||
"204": {
|
||||
"description": "The organization scope was deleted successfully."
|
||||
|
|
|
@ -55,7 +55,7 @@
|
|||
}
|
||||
},
|
||||
"summary": "Get API resource",
|
||||
"description": "Get an API resource details."
|
||||
"description": "Get an API resource details by ID."
|
||||
},
|
||||
"patch": {
|
||||
"requestBody": {
|
||||
|
@ -80,7 +80,7 @@
|
|||
}
|
||||
},
|
||||
"summary": "Update API resource",
|
||||
"description": "Update an API resource details with the given data. This method performs a partial update."
|
||||
"description": "Update an API resource details by ID with the given data. This method performs a partial update."
|
||||
},
|
||||
"delete": {
|
||||
"parameters": [],
|
||||
|
@ -90,7 +90,7 @@
|
|||
}
|
||||
},
|
||||
"summary": "Delete API resource",
|
||||
"description": "Delete an API resource with the given ID."
|
||||
"description": "Delete an API resource by ID."
|
||||
}
|
||||
},
|
||||
"/api/resources/{id}/is-default": {
|
||||
|
@ -181,7 +181,7 @@
|
|||
}
|
||||
},
|
||||
"summary": "Delete API resource scope",
|
||||
"description": "Delete an API resource scope (permission) from the given resource ID."
|
||||
"description": "Delete an API resource scope (permission) from the given resource."
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
@ -64,7 +64,7 @@
|
|||
}
|
||||
},
|
||||
"summary": "Get role",
|
||||
"description": "Get role details."
|
||||
"description": "Get role details by ID."
|
||||
},
|
||||
"patch": {
|
||||
"requestBody": {
|
||||
|
@ -140,7 +140,7 @@
|
|||
}
|
||||
},
|
||||
"summary": "Remove role from user",
|
||||
"description": "Remove the role from a user with the given ID."
|
||||
"description": "Remove a role from a user with the given ID."
|
||||
}
|
||||
},
|
||||
"/api/roles/{id}/applications": {
|
||||
|
|
Loading…
Add table
Reference in a new issue