mirror of
https://github.com/logto-io/logto.git
synced 2024-12-16 20:26:19 -05:00
chore(core): add logs api doc descriptions (#5034)
* chore(core): add logs api doc descriptions * chore: polish docs --------- Co-authored-by: Gao Sun <gao@silverhand.io>
This commit is contained in:
parent
ad60de8f24
commit
88e8aa944a
1 changed files with 52 additions and 0 deletions
52
packages/core/src/routes/log.openapi.json
Normal file
52
packages/core/src/routes/log.openapi.json
Normal file
|
@ -0,0 +1,52 @@
|
|||
{
|
||||
"tags": [
|
||||
{
|
||||
"name": "Logs",
|
||||
"description": "Logs (audit logs) are used to track end-user activities in Logto sign-in experience and other flows. It does not include activities in Logto Console."
|
||||
}
|
||||
],
|
||||
"paths": {
|
||||
"/api/logs": {
|
||||
"get": {
|
||||
"summary": "Get logs",
|
||||
"description": "Get logs that match the given query with pagination.",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "userId",
|
||||
"in": "query",
|
||||
"description": "Filter logs by user ID."
|
||||
},
|
||||
{
|
||||
"name": "applicationId",
|
||||
"in": "query",
|
||||
"description": "Filter logs by application ID."
|
||||
},
|
||||
{
|
||||
"name": "logKey",
|
||||
"in": "query",
|
||||
"description": "Filter logs by log key."
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "An array of logs that match the given query."
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/logs/{id}": {
|
||||
"get": {
|
||||
"summary": "Get log",
|
||||
"description": "Get log details by ID.",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Log details."
|
||||
},
|
||||
"404": {
|
||||
"description": "Log not found."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
Loading…
Reference in a new issue