fastapi_swagger2 0.2.2__tar.gz → 0.2.4__tar.gz

{fastapi_swagger2-0.2.2 → fastapi_swagger2-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: fastapi_swagger2
-Version: 0.2.2
+Version: 0.2.4
 Summary: Swagger2 support for FastAPI framework
 Project-URL: Homepage, https://github.com/virajkanwade/fastapi_swagger2
 Project-URL: Documentation, https://github.com/virajkanwade/fastapi_swagger2
@@ -94,7 +94,7 @@ Python 3.8+
 
 * 0.0.3 - FastAPI >= 0.79.0, <= 0.98.0
 * 0.1.1 - FastAPI >= 0.99.0, <= 0.99.1
-* 0.2.1 - FastAPI >= 0.100.0
+* 0.2.4 - FastAPI >= 0.100.0
 
 ## Installation
 
@@ -133,6 +133,25 @@ This adds following endpoints:
 * http://localhost:8000/swagger2/docs
 * http://localhost:8000/swagger2/redoc
 
+## Generate spec for CI/CD
+
+```Python
+import os
+
+import yaml
+
+from app.main import app
+
+URL = os.environ["CLOUD_RUN_URL"]
+
+app.servers.append(URL)
+
+spec = app.swagger2()
+spec['x-google-backend'] = {'address': URL}
+
+print(yaml.dump(spec))
+```
+
 ## Development
 
 ```console

{fastapi_swagger2-0.2.2 → fastapi_swagger2-0.2.4}/README.md

@@ -25,7 +25,7 @@ Python 3.8+
 
 * 0.0.3 - FastAPI >= 0.79.0, <= 0.98.0
 * 0.1.1 - FastAPI >= 0.99.0, <= 0.99.1
-* 0.2.1 - FastAPI >= 0.100.0
+* 0.2.4 - FastAPI >= 0.100.0
 
 ## Installation
 
@@ -64,6 +64,25 @@ This adds following endpoints:
 * http://localhost:8000/swagger2/docs
 * http://localhost:8000/swagger2/redoc
 
+## Generate spec for CI/CD
+
+```Python
+import os
+
+import yaml
+
+from app.main import app
+
+URL = os.environ["CLOUD_RUN_URL"]
+
+app.servers.append(URL)
+
+spec = app.swagger2()
+spec['x-google-backend'] = {'address': URL}
+
+print(yaml.dump(spec))
+```
+
 ## Development
 
 ```console

fastapi_swagger2-0.2.4/setup.cfg

@@ -0,0 +1,3 @@
+[flake8]
+max-line-length=88
+

{fastapi_swagger2-0.2.2 → fastapi_swagger2-0.2.4}/src/fastapi_swagger2/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.2.2"
+__version__ = "0.2.4"
 
 from typing import Any, Dict, List, Optional, TypeVar
 
@@ -139,7 +139,7 @@ class FastAPISwagger2:
                 contact=self.app.contact,
                 license_info=self.app.license_info,
                 routes=self.app.routes,
-                tags=self.app.swagger2_tags,
+                tags=self.app.openapi_tags,
             )
 
         return self.app.swagger2_schema

{fastapi_swagger2-0.2.2 → fastapi_swagger2-0.2.4}/src/fastapi_swagger2/models.py

@@ -327,7 +327,7 @@ class Swagger2(BaseModel):
         Dict[str, Union[ParameterBody, ParameterNotBody, Reference]]
     ] = None
     responses: Optional[Dict[str, Union[Response, Reference]]] = None
-    securityDefinitions: Optional[Dict[str, Union[SecurityScheme, Reference]]]
+    securityDefinitions: Optional[Dict[str, Union[SecurityScheme, Reference]]] = None
     security: Optional[List[Dict[str, List[str]]]] = None
     tags: Optional[List[Tag]] = None
     externalDocs: Optional[ExternalDocumentation] = None

{fastapi_swagger2-0.2.2 → fastapi_swagger2-0.2.4}/src/fastapi_swagger2/utils.py

@@ -64,15 +64,17 @@ validation_error_response_definition = {
     },
 }
 
+FieldMapping = Dict[
+    Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue
+]
+
 
 # def get_schema_from_model_field(
 #        *,
 #        field: ModelField,
 #        schema_generator: GenerateJsonSchema,
 #        model_name_map: ModelNameMap,
-#        field_mapping: Dict[
-#            Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue
-#        ],
+#        field_mapping: FieldMapping,
 #    ) -> Dict[str, Any]:
 #        # This expects that GenerateJsonSchema was already used to generate the definitions
 #        json_schema = field_mapping[(field, field.mode)]
@@ -110,6 +112,7 @@ def get_swagger2_security_definitions(
     security_definitions = {}
     operation_security = []
     for security_requirement in flat_dependant.security_requirements:
+        skip: bool = False
         # fastapi.security.* which gets model from fastapi.openapi.models
         security_definition = jsonable_encoder(
             security_requirement.security_scheme.model,
@@ -120,13 +123,13 @@ def get_swagger2_security_definitions(
             if security_definition.get("scheme", "basic") == "basic":
                 security_definition = {"type": "basic"}
             else:
+                skip = True
                 logger.warning(
                     f"fastapi_swagger2: Unable to handle security_definition: {security_definition}"
                 )
         elif security_definition["type"] == "apiKey":
             pass
         elif security_definition["type"] == "oauth2":
-            _security_definition = security_definition
             flows = security_definition["flows"]
             flows_keys = list(flows.keys())
             if len(flows_keys) >= 1:
@@ -148,12 +151,14 @@ def get_swagger2_security_definitions(
                         {_security_name: security_requirement.scopes}
                     )
         else:
+            skip = True
             logger.warning(
                 f"fastapi_swagger2: Unable to handle security_definition: {security_definition}"
             )
-        security_name = security_requirement.security_scheme.scheme_name
-        security_definitions[security_name] = security_definition
-        operation_security.append({security_name: security_requirement.scopes})
+        if not skip:
+            security_name = security_requirement.security_scheme.scheme_name
+            security_definitions[security_name] = security_definition
+            operation_security.append({security_name: security_requirement.scopes})
     return security_definitions, operation_security
 
 
@@ -162,9 +167,7 @@ def get_swagger2_operation_parameters(
     all_route_params: Sequence[ModelField],
     schema_generator: GenerateJsonSchema,
     model_name_map: ModelNameMap,
-    field_mapping: Dict[
-        Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue
-    ],
+    field_mapping: FieldMapping,
 ) -> List[Dict[str, Any]]:
     parameters = []
     for param in all_route_params:
@@ -203,9 +206,7 @@ def get_swagger2_operation_request_body(
     body_field: Optional[ModelField],
     schema_generator: GenerateJsonSchema,
     model_name_map: ModelNameMap,
-    field_mapping: Dict[
-        Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue
-    ],
+    field_mapping: FieldMapping,
 ) -> Optional[Dict[str, Any]]:
     if not body_field:
         return None
@@ -239,9 +240,7 @@ def get_swagger2_path(
     operation_ids: Set[str],
     schema_generator: GenerateJsonSchema,
     model_name_map: ModelNameMap,
-    field_mapping: Dict[
-        Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue
-    ],
+    field_mapping: FieldMapping,
 ) -> Tuple[Dict[str, Any], Dict[str, Any], Dict[str, Any]]:
     path: Dict[str, Any] = {}
     security_schemes: Dict[str, Any] = {}
@@ -507,7 +506,7 @@ def get_swagger2(
         # output["definitions"] = {k: definitions[k] for k in sorted(definitions)}
         output["definitions"] = {}
         for k in sorted(definitions):
-            properties = definitions[k]["properties"]
+            properties = definitions[k].get("properties", [])
             for p in properties:
                 if "anyOf" in properties[p].keys():
                     any_of = properties[p].pop("anyOf")
@@ -518,8 +517,9 @@ def get_swagger2(
                             else:
                                 properties[p].update(_any_of)
                     else:
+                        properties[p].update({"type": "string"})
                         logger.warning(
-                            f"fastapi_swagger2: Unable to handle anyOf in definitions {any_of}"
+                            f"fastapi_swagger2: Unable to handle anyOf in definitions {any_of}, defaulting to string type."
                         )
 
             output["definitions"][k] = definitions[k]