0
Fork 0
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:
Xiao Yijun 2023-12-03 00:09:30 +08:00 committed by GitHub
parent ad60de8f24
commit 88e8aa944a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View 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."
}
}
}
}
}
}