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

using doc-forge (#1)

Browse Source 
Reviewed-on: #1
Co-authored-by: Vishesh 'ironeagle' Bangotra <aetoskia@gmail.com>
Co-committed-by: Vishesh 'ironeagle' Bangotra <aetoskia@gmail.com>
This commit is contained in:
Vishesh 'ironeagle' Bangotra
2026-01-22 11:28:32 +00:00
committed by aetos
parent 29c1579f40
commit 6bafa435f1
36 changed files with 3739 additions and 238 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
mcp_docs/modules/openapi_first.templates.model_app.data.json Normal file
View File

@@ -0,0 +1,65 @@
{
"module": "openapi_first.templates.model_app.data",
"content": {
"path": "openapi_first.templates.model_app.data",
"docstring": "In-memory data store using Pydantic models.\n\nThis module is NOT thread-safe and is intended for demos and scaffolds only.\nThis module provides a minimal, process-local data store for the\nmodel-based CRUD example application. It stores and returns domain\nobjects defined using Pydantic models and is intended solely for\ndemonstration and scaffolding purposes.\n\nThe implementation intentionally avoids:\n- persistence\n- concurrency guarantees\n- transactional semantics\n- validation beyond what Pydantic provides\n\nIt is not part of the ``openapi_first`` library API surface.",
"objects": {
"Dict": {
"name": "Dict",
"kind": "alias",
"path": "openapi_first.templates.model_app.data.Dict",
"signature": "<bound method Alias.signature of Alias('Dict', 'typing.Dict')>",
"docstring": null
},
"Item": {
"name": "Item",
"kind": "alias",
"path": "openapi_first.templates.model_app.data.Item",
"signature": "<bound method Alias.signature of Alias('Item', 'models.Item')>",
"docstring": null
},
"ItemCreate": {
"name": "ItemCreate",
"kind": "alias",
"path": "openapi_first.templates.model_app.data.ItemCreate",
"signature": "<bound method Alias.signature of Alias('ItemCreate', 'models.ItemCreate')>",
"docstring": null
},
"list_items": {
"name": "list_items",
"kind": "function",
"path": "openapi_first.templates.model_app.data.list_items",
"signature": "<bound method Function.signature of Function('list_items', 34, 43)>",
"docstring": "Return all items in the data store.\n\nReturns\n-------\nlist[Item]\n A list of item domain objects."
},
"get_item": {
"name": "get_item",
"kind": "function",
"path": "openapi_first.templates.model_app.data.get_item",
"signature": "<bound method Function.signature of Function('get_item', 46, 65)>",
"docstring": "Retrieve a single item by ID.\n\nParameters\n----------\nitem_id : int\n Identifier of the item to retrieve.\n\nReturns\n-------\nItem\n The requested item.\n\nRaises\n------\nKeyError\n If the item does not exist."
},
"create_item": {
"name": "create_item",
"kind": "function",
"path": "openapi_first.templates.model_app.data.create_item",
"signature": "<bound method Function.signature of Function('create_item', 68, 89)>",
"docstring": "Create a new item in the data store.\n\nA new identifier is assigned automatically. No additional validation\nis performed beyond Pydantic model validation.\n\nParameters\n----------\npayload : ItemCreate\n Data required to create a new item.\n\nReturns\n-------\nItem\n The newly created item."
},
"update_item": {
"name": "update_item",
"kind": "function",
"path": "openapi_first.templates.model_app.data.update_item",
"signature": "<bound method Function.signature of Function('update_item', 92, 120)>",
"docstring": "Replace an existing item in the data store.\n\nThis function performs a full replacement of the stored item.\nPartial updates are not supported.\n\nParameters\n----------\nitem_id : int\n Identifier of the item to update.\npayload : ItemCreate\n New item data.\n\nReturns\n-------\nItem\n The updated item.\n\nRaises\n------\nKeyError\n If the item does not exist."
},
"delete_item": {
"name": "delete_item",
"kind": "function",
"path": "openapi_first.templates.model_app.data.delete_item",
"signature": "<bound method Function.signature of Function('delete_item', 123, 137)>",
"docstring": "Remove an item from the data store.\n\nParameters\n----------\nitem_id : int\n Identifier of the item to delete.\n\nRaises\n------\nKeyError\n If the item does not exist."
}
}
}
}