v0.1.3 💧

Author: RobertoPrevato

CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.1.3] - 2021-06-17 :droplet:
+
+- Corrects a bug forcing `camelCase` on examples objects handled as dataclasses
+- Adds base64 ValueFormat to the v3 enum
 ## [0.1.2] - 2021-05-03 :notes:
 
 - Adds a changelog

openapidocs/common.py

@@ -1,6 +1,6 @@
 import copy
 import json
-from dataclasses import fields, is_dataclass
+from dataclasses import fields, is_dataclass, asdict
 from enum import Enum
 from typing import Any, List, Tuple
 
@@ -13,7 +13,11 @@ class Format(Enum):
     JSON = "JSON"
 
 
-class OpenAPIRoot:
+class OpenAPIElement:
+    """Base class for all OpenAPI Elements"""
+
+
+class OpenAPIRoot(OpenAPIElement):
     """Base class for a root OpenAPI Documentation"""
 
 
@@ -51,12 +55,14 @@ def normalize_dict_factory(items: List[Tuple[Any, Any]]) -> Any:
 def _asdict_inner(obj, dict_factory):
     if hasattr(obj, "to_obj"):
         return obj.to_obj()
-    if is_dataclass(obj):
+    if isinstance(obj, OpenAPIElement):
         result = []
         for f in fields(obj):
             value = _asdict_inner(getattr(obj, f.name), dict_factory)
             result.append((f.name, value))
         return dict_factory(result)
+    if is_dataclass(obj):
+        return asdict(obj)
     elif isinstance(obj, (list, tuple)):
         return type(obj)(_asdict_inner(v, dict_factory) for v in obj)
     elif isinstance(obj, dict):
@@ -71,7 +77,9 @@ def _asdict_inner(obj, dict_factory):
 def normalize_dict(obj):
     if hasattr(obj, "to_obj"):
         return obj.to_obj()
-    return _asdict_inner(obj, dict_factory=normalize_dict_factory)
+    if isinstance(obj, OpenAPIElement):
+        return _asdict_inner(obj, dict_factory=normalize_dict_factory)
+    return asdict(obj)
 
 
 class Serializer:

openapidocs/v2.py

@@ -8,6 +8,7 @@
 from dataclasses import dataclass
 from openapidocs.common import OpenAPIRoot
 from typing import Any, List, Optional, Dict, Type, Union
+from .common import OpenAPIElement
 
 
 def get_ref(ref_type: Union[str, Type]) -> str:
@@ -90,26 +91,26 @@ class OAuthFlowType(Enum):
 
 
 @dataclass
-class Contact:
+class Contact(OpenAPIElement):
     name: Optional[str] = None
     url: Optional[str] = None
     email: Optional[str] = None
 
 
 @dataclass
-class ExternalDocs:
+class ExternalDocs(OpenAPIElement):
     url: str
     description: Optional[str] = None
 
 
 @dataclass
-class License:
+class License(OpenAPIElement):
     name: str
     url: Optional[str] = None
 
 
 @dataclass
-class Info:
+class Info(OpenAPIElement):
     title: str
     version: str
     description: Optional[str] = None
@@ -119,7 +120,7 @@ class Info:
 
 
 @dataclass
-class XML:
+class XML(OpenAPIElement):
     name: Optional[str] = None
     namespace: Optional[str] = None
     prefix: Optional[str] = None
@@ -128,13 +129,13 @@ class XML:
 
 
 @dataclass
-class Discriminator:
+class Discriminator(OpenAPIElement):
     property_name: str
     mapping: Optional[Dict[str, str]] = None
 
 
 @dataclass
-class Schema:
+class Schema(OpenAPIElement):
     type: Union[None, str, ValueType] = None
     format: Union[None, str, ValueFormat] = None
     required: Optional[List[str]] = None
@@ -162,7 +163,7 @@ class Schema:
 
 
 @dataclass
-class Header:
+class Header(OpenAPIElement):
     type: HeaderType
     description: Optional[str] = None
     format: Optional[str] = None
@@ -184,23 +185,23 @@ class Header:
 
 
 @dataclass
-class Example:
+class Example(OpenAPIElement):
     summary: Optional[str] = None
     description: Optional[str] = None
     value: Any = None
     external_value: Optional[str] = None
 
 
 @dataclass
-class Reference:
+class Reference(OpenAPIElement):
     ref: str
 
     def to_obj(self) -> Dict[str, str]:
         return {"$ref": self.ref}
 
 
 @dataclass
-class Encoding:
+class Encoding(OpenAPIElement):
     content_type: Optional[str] = None
     headers: Optional[Dict[str, Union[Header, Reference]]] = None
     style: Optional[str] = None
@@ -209,15 +210,15 @@ class Encoding:
 
 
 @dataclass
-class Response:
+class Response(OpenAPIElement):
     description: str
     headers: Optional[Dict[str, Union[Header, Reference]]] = None
     schema: Optional[Schema] = None
     examples: Optional[Dict[str, Any]] = None
 
 
 @dataclass
-class Items:
+class Items(OpenAPIElement):
     type: ValueItemType
     format: Optional[ValueFormat] = None
     items: Optional["Items"] = None
@@ -238,7 +239,7 @@ class Items:
 
 
 @dataclass
-class Parameter:
+class Parameter(OpenAPIElement):
     name: str
     in_: ParameterLocation
     type: Optional[ValueType] = None
@@ -267,7 +268,7 @@ class Parameter:
 
 
 @dataclass
-class SecurityRequirement:
+class SecurityRequirement(OpenAPIElement):
     name: str
     value: List[str]
 
@@ -276,7 +277,7 @@ def to_obj(self):
 
 
 @dataclass
-class Operation:
+class Operation(OpenAPIElement):
     responses: Dict[str, Response]
     tags: Optional[List[str]] = None
     operation_id: Optional[str] = None
@@ -292,7 +293,7 @@ class Operation:
 
 
 @dataclass
-class PathItem:
+class PathItem(OpenAPIElement):
     ref: Optional[str] = None
     get: Optional[Operation] = None
     put: Optional[Operation] = None
@@ -304,7 +305,7 @@ class PathItem:
     parameters: Optional[List[Union[Parameter, Reference]]] = None
 
 
-class SecurityScheme(ABC):
+class SecurityScheme(OpenAPIElement, ABC):
     """Abstract security scheme"""
 
 
@@ -333,7 +334,7 @@ class OAuth2Security(SecurityScheme):
 
 
 @dataclass
-class Tag:
+class Tag(OpenAPIElement):
     name: str
     description: Optional[str] = None
     external_docs: Optional[ExternalDocs] = None