docs(openapi): document limit param and error responses on GET /v1/memories/ (#6779)

This commit is contained in:
Kartik
2026-08-03 23:56:12 +05:30
committed by GitHub
parent fd32b980b4
commit dd54e387de
+57 -2
View File
@@ -1218,6 +1218,15 @@
}, },
"description": "Number of items per page. Default: 100." "description": "Number of items per page. Default: 100."
}, },
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"maximum": 200
},
"description": "Maximum number of memories to return. Maximum accepted value: 200. Ignored when both `page` and `page_size` are supplied."
},
{ {
"name": "start_date", "name": "start_date",
"in": "query", "in": "query",
@@ -1261,6 +1270,7 @@
}, },
"metadata": { "metadata": {
"type": "object", "type": "object",
"nullable": true,
"additionalProperties": true, "additionalProperties": true,
"description": "User-supplied metadata attached to the memory." "description": "User-supplied metadata attached to the memory."
}, },
@@ -1288,6 +1298,7 @@
}, },
"structured_attributes": { "structured_attributes": {
"type": "object", "type": "object",
"nullable": true,
"additionalProperties": true, "additionalProperties": true,
"description": "System-derived temporal breakdown of the memory's creation time (e.g. year, month, day_of_week)." "description": "System-derived temporal breakdown of the memory's creation time (e.g. year, month, day_of_week)."
}, },
@@ -1346,6 +1357,7 @@
}, },
"metadata": { "metadata": {
"type": "object", "type": "object",
"nullable": true,
"additionalProperties": true, "additionalProperties": true,
"description": "User-supplied metadata attached to the memory." "description": "User-supplied metadata attached to the memory."
}, },
@@ -1373,6 +1385,7 @@
}, },
"structured_attributes": { "structured_attributes": {
"type": "object", "type": "object",
"nullable": true,
"additionalProperties": true, "additionalProperties": true,
"description": "System-derived temporal breakdown of the memory's creation time (e.g. year, month, day_of_week)." "description": "System-derived temporal breakdown of the memory's creation time (e.g. year, month, day_of_week)."
}, },
@@ -1413,14 +1426,47 @@
}, },
"400": { "400": {
"description": "Bad Request.", "description": "Bad Request.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "array",
"description": "Returned when none of the required filters (app_id, user_id, agent_id, run_id) is supplied.",
"items": {
"type": "string"
},
"example": [
"One of the filters: app_id, user_id, agent_id, run_id is required!"
]
},
{
"type": "object",
"description": "Returned when the `limit` query parameter is invalid.",
"properties": {
"error": {
"type": "string"
}
},
"example": {
"error": "limit must be <= 200"
}
}
]
}
}
}
},
"404": {
"description": "Not Found.",
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"type": "object", "type": "object",
"properties": { "properties": {
"message": { "detail": {
"type": "string", "type": "string",
"example": "One of the filters: app_id, user_id, agent_id, run_id is required!" "example": "Invalid page."
} }
} }
} }
@@ -1774,6 +1820,7 @@
}, },
"metadata": { "metadata": {
"type": "object", "type": "object",
"nullable": true,
"additionalProperties": true, "additionalProperties": true,
"description": "Additional metadata associated with the memory" "description": "Additional metadata associated with the memory"
}, },
@@ -1802,6 +1849,7 @@
}, },
"structured_attributes": { "structured_attributes": {
"type": "object", "type": "object",
"nullable": true,
"additionalProperties": true, "additionalProperties": true,
"description": "System-derived temporal breakdown of the memory's creation time (e.g. year, month, day_of_week)." "description": "System-derived temporal breakdown of the memory's creation time (e.g. year, month, day_of_week)."
}, },
@@ -2563,6 +2611,7 @@
}, },
"metadata": { "metadata": {
"type": "object", "type": "object",
"nullable": true,
"additionalProperties": true, "additionalProperties": true,
"description": "User-supplied metadata attached to the memory." "description": "User-supplied metadata attached to the memory."
}, },
@@ -2575,6 +2624,7 @@
}, },
"structured_attributes": { "structured_attributes": {
"type": "object", "type": "object",
"nullable": true,
"additionalProperties": true, "additionalProperties": true,
"description": "System-derived temporal breakdown of the memory's creation time (e.g. year, month, day_of_week)." "description": "System-derived temporal breakdown of the memory's creation time (e.g. year, month, day_of_week)."
}, },
@@ -3082,6 +3132,7 @@
}, },
"metadata": { "metadata": {
"type": "object", "type": "object",
"nullable": true,
"additionalProperties": true, "additionalProperties": true,
"description": "User-supplied metadata attached to the memory." "description": "User-supplied metadata attached to the memory."
}, },
@@ -3380,6 +3431,7 @@
}, },
"metadata": { "metadata": {
"type": "object", "type": "object",
"nullable": true,
"additionalProperties": true, "additionalProperties": true,
"description": "Additional metadata associated with the memory" "description": "Additional metadata associated with the memory"
}, },
@@ -3408,6 +3460,7 @@
}, },
"structured_attributes": { "structured_attributes": {
"type": "object", "type": "object",
"nullable": true,
"additionalProperties": true, "additionalProperties": true,
"description": "System-derived temporal breakdown of the memory's creation time (e.g. year, month, day_of_week)." "description": "System-derived temporal breakdown of the memory's creation time (e.g. year, month, day_of_week)."
}, },
@@ -3571,6 +3624,7 @@
}, },
"metadata": { "metadata": {
"type": "object", "type": "object",
"nullable": true,
"additionalProperties": true, "additionalProperties": true,
"description": "Additional metadata associated with the memory" "description": "Additional metadata associated with the memory"
}, },
@@ -3599,6 +3653,7 @@
}, },
"structured_attributes": { "structured_attributes": {
"type": "object", "type": "object",
"nullable": true,
"additionalProperties": true, "additionalProperties": true,
"description": "System-derived temporal breakdown of the memory's creation time (e.g. year, month, day_of_week)." "description": "System-derived temporal breakdown of the memory's creation time (e.g. year, month, day_of_week)."
}, },