Fix method parameters generate schema. (#23)

* Fix method parameters generate schema.

Author: flask-pro

.pre-commit-config.yaml

@@ -14,6 +14,12 @@ repos:
   - id: check-builtin-literals
   - id: check-toml
   - id: double-quote-string-fixer
+  - id: check-merge-conflict
+- repo: https://github.com/asottile/pyupgrade
+  rev: v3.21.2
+  hooks:
+  - id: pyupgrade
+    args: [--py314-plus]
 - repo: https://github.com/pre-commit/pygrep-hooks
   rev: v1.10.0
   hooks:
@@ -24,15 +30,18 @@ repos:
   - id: python-no-log-warn
   - id: python-use-type-annotations
   - id: text-unicode-replacement-char
+- repo: https://github.com/dannysepler/rm_unneeded_f_str
+  rev: v0.2.0
+  hooks:
+  - id: rm-unneeded-f-str
+- repo: https://github.com/mxr/unkey
+  rev: v0.0.2
+  hooks:
+  - id: unkey
 - repo: https://github.com/pycqa/isort
-  rev: 9.0.0a3
+  rev: 9.0.0b1
   hooks:
   - id: isort
-- repo: https://github.com/asottile/pyupgrade
-  rev: v3.21.2
-  hooks:
-  - id: pyupgrade
-    args: [--py314-plus]
 - repo: https://github.com/hauntsaninja/no_implicit_optional
   rev: '1.4'
   hooks:
@@ -59,6 +68,20 @@ repos:
     - flake8-pytest-style
 #    - flake8-absolute-import
     args: [--max-line-length=100]
+#- repo: local
+#  hooks:
+#  - id: pylint
+#    name: pylint
+#    entry: pylint
+#    language: system
+#    types: [python]
+#    require_serial: true
+- repo: https://github.com/PyCQA/bandit
+  rev: 1.9.4
+  hooks:
+  - id: bandit
+    args: [-c, pyproject.toml]
+    additional_dependencies: ['bandit[toml]']
 - repo: https://github.com/mrtazz/checkmake.git
   rev: v0.3.0
   hooks:

CHANGES.md

@@ -1,3 +1,7 @@
+## Version 0.14.3
+
+* Fix method parameters generate schema.
+
 ## Version 0.14.2
 
 * Fix parameters generate schema.

pyproject.toml

@@ -20,7 +20,7 @@ license-files = ["LICENSE.txt"]
 name = "Schema-First"
 readme = "README.md"
 requires-python = ">=3.14"
-version = "0.14.2"
+version = "0.14.3"
 
 [project.optional-dependencies]
 dev = [
@@ -38,6 +38,9 @@ dev = [
 changelog = "https://github.com/flask-pro/schema-first/blob/master/CHANGES.md"
 repository = "https://github.com/flask-pro/schema-first"
 
+[tool.bandit]
+exclude_dirs = ["tests"]
+
 [tool.black]
 extend-exclude = '''
 # A regex preceded with ^/ will apply only to files and directories

src/schema_first/__init__.py

@@ -1,3 +1,3 @@
-from .specification import Specification
+from schema_first.specification import Specification
 
 __all__ = ['Specification']

src/schema_first/loaders/__init__.py

@@ -1,3 +1,3 @@
-from .yaml_loader import load_from_yaml
+from schema_first.loaders.yaml_loader import load_from_yaml
 
 __all__ = ['load_from_yaml']

src/schema_first/loaders/exc.py

@@ -1,4 +1,4 @@
-from ..exceptions import SchemaFirstException
+from schema_first.exceptions import SchemaFirstException
 
 
 class YAMLReaderError(SchemaFirstException):

src/schema_first/loaders/yaml_loader.py

@@ -6,8 +6,8 @@
 
 import yaml
 
-from .exc import ResolverError
-from .exc import YAMLReaderError
+from schema_first.loaders.exc import ResolverError
+from schema_first.loaders.exc import YAMLReaderError
 
 
 class YAMLReader:

src/schema_first/openapi/__init__.py

@@ -3,9 +3,9 @@
 
 from marshmallow import ValidationError
 
-from ..loaders.yaml_loader import load_from_yaml
-from .exc import OpenAPIValidationError
-from .schemas.v3_2.openapi_object_schema import OpenAPIObjectSchema
+from schema_first.loaders.yaml_loader import load_from_yaml
+from schema_first.openapi.exc import OpenAPIValidationError
+from schema_first.openapi.schemas.v3_2.openapi_object_schema import OpenAPIObjectSchema
 
 
 class OpenAPI:

src/schema_first/openapi/schemas/base.py

@@ -15,7 +15,7 @@ class Meta:
     def validate_ref(self, data, **kwargs) -> None:
         if 'ref' in data:
             ALLOWED_FIELDS = {'ref', 'description', 'summary'}
-            ALL_FIELDS = set(data.keys())
+            ALL_FIELDS = set(data)
             if ALL_FIELDS.difference(ALLOWED_FIELDS):
                 raise ValidationError(
                     f"If there is a <'ref'> field, then only <{ALLOWED_FIELDS}>,"

src/schema_first/specification/spilli_api.py

@@ -11,10 +11,7 @@ def __init__(self, open_api_spec: dict) -> None:
     def _convert_params_to_schema(
         self, params: list[dict], place: t.Literal['header', 'cookie', 'path', 'query']
     ) -> Any | None:
-        schema = {
-            'type': 'object',
-            'additionalProperties': True,
-        }
+        schema = {'type': 'object', 'additionalProperties': True}
 
         required = []
         properties = {}
@@ -47,18 +44,22 @@ def _params_list_to_dict(self, params: list[dict]) -> dict:
 
         return params_as_dict
 
-    def _make_to_spilli_api_format(self) -> None:
-        self.spilli_api_spec = json.loads(json.dumps(self.open_api_spec))
-
+    def _convert_method_params(self) -> None:
         for _, methods in self.spilli_api_spec['paths'].items():
-            common_params = []
-            if 'parameters' in methods:
-                common_params = methods.pop('parameters', [])
+            common_params = methods.pop('parameters', [])
+
+            for method, operation_obj in methods.items():
+                if method in ('summary', 'description', 'servers'):
+                    continue
 
-            for _, operation_obj in methods.items():
-                if 'parameters' in operation_obj:
-                    method_params = common_params + operation_obj.pop('parameters', [])
-                    operation_obj['parameters'] = self._params_list_to_dict(method_params)
+                method_params = operation_obj.get('parameters', [])
+                all_method_params = common_params + method_params
+                if all_method_params:
+                    operation_obj['parameters'] = self._params_list_to_dict(all_method_params)
+
+    def _make_to_spilli_api_format(self) -> None:
+        self.spilli_api_spec = json.loads(json.dumps(self.open_api_spec))
+        self._convert_method_params()
 
     def convert(self) -> dict:
         self._make_to_spilli_api_format()