Skip to content

Commit 11e5efd

Browse files
committed
fix: update comments for clarity in item schema
- Changed comment prefixes to "NOTE" for consistency. - Added clarification regarding API documentation limitations.
1 parent ea802ae commit 11e5efd

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

schemas/item.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ class AddBaseItem(BaseModel):
77
name: Annotated[
88
str, Field(..., description="Required, the name of the image to be added.")
99
]
10-
# APIのドキュメントによっては、項目名がurlの場合がある
10+
# NOTE: APIのドキュメントによっては、項目名がurlの場合がある
1111
website: Annotated[
1212
Optional[str], Field(None, description="The Address of the source of the image")
1313
]
1414
tags: Annotated[Optional[List[str]], Field(None, description="Tags for the image.")]
15-
# APIのドキュメントによっては、記載されていない場合がある。実際には利用可能
15+
# NOTE: APIのドキュメントによっては、記載されていない場合がある。実際には利用可能
1616
star: Annotated[
1717
Optional[int], Field(None, ge=0, le=5, description="The rating for the image.")
1818
]
@@ -198,6 +198,8 @@ class UpdateItemRequest(BaseModel):
198198
star: Annotated[
199199
Optional[int], Field(None, ge=0, le=5, description="Optional, ratings")
200200
]
201+
# NOTE: APIのドキュメントに項目が無く、API経由での更新できない
202+
# folders: ...
201203

202204

203205
class GetItemSourceRequest(BaseModel):

0 commit comments

Comments
 (0)