Skip to content

Commit 2ca1022

Browse files
committed
fixed some OPENAPI tag bugs
1 parent c42d9d1 commit 2ca1022

File tree

5 files changed

+7
-7
lines changed

5 files changed

+7
-7
lines changed

ellar/core/routing/operation_definitions.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ def _decorator(endpoint_handler: TCallable) -> TCallable:
281281

282282
def ws_route(
283283
self,
284-
path: str,
284+
path: str = "/",
285285
*,
286286
name: str = None,
287287
encoding: str = "json",

ellar/core/routing/router/module.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ def __init__(
6666
app: ASGIApp = None,
6767
routes: t.Sequence[BaseRoute] = None,
6868
name: str = None,
69-
tag: str = NOT_SET,
69+
tag: t.Optional[str] = NOT_SET,
7070
description: str = None,
7171
external_doc_description: str = None,
7272
external_doc_url: str = None,

ellar/openapi/builder.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,8 @@ def build_document(self, app: App) -> OpenAPI:
210210
for route_model in openapi_route_models:
211211
if isinstance(route_model, OpenAPIMountDocumentation):
212212
data = route_model.get_tag()
213-
self._build.setdefault("tags", []).append(data)
213+
if data:
214+
self._build.setdefault("tags", []).append(data)
214215
if components:
215216
self._build.setdefault("components", {}).update(components)
216217
return OpenAPI(**self._build)

ellar/openapi/route_doc_models.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ def __init__(
7575

7676
self._routes: t.List["OpenAPIRouteDocumentation"] = self._build_routes()
7777

78-
def get_tag(self) -> t.Dict:
78+
def get_tag(self) -> t.Optional[t.Dict]:
7979
external_doc = None
8080
if self.external_doc_url:
8181
external_doc = dict(
@@ -86,7 +86,7 @@ def get_tag(self) -> t.Dict:
8686
return dict(
8787
name=self.tag, description=self.description, externalDocs=external_doc
8888
)
89-
return dict()
89+
return None
9090

9191
def _build_routes(self) -> t.List["OpenAPIRouteDocumentation"]:
9292
reflector: Reflector = Reflector()
@@ -96,13 +96,12 @@ def _build_routes(self) -> t.List["OpenAPIRouteDocumentation"]:
9696
if isinstance(route, RouteOperation) and route.include_in_schema:
9797
openapi = reflector.get(OPENAPI_KEY, route.endpoint) or dict()
9898
guards = reflector.get(GUARDS_KEY, route.endpoint)
99-
99+
openapi.setdefault("tags", [self.tag] if self.tag else ["default"])
100100
_routes.append(
101101
OpenAPIRouteDocumentation(
102102
route=route,
103103
global_route_parameters=self.global_route_parameters,
104104
guards=guards or self.global_guards,
105-
tags=[self.tag],
106105
**openapi,
107106
)
108107
)

ellar/py.typed

Whitespace-only changes.

0 commit comments

Comments
 (0)