feat: added support for 'content' field in parameters

.github/workflows/build.yml

@@ -1,8 +1,6 @@
 name: CI
 
 on:
-  push:
-    branches: [ '*', '**' ]
   pull_request:
     branches: [ master ]
 
@@ -30,5 +28,5 @@ jobs:
 
       - name: Run tests
         run: |
-          pipenv run python setup.py install
+          pipenv run python -m pip install -e .
           pipenv run pytest

Makefile

@@ -23,7 +23,7 @@ clean: ## Remove build files
 	@echo "Temporary files were clear"
 
 test: ## Run code tests
-	@pipenv run python -m pytest -q
+	@pipenv run python -m pytest -qv
 
 sync: ## Sync with Pipfile packages list
 	@pipenv sync

Pipfile

@@ -4,15 +4,15 @@ url = "https://pypi.org/simple"
 verify_ssl = true
 
 [dev-packages]
-twine = ">=3.3.0"
-wheel = ">=0.35.1"
-mypy = ">=0.800"
-pytest = ">=6.2.2"
-build = "*"
+twine = ">=4.0.2"
+wheel = ">=0.45.1"
+build = ">=1.0.3"
+mypy = ">=1.15.0"
+pytest = ">=8.3.5"
 
 [packages]
-prance = ">=0.20.2"
-openapi-spec-validator = "==0.6.0"
+openapi-spec-validator = ">=0.7.1"
+prance = ">=23.6.21.0"
 
 [requires]
 python_version = "3.9"

src/openapi_parser/builders/__init__.py

@@ -1,33 +0,0 @@
-from .info import InfoBuilder
-from .server import ServerBuilder
-from .tag import TagBuilder
-from .external_doc import ExternalDocBuilder
-from .schema import SchemaFactory
-from .parameter import ParameterBuilder
-from .header import HeaderBuilder
-from .content import ContentBuilder
-from .request import RequestBuilder
-from .response import ResponseBuilder
-from .operation import OperationBuilder
-from .path import PathBuilder
-from .oauth_flow import OAuthFlowBuilder
-from .security import SecurityBuilder
-from .schemas import SchemasBuilder
-
-__all__ = [
-    "InfoBuilder",
-    "ServerBuilder",
-    "TagBuilder",
-    "ExternalDocBuilder",
-    "SchemaFactory",
-    "ParameterBuilder",
-    "HeaderBuilder",
-    "ContentBuilder",
-    "RequestBuilder",
-    "ResponseBuilder",
-    "OperationBuilder",
-    "PathBuilder",
-    "OAuthFlowBuilder",
-    "SecurityBuilder",
-    "SchemasBuilder",
-]

src/openapi_parser/builders/content.py

@@ -1,10 +1,10 @@
 import logging
 from typing import Type, Union, Any
 
-from . import SchemaFactory
+from .schema import SchemaFactory
 from ..enumeration import ContentType
-from ..specification import Content
 from ..loose_types import LooseContentType
+from ..specification import Content
 
 logger = logging.getLogger(__name__)
 

src/openapi_parser/builders/header.py

@@ -1,7 +1,7 @@
 import logging
 
-from . import SchemaFactory
 from .common import extract_typed_props, PropertyMeta, extract_extension_attributes
+from .schema import SchemaFactory
 from ..specification import Header
 
 logger = logging.getLogger(__name__)

src/openapi_parser/builders/operation.py

@@ -1,8 +1,11 @@
 import logging
 from typing import Dict
 
-from . import ExternalDocBuilder, ParameterBuilder, RequestBuilder, ResponseBuilder
 from .common import extract_typed_props, PropertyMeta, extract_extension_attributes
+from .external_doc import ExternalDocBuilder
+from .parameter import ParameterBuilder
+from .request import RequestBuilder
+from .response import ResponseBuilder
 from ..enumeration import OperationMethod
 from ..specification import Operation, Response
 

src/openapi_parser/builders/parameter.py

@@ -1,8 +1,9 @@
 import logging
 from typing import List
 
-from . import SchemaFactory
 from .common import extract_typed_props, PropertyMeta, extract_extension_attributes
+from .content import ContentBuilder
+from .schema import SchemaFactory
 from ..enumeration import ParameterLocation, HeaderParameterStyle, PathParameterStyle, QueryParameterStyle, \
     CookieParameterStyle
 from ..specification import Parameter
@@ -26,9 +27,11 @@
 
 class ParameterBuilder:
     schema_factory: SchemaFactory
+    content_builder: ContentBuilder
 
-    def __init__(self, schema_factory: SchemaFactory) -> None:
+    def __init__(self, schema_factory: SchemaFactory, content_builder: ContentBuilder) -> None:
         self.schema_factory = schema_factory
+        self.content_builder = content_builder
 
     def build_list(self, parameters: List[dict]) -> list[Parameter]:
         return [self.build(parameter) for parameter in parameters]
@@ -41,6 +44,7 @@ def build(self, data: dict) -> Parameter:
             "location": PropertyMeta(name="in", cast=ParameterLocation),
             "required": PropertyMeta(name="required", cast=None),
             "schema": PropertyMeta(name="schema", cast=self.schema_factory.create),
+            "content": PropertyMeta(name="content", cast=self.content_builder.build_list),
             "description": PropertyMeta(name="description", cast=str),
             "deprecated": PropertyMeta(name="deprecated", cast=None),
             "explode": PropertyMeta(name="explode", cast=None),

src/openapi_parser/builders/path.py

@@ -1,8 +1,9 @@
 import logging
 from typing import Dict
 
-from . import OperationBuilder, ParameterBuilder
 from .common import extract_typed_props, PropertyMeta, extract_extension_attributes
+from .operation import OperationBuilder
+from .parameter import ParameterBuilder
 from ..enumeration import OperationMethod
 from ..specification import Path
 

src/openapi_parser/builders/request.py

@@ -1,7 +1,7 @@
 import logging
 
-from . import ContentBuilder
 from .common import extract_typed_props, PropertyMeta
+from .content import ContentBuilder
 from ..specification import RequestBody
 
 logger = logging.getLogger(__name__)

src/openapi_parser/builders/response.py

@@ -1,8 +1,9 @@
 import logging
 from typing import Union
 
-from . import ContentBuilder, HeaderBuilder
 from .common import extract_typed_props, PropertyMeta
+from .content import ContentBuilder
+from .header import HeaderBuilder
 from ..specification import Response
 
 logger = logging.getLogger(__name__)

src/openapi_parser/builders/schemas.py

@@ -1,11 +1,11 @@
 import logging
 
+from .schema import SchemaFactory
 from ..specification import Schema
-from . import SchemaFactory
-
 
 logger = logging.getLogger(__name__)
 
+
 class SchemasBuilder:
     schema_factory: SchemaFactory
 
@@ -16,6 +16,6 @@ def build_collection(self, schemas: dict) -> dict[str, Schema]:
         logger.debug(f"Schemas parsing: {schemas.keys()}")
 
         return {
-            key : self.schema_factory.create(value)
+            key: self.schema_factory.create(value)
             for key, value in schemas.items()
         }

src/openapi_parser/parser.py

@@ -1,8 +1,22 @@
 import logging
-from typing import Optional
+from typing import Optional  # noqa: F401
 
-from .builders import *
 from .builders.common import extract_typed_props, PropertyMeta
+from .builders.content import ContentBuilder
+from .builders.external_doc import ExternalDocBuilder
+from .builders.header import HeaderBuilder
+from .builders.info import InfoBuilder
+from .builders.oauth_flow import OAuthFlowBuilder
+from .builders.operation import OperationBuilder
+from .builders.parameter import ParameterBuilder
+from .builders.path import PathBuilder
+from .builders.request import RequestBuilder
+from .builders.response import ResponseBuilder
+from .builders.schema import SchemaFactory
+from .builders.schemas import SchemasBuilder
+from .builders.security import SecurityBuilder
+from .builders.server import ServerBuilder
+from .builders.tag import TagBuilder
 from .errors import ParserError
 from .resolver import OpenAPIResolver
 from .specification import *
@@ -89,7 +103,7 @@ def _create_parser(strict_enum: bool = True) -> Parser:
     schema_factory = SchemaFactory(strict_enum=strict_enum)
     content_builder = ContentBuilder(schema_factory, strict_enum=strict_enum)
     header_builder = HeaderBuilder(schema_factory)
-    parameter_builder = ParameterBuilder(schema_factory)
+    parameter_builder = ParameterBuilder(schema_factory, content_builder)
     schemas_builder = SchemasBuilder(schema_factory)
     response_builder = ResponseBuilder(content_builder, header_builder)
     request_builder = RequestBuilder(content_builder)

src/openapi_parser/specification.py

@@ -152,7 +152,8 @@ class Object(Schema):
 class Parameter:
     name: str
     location: ParameterLocation
-    schema: Schema
+    schema: Optional[Schema] = None
+    content: Optional[list['Content']] = None
     required: Optional[bool] = field(default=False)
     description: Optional[str] = None
     # example: Optional[Any]  # TODO

tests/builders/test_content_builder.py

@@ -2,7 +2,8 @@
 
 import pytest
 
-from openapi_parser.builders import ContentBuilder, SchemaFactory
+from openapi_parser.builders.content import ContentBuilder
+from openapi_parser.builders.schema import SchemaFactory
 from openapi_parser.enumeration import ContentType, DataType
 from openapi_parser.specification import Content, Integer, Schema, String
 

tests/builders/test_external_doc_builder.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from openapi_parser.builders import ExternalDocBuilder
+from openapi_parser.builders.external_doc import ExternalDocBuilder
 from openapi_parser.specification import ExternalDoc
 
 data_provider = (

tests/builders/test_header_builder.py

@@ -2,7 +2,8 @@
 
 import pytest
 
-from openapi_parser.builders import HeaderBuilder, SchemaFactory
+from openapi_parser.builders.header import HeaderBuilder
+from openapi_parser.builders.schema import SchemaFactory
 from openapi_parser.enumeration import DataType
 from openapi_parser.specification import Header, Integer, Schema, String
 

tests/builders/test_info_builder.py

@@ -1,6 +1,6 @@
 import pytest
 
-from openapi_parser.builders import InfoBuilder
+from openapi_parser.builders.info import InfoBuilder
 from openapi_parser.specification import Contact, Info, License
 
 data_provider = (

tests/builders/test_oauth_flow_builder.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from openapi_parser.builders import OAuthFlowBuilder
+from openapi_parser.builders.oauth_flow import OAuthFlowBuilder
 from openapi_parser.enumeration import OAuthFlowType
 from openapi_parser.specification import OAuthFlow
 

tests/builders/test_operation_builder.py

@@ -2,8 +2,11 @@
 
 import pytest
 
-from openapi_parser.builders import ExternalDocBuilder, OperationBuilder, ParameterBuilder, RequestBuilder, \
-    ResponseBuilder
+from openapi_parser.builders.external_doc import ExternalDocBuilder
+from openapi_parser.builders.operation import OperationBuilder
+from openapi_parser.builders.parameter import ParameterBuilder
+from openapi_parser.builders.request import RequestBuilder
+from openapi_parser.builders.response import ResponseBuilder
 from openapi_parser.enumeration import DataType, ContentType, OperationMethod, ParameterLocation
 from openapi_parser.specification import Content, ExternalDoc, Object, Operation, Parameter, Property, RequestBody, \
     Response, String
@@ -68,7 +71,6 @@ def _get_list_builder_mock(expected):
     ]
 )
 
-
 data_provider = (
     (
         {