fastapi-voyager 0.13.2__tar.gz → 0.13.3__tar.gz

{fastapi_voyager-0.13.2 → fastapi_voyager-0.13.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.13.2
+Version: 0.13.3
 Summary: Visualize FastAPI application's routing tree and dependencies
 Project-URL: Homepage, https://github.com/allmonday/fastapi-voyager
 Project-URL: Source, https://github.com/allmonday/fastapi-voyager

{fastapi_voyager-0.13.2 → fastapi_voyager-0.13.3}/docs/changelog.md

@@ -143,7 +143,7 @@
 - 0.13.2
     - [x] show dashed line for link without dataloader
 - 0.13.3
-    - [ ] show field description
+    - [x] show field description
 - 0.13.4
     - [ ] integration with pydantic-resolve
         - [ ] show hint for resolve, post fields

{fastapi_voyager-0.13.2 → fastapi_voyager-0.13.3}/src/fastapi_voyager/type.py

@@ -16,6 +16,7 @@ class FieldInfo:
     from_base: bool = False
     is_object: bool = False
     is_exclude: bool = False
+    desc: str = ''
 
 @dataclass
 class Tag(NodeBase):

{fastapi_voyager-0.13.2 → fastapi_voyager-0.13.3}/src/fastapi_voyager/type_helper.py

@@ -182,7 +182,8 @@ def get_pydantic_fields(schema: type[BaseModel], bases_fields: set[str]) -> list
             name=k,
             from_base=k in bases_fields,
             type_name=get_type_name(anno),
-            is_exclude=bool(v.exclude)
+            is_exclude=bool(v.exclude),
+            desc=v.description or ''
         ))
     return fields
 

{fastapi_voyager-0.13.2 → fastapi_voyager-0.13.3}/src/fastapi_voyager/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "0.13.2"
+__version__ = "0.13.3"

{fastapi_voyager-0.13.2 → fastapi_voyager-0.13.3}/src/fastapi_voyager/web/component/schema-code-display.js

@@ -179,6 +179,7 @@ export default defineComponent({
                 <tr>
                   <th style="text-align:left; border-bottom:1px solid #ddd; padding:4px 6px;">Field</th>
                   <th style="text-align:left; border-bottom:1px solid #ddd; padding:4px 6px;">Type</th>
+                  <th style="text-align:left; border-bottom:1px solid #ddd; padding:4px 6px;">Description</th>
                   <th style="text-align:left; border-bottom:1px solid #ddd; padding:4px 6px;">Inherited</th>
                 </tr>
               </thead>
@@ -186,6 +187,7 @@ export default defineComponent({
                 <tr v-for="f in fields" :key="f.name">
                   <td style="padding:4px 6px; border-bottom:1px solid #f0f0f0;">{{ f.name }}</td>
                   <td style="padding:4px 6px; border-bottom:1px solid #f0f0f0; white-space:nowrap;">{{ f.type_name }}</td>
+                  <td style="padding:4px 6px; border-bottom:1px solid #f0f0f0; max-width: 200px;">{{ f.desc }}</td>
                   <td style="padding:4px 6px; border-bottom:1px solid #f0f0f0; text-align:left;">{{ f.from_base ? '✔︎' : '' }}</td>
                 </tr>
                 <tr v-if="!fields.length">

{fastapi_voyager-0.13.2 → fastapi_voyager-0.13.3}/tests/service/schema/schema.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 from typing import Literal
-from pydantic import BaseModel
+from pydantic import BaseModel, Field
 from pydantic_resolve import Relationship, MultipleRelationship, Link
 from .base_entity import BaseEntity
 
@@ -16,7 +16,7 @@ class Task(BaseModel, BaseEntity):
         Relationship(field='owner_id', target_kls=Member),
         Relationship(field='story_id', target_kls='Story'),
     ]
-    id: int
+    id: int = Field(description="The unique identifier of the task")
     story_id: int
     description: str
     owner_id: int