aetos/openapi-first
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

using doc-forge

Browse Source
This commit is contained in:
Vishesh 'ironeagle' Bangotra
2026-01-22 16:55:15 +05:30
parent 29c1579f40
commit f91c0b8792
36 changed files with 3739 additions and 238 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
mcp_docs/modules/openapi_first.templates.crud_app.data.json Normal file
View File

@@ -0,0 +1,51 @@
{
"module": "openapi_first.templates.crud_app.data",
"content": {
"path": "openapi_first.templates.crud_app.data",
"docstring": "In-memory mock data store for CRUD example.\n\nThis module intentionally avoids persistence and concurrency guarantees.\nIt is suitable for demos, tests, and scaffolding only.\n\nIt intentionally avoids\n- persistence\n- concurrency guarantees\n- validation\n- error handling\n\nThe implementation is suitable for:\n- demonstrations\n- tests\n- scaffolding and example services\n\nIt is explicitly NOT suitable for production use.\n\nThis module is not part of the ``openapi_first`` library API surface.",
"objects": {
"Dict": {
"name": "Dict",
"kind": "alias",
"path": "openapi_first.templates.crud_app.data.Dict",
"signature": "<bound method Alias.signature of Alias('Dict', 'typing.Dict')>",
"docstring": null
},
"list_items": {
"name": "list_items",
"kind": "function",
"path": "openapi_first.templates.crud_app.data.list_items",
"signature": "<bound method Function.signature of Function('list_items', 36, 48)>",
"docstring": "Return all items in the data store.\n\nThis function performs no filtering, pagination, or sorting.\nThe returned collection reflects the current in-memory state.\n\nReturns\n-------\nlist[dict]\n A list of item representations."
},
"get_item": {
"name": "get_item",
"kind": "function",
"path": "openapi_first.templates.crud_app.data.get_item",
"signature": "<bound method Function.signature of Function('get_item', 51, 68)>",
"docstring": "Retrieve a single item by ID.\n\nThis function assumes the item exists and will raise ``KeyError``\nif the ID is not present in the store.\n\nParameters\n----------\nitem_id : int\n Identifier of the item to retrieve.\n\nReturns\n-------\ndict\n The stored item representation."
},
"create_item": {
"name": "create_item",
"kind": "function",
"path": "openapi_first.templates.crud_app.data.create_item",
"signature": "<bound method Function.signature of Function('create_item', 71, 92)>",
"docstring": "Create a new item in the data store.\n\nA new integer ID is assigned automatically. No validation is\nperformed on the provided payload.\n\nParameters\n----------\npayload : dict\n Item attributes excluding the ``id`` field.\n\nReturns\n-------\ndict\n The newly created item, including its assigned ID."
},
"update_item": {
"name": "update_item",
"kind": "function",
"path": "openapi_first.templates.crud_app.data.update_item",
"signature": "<bound method Function.signature of Function('update_item', 95, 117)>",
"docstring": "Replace an existing item in the data store.\n\nThis function overwrites the existing item entirely and does not\nperform partial updates or validation. If the item does not exist,\nit will be created implicitly.\n\nParameters\n----------\nitem_id : int\n Identifier of the item to update.\npayload : dict\n Item attributes excluding the ``id`` field.\n\nReturns\n-------\ndict\n The updated item representation."
},
"delete_item": {
"name": "delete_item",
"kind": "function",
"path": "openapi_first.templates.crud_app.data.delete_item",
"signature": "<bound method Function.signature of Function('delete_item', 120, 132)>",
"docstring": "Remove an item from the data store.\n\nThis function assumes the item exists and will raise ``KeyError``\nif the ID is not present.\n\nParameters\n----------\nitem_id : int\n Identifier of the item to delete."
}
}
}
}