docs: update docs

amisadmin · Dec 20, 2023 · 2fffa00 · 2fffa00
1 parent bc04491
commit 2fffa00
Show file tree

Hide file tree

Showing 10 changed files with 21 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -122,6 +122,7 @@ if __name__ == '__main__':
 - Method 1: Create model through `SQLModel`.
 
 ```python
+from typing import Optional
 from sqlmodel import SQLModel
 from fastapi_amis_admin.models.fields import Field
 
@@ -132,7 +133,7 @@ class Base(SQLModel):
 
 # Create an SQLModel, see document for details: https://sqlmodel.tiangolo.com/
 class Category(SQLModel, table=True):
-    id: int = Field(default=None, primary_key=True, nullable=False)
+    id: Optional[int] = Field(default=None, primary_key=True, nullable=False)
     name: str = Field(title='CategoryName', max_length=100, unique=True, index=True, nullable=False)
     description: str = Field(default='', title='Description', max_length=255)
 
@@ -188,7 +189,7 @@ from pydantic import BaseModel, Field
 
 
 class CategorySchema(BaseModel):
-    id: int = Field(default=None, primary_key=True, nullable=False)
+    id: Optional[int] = Field(default=None, primary_key=True, nullable=False)
     name: str = Field(title="CategoryName")
     description: str = Field(default="", title="CategoryDescription")
 
@@ -200,7 +201,6 @@ class CategorySchema(BaseModel):
 
 ```python
 from fastapi import FastAPI
-from sqlmodel import SQLModel
 from fastapi_amis_admin.admin.settings import Settings
 from fastapi_amis_admin.admin.site import AdminSite
 from fastapi_amis_admin.admin import admin

diff --git a/README.zh.md b/README.zh.md
@@ -129,7 +129,7 @@ class Base(SQLModel):
 
 # 创建SQLModel模型,详细请参考: https://sqlmodel.tiangolo.com/
 class Category(SQLModel, table=True):
-    id: int = Field(default=None, primary_key=True, nullable=False)
+    id: Optional[int] = Field(default=None, primary_key=True, nullable=False)
     name: str = Field(title='CategoryName', max_length=100, unique=True, index=True, nullable=False)
     description: str = Field(default='', title='Description', max_length=255)
 
@@ -182,7 +182,7 @@ from pydantic import BaseModel, Field
 
 
 class CategorySchema(BaseModel):
-    id: int = Field(default=None, primary_key=True, nullable=False)
+    id: Optional[int] = Field(default=None, primary_key=True, nullable=False)
     name: str = Field(title="CategoryName")
     description: str = Field(default="", title="CategoryDescription")
 
@@ -194,7 +194,6 @@ class CategorySchema(BaseModel):
 
 ```python
 from fastapi import FastAPI
-from sqlmodel import SQLModel
 from fastapi_amis_admin.admin.settings import Settings
 from fastapi_amis_admin.admin.site import AdminSite
 from fastapi_amis_admin.admin import admin

diff --git a/docs/en/docs/index.md b/docs/en/docs/index.md
@@ -132,7 +132,7 @@ class Base(SQLModel):
 
 # Create an SQLModel, see document for details: https://sqlmodel.tiangolo.com/
 class Category(SQLModel, table=True):
-    id: int = Field(default=None, primary_key=True, nullable=False)
+    id: Optional[int] = Field(default=None, primary_key=True, nullable=False)
     name: str = Field(title='CategoryName', max_length=100, unique=True, index=True, nullable=False)
     description: str = Field(default='', title='Description', max_length=255)
 
@@ -188,7 +188,7 @@ from pydantic import BaseModel, Field
 
 
 class CategorySchema(BaseModel):
-    id: int = Field(default=None, primary_key=True, nullable=False)
+    id: Optional[int] = Field(default=None, primary_key=True, nullable=False)
     name: str = Field(title="CategoryName")
     description: str = Field(default="", title="CategoryDescription")
 

diff --git a/docs/en/docs/tutorials/basic/Inheritance.md b/docs/en/docs/tutorials/basic/Inheritance.md
@@ -64,7 +64,7 @@ from fastapi_amis_admin.models.fields import Field
 
 # Create a SQLModel model, please refer to: https://sqlmodel.tiangolo.com/
 class Article(SQLModel, table=True):
-    id: int = Field(default=None, primary_key=True, nullable=False)
+    id: Optional[int] = Field(default=None, primary_key=True, nullable=False)
     title: str = Field(title='ArticleTitle', max_length=200)
     description: Optional[str] = Field(default='', title='ArticleDescription', max_length=400)
     status: bool = Field(None, title='status')

diff --git a/docs/en/docs/tutorials/basic/ModelAdmin.md b/docs/en/docs/tutorials/basic/ModelAdmin.md
@@ -7,7 +7,7 @@ Model management is the most commonly used management class in background manage
 ```python
 # First create a SQLModel model, please refer to: https://sqlmodel.tiangolo.com/
 class Category(SQLModel, table=True):
-    id: int = Field(default=None, primary_key=True, nullable=False)
+    id: Optional[int] = Field(default=None, primary_key=True, nullable=False)
     name: str = Field(title='CategoryName')
     description: str = Field(default='', title='Description')
 
@@ -37,7 +37,7 @@ Let's take a look at this simple example-1. It completes the following steps:
 ```python
 # Create a SQLModel model, please refer to: https://sqlmodel.tiangolo.com/
 class Article(SQLModel, table=True):
-    id: int = Field(default=None, primary_key=True, nullable=False)
+    id: Optional[int] = Field(default=None, primary_key=True, nullable=False)
     title: str = Field(title='ArticleTitle', max_length=200)
     description: Optional[str] = Field(default='', title='ArticleDescription', max_length=400)
     status: bool = Field(None, title='status')

diff --git a/docs/zh/docs/index.md b/docs/zh/docs/index.md
@@ -129,7 +129,7 @@ class Base(SQLModel):
 
 # 创建SQLModel模型,详细请参考: https://sqlmodel.tiangolo.com/
 class Category(SQLModel, table=True):
-    id: int = Field(default=None, primary_key=True, nullable=False)
+    id: Optional[int] = Field(default=None, primary_key=True, nullable=False)
     name: str = Field(title='CategoryName', max_length=100, unique=True, index=True, nullable=False)
     description: str = Field(default='', title='Description', max_length=255)
 
@@ -182,7 +182,7 @@ from pydantic import BaseModel, Field
 
 
 class CategorySchema(BaseModel):
-    id: int = Field(default=None, primary_key=True, nullable=False)
+    id: Optional[int] = Field(default=None, primary_key=True, nullable=False)
     name: str = Field(title="CategoryName")
     description: str = Field(default="", title="CategoryDescription")
 

diff --git a/docs/zh/docs/tutorials/basic/Inheritance.md b/docs/zh/docs/tutorials/basic/Inheritance.md
@@ -59,12 +59,12 @@ class ElementTemplateAdmin(MyJinja2Admin):
 
 ```python linenums="1" hl_lines="32"
 from fastapi_amis_admin import admin
-from fastapi_amis_admin.models.fields import Field
+from fastapi_amis_admin.models import Field
 
 
 # 创建一个SQLModel模型,详细请参考: https://sqlmodel.tiangolo.com/
 class Article(SQLModel, table=True):
-    id: int = Field(default=None, primary_key=True, nullable=False)
+    id: Optional[int] = Field(default=None, primary_key=True, nullable=False)
     title: str = Field(title='ArticleTitle', max_length=200)
     description: Optional[str] = Field(default='', title='ArticleDescription', max_length=400)
     status: bool = Field(None, title='status')

diff --git a/docs/zh/docs/tutorials/basic/ModelAdmin.md b/docs/zh/docs/tutorials/basic/ModelAdmin.md
@@ -8,7 +8,7 @@
 ```python
 # 先创建一个SQLModel模型,详细请参考: https://sqlmodel.tiangolo.com/
 class Category(SQLModel, table=True):
-    id: int = Field(default=None, primary_key=True, nullable=False)
+    id: Optional[int] = Field(default=None, primary_key=True, nullable=False)
     name: str = Field(title='CategoryName')
     description: str = Field(default='', title='Description')
 
@@ -38,10 +38,10 @@ class CategoryAdmin(admin.ModelAdmin):
 ```python
 # 创建一个SQLModel模型,详细请参考: https://sqlmodel.tiangolo.com/
 class Article(SQLModel, table=True):
-    id: int = Field(default=None, primary_key=True, nullable=False)
+    id: Optional[int] = Field(default=None, primary_key=True, nullable=False)
     title: str = Field(title='ArticleTitle', max_length=200)
     description: Optional[str] = Field(default='', title='ArticleDescription', max_length=400)
-    status: bool = Field(None, title='status')
+    status: bool = Field(False, title='status')
     content: str = Field(title='ArticleContent')
     # 关联Category模型,模型定义参考[示例-1]
     category_id: Optional[int] = Field(default=None, foreign_key="category.id", title='CategoryId')

diff --git a/docs/zh/docs/utils/database.md b/docs/zh/docs/utils/database.md
@@ -65,7 +65,7 @@ engine = create_engine("sqlite+pysqlite:///amisadmin.db", echo=True, future=True
 #### session_maker
 
 ```python
-self.session_maker: sessionmaker = sessionmaker(self.async_engine, autoflush=False)
+self.session_maker: sessionmaker = sessionmaker(self.engine, autoflush=False)
 ```
 
 ### 方法:

diff --git a/fastapi_amis_admin/crud/README.md b/fastapi_amis_admin/crud/README.md
@@ -17,12 +17,12 @@ from typing import Optional
 from fastapi import FastAPI
 from sqlalchemy.ext.asyncio import AsyncEngine, create_async_engine
 from sqlmodel import SQLModel, Field
-from fastapi_amis_admin.crud import SQLModelCrud
+from fastapi_amis_admin.crud import SqlalchemyCrud
 
 
 # 1. Create SQLModel model
 class Article(SQLModel, table=True):
-    id: int = Field(default=None, primary_key=True, nullable=False)
+    id: Optional[int] = Field(default=None, primary_key=True, nullable=False)
     title: str = Field(title='ArticleTitle', max_length=200)
     description: Optional[str] = Field(default='', title='ArticleDescription', max_length=400)
     status: bool = Field(None, title='status')
@@ -34,7 +34,7 @@ database_url = 'sqlite+aiosqlite:///amisadmin.db'
 engine: AsyncEngine = create_async_engine(database_url, future=True)
 
 # 3. Register crud route
-article_crud = SQLModelCrud(model=Article, engine=engine).register_crud()
+article_crud = SqlalchemyCrud(model=Article, engine=engine).register_crud()
 
 app = FastAPI(debug=True)