Fixes #87: added summary to all openapi endpoints

dolamroth · Sep 23, 2024 · bf9d81d · bf9d81d
1 parent e36632c
commit bf9d81d
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 3 deletions.
diff --git a/starlette_web/contrib/auth/views.py b/starlette_web/contrib/auth/views.py
@@ -109,6 +109,7 @@ class SignInAPIView(JWTSessionMixin, BaseHTTPEndpoint):
 
     async def post(self, request):
         """
+        summary: Sign in
         description: Sign in
         requestBody:
           required: true
@@ -160,6 +161,7 @@ class SignUpAPIView(JWTSessionMixin, BaseHTTPEndpoint):
 
     async def post(self, request):
         """
+        summary: Sign up
         description: Sign up
         requestBody:
           required: true
@@ -239,6 +241,7 @@ class SignOutAPIView(BaseHTTPEndpoint):
 
     async def delete(self, request):
         """
+        summary: Sign out
         description: Sign out
         responses:
           200:
@@ -272,6 +275,7 @@ class RefreshTokenAPIView(JWTSessionMixin, BaseHTTPEndpoint):
 
     async def post(self, request):
         """
+        summary: Update refresh token
         description: Update refresh token
         requestBody:
           required: true
@@ -330,6 +334,7 @@ class InviteUserAPIView(BaseHTTPEndpoint):
 
     async def post(self, request):
         """
+        summary: Invite user
         description: Invite user
         requestBody:
           required: true
@@ -419,6 +424,7 @@ class ResetPasswordAPIView(BaseHTTPEndpoint):
 
     async def post(self, request):
         """
+        summary: Reset password
         description: Reset password
         requestBody:
           required: true
@@ -489,6 +495,7 @@ class ChangePasswordAPIView(JWTSessionMixin, BaseHTTPEndpoint):
 
     async def post(self, request):
         """
+        summary: Change password
         description: Change password
         requestBody:
           required: true
@@ -530,6 +537,7 @@ class ProfileApiView(BaseHTTPEndpoint):
 
     async def get(self, request):
         """
+        summary: Profile info
         description: Profile info
         responses:
           200:

diff --git a/starlette_web/tests/contrib/test_apispec.py b/starlette_web/tests/contrib/test_apispec.py
@@ -10,6 +10,7 @@
     "paths": {
         "/api/auth/me/": {
             "get": {
+                "summary": "Profile info",
                 "description": "Profile info",
                 "responses": {
                     "200": {
@@ -45,6 +46,7 @@
         },
         "/api/auth/sign-in/": {
             "post": {
+                "summary": "Sign in",
                 "description": "Sign in",
                 "requestBody": {
                     "required": True,
@@ -96,6 +98,7 @@
         },
         "/api/auth/sign-up/": {
             "post": {
+                "summary": "Sign up",
                 "description": "Sign up",
                 "requestBody": {
                     "required": True,
@@ -137,6 +140,7 @@
         },
         "/api/auth/sign-out/": {
             "delete": {
+                "summary": "Sign out",
                 "description": "Sign out",
                 "responses": {
                     "200": {
@@ -165,6 +169,7 @@
         },
         "/api/auth/refresh-token/": {
             "post": {
+                "summary": "Update refresh token",
                 "description": "Update refresh token",
                 "requestBody": {
                     "required": True,
@@ -216,6 +221,7 @@
         },
         "/api/auth/invite-user/": {
             "post": {
+                "summary": "Invite user",
                 "description": "Invite user",
                 "requestBody": {
                     "required": True,
@@ -272,6 +278,7 @@
         },
         "/api/auth/reset-password/": {
             "post": {
+                "summary": "Reset password",
                 "description": "Reset password",
                 "requestBody": {
                     "required": True,
@@ -338,6 +345,7 @@
         },
         "/api/auth/change-password/": {
             "post": {
+                "summary": "Change password",
                 "description": "Change password",
                 "requestBody": {
                     "required": True,
@@ -382,6 +390,7 @@
         },
         "/health_check/": {
             "get": {
+                "summary": "Health check",
                 "description": "Health check of services",
                 "responses": {
                     "200": {
@@ -405,6 +414,7 @@
         },
         "/typed-schema/": {
             "post": {
+                "summary": "TypedMethodField",
                 "description": "Endpoint with typed method field",
                 "requestBody": {
                     "required": True,
@@ -446,7 +456,8 @@
         },
         "/{alias}/": {
             "get": {
-                "description": "Empty response for test",
+                "summary": "Empty response",
+                "description": "Empty response (204) for test",
                 "responses": {
                     "204": {
                         "description": "Empty response for test"
@@ -469,7 +480,8 @@
         },
         "/{alias1}/{alias2}/": {
             "get": {
-                "description": "Empty response for test",
+                "summary": "Empty response",
+                "description": "Empty response (204) for test",
                 "responses": {
                     "204": {
                         "description": "Empty response for test"

diff --git a/starlette_web/tests/views/http.py b/starlette_web/tests/views/http.py
@@ -27,6 +27,7 @@ class HealthCheckAPIView(BaseHTTPEndpoint):
 
     async def get(self, *_):
         """
+        summary: Health check
         description: Health check of services
         responses:
           200:
@@ -72,7 +73,8 @@ class EmptyResponseAPIView(BaseHTTPEndpoint):
 
     async def get(self, *_):
         """
-        description: Empty response for test
+        summary: Empty response
+        description: Empty response (204) for test
         responses:
           204:
             description: Empty response for test
@@ -101,6 +103,7 @@ class EndpointWithTypedMethodSchema(BaseHTTPEndpoint):
 
     async def post(self, request):
         """
+        summary: TypedMethodField
         description: Endpoint with typed method field
         requestBody:
           required: true