swagger-coverage 3.3.0__tar.gz → 3.5.0__tar.gz

{swagger-coverage-3.3.0 → swagger_coverage-3.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: swagger-coverage
-Version: 3.3.0
+Version: 3.5.0
 Summary: Python adapter for "swagger-coverage" tool
 Home-page: https://github.com/JamalZeynalov/swagger-coverage-py
 Author: Jamal Zeinalov
@@ -11,6 +11,13 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: requests>=2.31.0
+Requires-Dist: Faker>=15.2.0
+Requires-Dist: setuptools>=69.0.3
+Requires-Dist: PyYAML>=6.0
+Requires-Dist: python-dotenv>=0.21.0
+Requires-Dist: rootpath==0.1.0
+Requires-Dist: environs>=9.5.0
 
 ![Supported Python Versions](https://img.shields.io/badge/python-3.6-blue)
 ![Version](https://img.shields.io/badge/Version-2.0.1-blue)
@@ -21,7 +28,9 @@ License-File: LICENSE
 
 ## Original description summary:
 
-> Swagger-coverage gives a full picture about coverage of API tests (regression) based on OAS 2 (Swagger). By saying coverage we mean not a broad theme functionality, but presence (or absence) of calls defined by API methods, parameters, return codes or other conditions which corresponds specification of API.
+> Swagger-coverage gives a full picture about coverage of API tests (regression) based on OAS 2 (Swagger). By saying
+> coverage we mean not a broad theme functionality, but presence (or absence) of calls defined by API methods, parameters,
+> return codes or other conditions which corresponds specification of API.
 
 Some more info about the project you can also
 find [HERE](https://viclovsky.github.io/%D0%B0%D0%B2%D1%82%D0%BE%D1%82%D0%B5%D1%81%D1%82%D1%8B%20%D0%BD%D0%B0%20api/2020/01/16/swagger-coverage)
@@ -47,6 +56,7 @@ pip install swagger-coverage
 ```
 
 ### 2. Add environment variables (Optionally):
+
 ```dotenv
 API_DOCS_TYPE="swagger"  # Note: "openapi" is default type of API docs
 API_DOCS_VERSION="2.0"  # Note: "3.0.0" is default version of API docs
@@ -122,7 +132,8 @@ def setup_swagger_coverage():
 > `host` - The host of the API.
 > It will be used to download a swagger.json file and to identify the CoverageListener output directory for each API.
 >
-> `cleanup_input_files()` - THis step deletes all files in the CoverageListener output directory (according to the target host)
+> `cleanup_input_files()` - THis step deletes all files in the CoverageListener output directory (according to the
+> target host)
 >
 > `path_to_swagger_json` - A second part of the HTTP link to your OpenApi/Swagger documentation in JSON format<br>
 > &nbsp;&nbsp;&nbsp;&nbsp; Adapted `swagger-<api_name>.json` file will be created in your project root.<br>
@@ -144,6 +155,12 @@ def setup_swagger_coverage():
             ],
             "filter": []
         },
+        "paths": {
+            "enable": true,
+            "ignore": [
+                "/user/{username}"
+            ]
+        },
         "only-declared-status": {
             "enable": false
         },
@@ -159,10 +176,15 @@ def setup_swagger_coverage():
     }
 }
 ```
+The `path` section is designed to exclude specific endpoints (all methods) from the final HTML report.
+To do this, you need to set `enable` parameter to `true` and specify a list of endpoints (as you see them in the swagger doc) in the `ignore` section. 
+Then these endpoints will be removed from the API doc before it is saved locally.<br>
+Note: Remove already downloaded API docs before running a new version of this lib.
 
 > ### If you have more than 1 API then this config MUST:
 > #### 1. Be created for each microservice which you track using `CoverageListener`.
-> Otherwise, the default behavior will be applied, and your report will be saved as `swagger-coverage-report.html` which may cause override in case you have multiple APIs
+> Otherwise, the default behavior will be applied, and your report will be saved as `swagger-coverage-report.html` which
+> may cause override in case you have multiple APIs
 > #### 2. Contain `writers` section with filename in the format: `swagger-coverage-report-<api_name>.html`
 > #### 3. Be placed in the root of your project
 

swagger-coverage-3.3.0/swagger_coverage.egg-info/PKG-INFO → swagger_coverage-3.5.0/README.md

@@ -1,17 +1,3 @@
-Metadata-Version: 2.1
-Name: swagger-coverage
-Version: 3.3.0
-Summary: Python adapter for "swagger-coverage" tool
-Home-page: https://github.com/JamalZeynalov/swagger-coverage-py
-Author: Jamal Zeinalov
-Author-email: jamal.zeynalov@gmail.com
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
-License-File: LICENSE
-
 ![Supported Python Versions](https://img.shields.io/badge/python-3.6-blue)
 ![Version](https://img.shields.io/badge/Version-2.0.1-blue)
 
@@ -21,7 +7,9 @@ License-File: LICENSE
 
 ## Original description summary:
 
-> Swagger-coverage gives a full picture about coverage of API tests (regression) based on OAS 2 (Swagger). By saying coverage we mean not a broad theme functionality, but presence (or absence) of calls defined by API methods, parameters, return codes or other conditions which corresponds specification of API.
+> Swagger-coverage gives a full picture about coverage of API tests (regression) based on OAS 2 (Swagger). By saying
+> coverage we mean not a broad theme functionality, but presence (or absence) of calls defined by API methods, parameters,
+> return codes or other conditions which corresponds specification of API.
 
 Some more info about the project you can also
 find [HERE](https://viclovsky.github.io/%D0%B0%D0%B2%D1%82%D0%BE%D1%82%D0%B5%D1%81%D1%82%D1%8B%20%D0%BD%D0%B0%20api/2020/01/16/swagger-coverage)
@@ -47,6 +35,7 @@ pip install swagger-coverage
 ```
 
 ### 2. Add environment variables (Optionally):
+
 ```dotenv
 API_DOCS_TYPE="swagger"  # Note: "openapi" is default type of API docs
 API_DOCS_VERSION="2.0"  # Note: "3.0.0" is default version of API docs
@@ -122,7 +111,8 @@ def setup_swagger_coverage():
 > `host` - The host of the API.
 > It will be used to download a swagger.json file and to identify the CoverageListener output directory for each API.
 >
-> `cleanup_input_files()` - THis step deletes all files in the CoverageListener output directory (according to the target host)
+> `cleanup_input_files()` - THis step deletes all files in the CoverageListener output directory (according to the
+> target host)
 >
 > `path_to_swagger_json` - A second part of the HTTP link to your OpenApi/Swagger documentation in JSON format<br>
 > &nbsp;&nbsp;&nbsp;&nbsp; Adapted `swagger-<api_name>.json` file will be created in your project root.<br>
@@ -144,6 +134,12 @@ def setup_swagger_coverage():
             ],
             "filter": []
         },
+        "paths": {
+            "enable": true,
+            "ignore": [
+                "/user/{username}"
+            ]
+        },
         "only-declared-status": {
             "enable": false
         },
@@ -159,10 +155,15 @@ def setup_swagger_coverage():
     }
 }
 ```
+The `path` section is designed to exclude specific endpoints (all methods) from the final HTML report.
+To do this, you need to set `enable` parameter to `true` and specify a list of endpoints (as you see them in the swagger doc) in the `ignore` section. 
+Then these endpoints will be removed from the API doc before it is saved locally.<br>
+Note: Remove already downloaded API docs before running a new version of this lib.
 
 > ### If you have more than 1 API then this config MUST:
 > #### 1. Be created for each microservice which you track using `CoverageListener`.
-> Otherwise, the default behavior will be applied, and your report will be saved as `swagger-coverage-report.html` which may cause override in case you have multiple APIs
+> Otherwise, the default behavior will be applied, and your report will be saved as `swagger-coverage-report.html` which
+> may cause override in case you have multiple APIs
 > #### 2. Contain `writers` section with filename in the format: `swagger-coverage-report-<api_name>.html`
 > #### 3. Be placed in the root of your project
 
@@ -211,4 +212,4 @@ Important remarks:
 
 ## License
 
-Swagger coverage is released under version 2.0 of the [Apache License](http://www.apache.org/licenses/LICENSE-2.0)
+Swagger coverage is released under version 2.0 of the [Apache License](http://www.apache.org/licenses/LICENSE-2.0)

{swagger-coverage-3.3.0 → swagger_coverage-3.5.0}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
 
 setup(
     name="swagger-coverage",
-    version="3.3.0",
+    version="3.5.0",
     author="Jamal Zeinalov",
     author_email="jamal.zeynalov@gmail.com",
     description='Python adapter for "swagger-coverage" tool',
@@ -19,14 +19,13 @@ setup(
         "Operating System :: OS Independent",
     ],
     install_requires=[
-        "requests>=2.28.1",
+        "requests>=2.31.0",
         "Faker>=15.2.0",
-        "setuptools>=65.5.1",
+        "setuptools>=69.0.3",
         "PyYAML>=6.0",
         "python-dotenv>=0.21.0",
         "rootpath==0.1.0",
         "environs>=9.5.0",
-
     ],
     python_requires=">=3.6",
     include_package_data=True,

swagger-coverage-3.3.0/README.md → swagger_coverage-3.5.0/swagger_coverage.egg-info/PKG-INFO

@@ -1,3 +1,24 @@
+Metadata-Version: 2.1
+Name: swagger-coverage
+Version: 3.5.0
+Summary: Python adapter for "swagger-coverage" tool
+Home-page: https://github.com/JamalZeynalov/swagger-coverage-py
+Author: Jamal Zeinalov
+Author-email: jamal.zeynalov@gmail.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.31.0
+Requires-Dist: Faker>=15.2.0
+Requires-Dist: setuptools>=69.0.3
+Requires-Dist: PyYAML>=6.0
+Requires-Dist: python-dotenv>=0.21.0
+Requires-Dist: rootpath==0.1.0
+Requires-Dist: environs>=9.5.0
+
 ![Supported Python Versions](https://img.shields.io/badge/python-3.6-blue)
 ![Version](https://img.shields.io/badge/Version-2.0.1-blue)
 
@@ -7,7 +28,9 @@
 
 ## Original description summary:
 
-> Swagger-coverage gives a full picture about coverage of API tests (regression) based on OAS 2 (Swagger). By saying coverage we mean not a broad theme functionality, but presence (or absence) of calls defined by API methods, parameters, return codes or other conditions which corresponds specification of API.
+> Swagger-coverage gives a full picture about coverage of API tests (regression) based on OAS 2 (Swagger). By saying
+> coverage we mean not a broad theme functionality, but presence (or absence) of calls defined by API methods, parameters,
+> return codes or other conditions which corresponds specification of API.
 
 Some more info about the project you can also
 find [HERE](https://viclovsky.github.io/%D0%B0%D0%B2%D1%82%D0%BE%D1%82%D0%B5%D1%81%D1%82%D1%8B%20%D0%BD%D0%B0%20api/2020/01/16/swagger-coverage)
@@ -33,6 +56,7 @@ pip install swagger-coverage
 ```
 
 ### 2. Add environment variables (Optionally):
+
 ```dotenv
 API_DOCS_TYPE="swagger"  # Note: "openapi" is default type of API docs
 API_DOCS_VERSION="2.0"  # Note: "3.0.0" is default version of API docs
@@ -108,7 +132,8 @@ def setup_swagger_coverage():
 > `host` - The host of the API.
 > It will be used to download a swagger.json file and to identify the CoverageListener output directory for each API.
 >
-> `cleanup_input_files()` - THis step deletes all files in the CoverageListener output directory (according to the target host)
+> `cleanup_input_files()` - THis step deletes all files in the CoverageListener output directory (according to the
+> target host)
 >
 > `path_to_swagger_json` - A second part of the HTTP link to your OpenApi/Swagger documentation in JSON format<br>
 > &nbsp;&nbsp;&nbsp;&nbsp; Adapted `swagger-<api_name>.json` file will be created in your project root.<br>
@@ -130,6 +155,12 @@ def setup_swagger_coverage():
             ],
             "filter": []
         },
+        "paths": {
+            "enable": true,
+            "ignore": [
+                "/user/{username}"
+            ]
+        },
         "only-declared-status": {
             "enable": false
         },
@@ -145,10 +176,15 @@ def setup_swagger_coverage():
     }
 }
 ```
+The `path` section is designed to exclude specific endpoints (all methods) from the final HTML report.
+To do this, you need to set `enable` parameter to `true` and specify a list of endpoints (as you see them in the swagger doc) in the `ignore` section. 
+Then these endpoints will be removed from the API doc before it is saved locally.<br>
+Note: Remove already downloaded API docs before running a new version of this lib.
 
 > ### If you have more than 1 API then this config MUST:
 > #### 1. Be created for each microservice which you track using `CoverageListener`.
-> Otherwise, the default behavior will be applied, and your report will be saved as `swagger-coverage-report.html` which may cause override in case you have multiple APIs
+> Otherwise, the default behavior will be applied, and your report will be saved as `swagger-coverage-report.html` which
+> may cause override in case you have multiple APIs
 > #### 2. Contain `writers` section with filename in the format: `swagger-coverage-report-<api_name>.html`
 > #### 3. Be placed in the root of your project
 
@@ -197,4 +233,4 @@ Important remarks:
 
 ## License
 
-Swagger coverage is released under version 2.0 of the [Apache License](http://www.apache.org/licenses/LICENSE-2.0)
+Swagger coverage is released under version 2.0 of the [Apache License](http://www.apache.org/licenses/LICENSE-2.0)

{swagger-coverage-3.3.0 → swagger_coverage-3.5.0}/swagger_coverage.egg-info/requires.txt

@@ -1,6 +1,6 @@
-requests>=2.28.1
+requests>=2.31.0
 Faker>=15.2.0
-setuptools>=65.5.1
+setuptools>=69.0.3
 PyYAML>=6.0
 python-dotenv>=0.21.0
 rootpath==0.1.0

{swagger-coverage-3.3.0 → swagger_coverage-3.5.0}/swagger_coverage_py/configs.py

@@ -9,6 +9,10 @@ env = Env()
 API_DOCS_TYPE = env.str("API_DOCS_TYPE", default="openapi")  # "swagger"
 API_DOCS_VERSION = env.str("API_DOCS_VERSION", default="3.0.0")  # "2.0"
 API_DOCS_FORMAT = env.str("API_DOCS_FORMAT", default="json")  # "yaml"
-IS_DISABLED = env.bool("API_COVERAGE_REPORTS_DISABLED", default=False)  # If True then requests won't be recorded
+IS_DISABLED = env.bool(
+    "API_COVERAGE_REPORTS_DISABLED", default=False
+)  # If True then requests won't be recorded
 
-DEBUG_MODE = env.bool("DEBUG_MODE", default=False)  # Set to True to see commandline output
+DEBUG_MODE = env.bool(
+    "DEBUG_MODE", default=False
+)  # Set to True to see commandline output

swagger_coverage-3.5.0/swagger_coverage_py/docs_writers/api_doc_writer.py

@@ -0,0 +1,56 @@
+import json
+
+import requests
+import yaml
+
+from swagger_coverage_py.configs import API_DOCS_FORMAT, API_DOCS_TYPE
+
+
+def __delete_ignored_paths_from_json(
+    api_doc_data: requests.Response, paths_to_delete: list
+) -> dict:
+    data: dict = api_doc_data.json()
+    for path in paths_to_delete:
+        if path in data["paths"]:
+            del data["paths"][path]
+    return data
+
+
+def __delete_ignored_paths_from_yaml(
+    api_doc_data: requests.Response, paths_to_delete: list
+) -> dict:
+    data: dict = yaml.safe_load(str(api_doc_data.text))
+    for path in paths_to_delete:
+        if path in data["paths"]:
+            del data["paths"][path]
+    return data
+
+
+def __write_api_doc_to_json(
+    file_path: str, api_doc_data: requests.Response, paths_to_delete: list
+):
+    api_doc_data = __delete_ignored_paths_from_json(api_doc_data, paths_to_delete)
+    if API_DOCS_TYPE == "swagger" and not api_doc_data.get("swagger", None):
+        api_doc_data["swagger"] = "2.0"
+
+    with open(file_path, "w+") as file:
+        file.write(json.dumps(api_doc_data))
+
+
+def __write_api_doc_to_yaml(
+    file_path: str, api_doc_data: requests.Response, paths_to_delete: list
+):
+    data = __delete_ignored_paths_from_yaml(api_doc_data, paths_to_delete)
+
+    if API_DOCS_TYPE == "swagger" and not data.get("swagger", None):
+        data["swagger"] = "2.0"
+
+    with open(file_path, "w+") as file:
+        file.write(yaml.safe_dump(data, indent=4, sort_keys=False))
+
+
+def write_api_doc_to_file(file_path: str, api_doc_data: dict, paths_to_delete: list):
+    if API_DOCS_FORMAT == "json":
+        __write_api_doc_to_json(file_path, api_doc_data, paths_to_delete)
+    else:
+        __write_api_doc_to_yaml(file_path, api_doc_data, paths_to_delete)

{swagger-coverage-3.3.0 → swagger_coverage-3.5.0}/swagger_coverage_py/listener.py

@@ -7,7 +7,13 @@ from swagger_coverage_py.uri import URI
 
 class CoverageListener:
     def __init__(
-        self, method: str, base_url: str, raw_path: str, uri_params: dict, base_path: str = "", **kwargs
+        self,
+        method: str,
+        base_url: str,
+        raw_path: str,
+        uri_params: dict,
+        base_path: str = "",
+        **kwargs
     ):
         """Records an HTTP request as a file in swagger format
 
@@ -23,4 +29,6 @@ class CoverageListener:
         self.response = requests.request(method, self.__uri.full, **kwargs)
 
         if not IS_DISABLED:
-            RequestSchemaHandler(self.__uri, method, self.response, kwargs).write_schema()
+            RequestSchemaHandler(
+                self.__uri, method, self.response, kwargs
+            ).write_schema()

{swagger-coverage-3.3.0 → swagger_coverage-3.5.0}/swagger_coverage_py/reporter.py

@@ -1,9 +1,11 @@
+import json
 import os
 import platform
 import re
 import shutil
 import subprocess
 from pathlib import Path
+from typing import List
 
 import requests
 
@@ -17,14 +19,31 @@ class CoverageReporter:
         self.verify = verify
         self.swagger_doc_file = f"swagger-doc-{api_name}.{API_DOCS_FORMAT}"
         self.output_dir = self.__get_output_dir()
-        self.ignore_requests = []
         self.swagger_coverage_config = f"swagger-coverage-config-{api_name}.json"
+        self.ignored_paths = self.__get_ignored_paths_from_config()
 
     def __get_output_dir(self):
         output_dir = "swagger-coverage-output"
         subdir = re.match(r"(^\w*)://(.*)", self.host).group(2)
         return f"{output_dir}/{subdir}"
 
+    def __get_ignored_paths_from_config(self) -> List[str]:
+        """Reads the swagger-coverage-config-<api_name>.json file and returns
+        a list of endpoints/paths to exclude from the report
+
+        """
+        paths_to_ignore = []
+        if not self.swagger_coverage_config:
+            return paths_to_ignore
+
+        with open(self.swagger_coverage_config, "r") as file:
+            data = json.load(file)
+            paths = data.get("rules").get("paths", {})
+            if paths.get("enable", False):
+                paths_to_ignore = paths.get("ignore")
+
+        return paths_to_ignore
+
     def setup(
         self, path_to_swagger_json: str, auth: object = None, cookies: dict = None
     ):
@@ -37,14 +56,20 @@ class CoverageReporter:
         """
         link_to_swagger_json = f"{self.host}{path_to_swagger_json}"
 
-        response = requests.get(link_to_swagger_json, auth=auth, cookies=cookies, verify=self.verify)
+        response = requests.get(
+            link_to_swagger_json, auth=auth, cookies=cookies, verify=self.verify
+        )
         assert response.ok, (
             f"Swagger doc is not pulled. See details: "
             f"{response.status_code} {response.request.url}"
             f"{response.content}\n{response.content}"
         )
-
-        write_api_doc_to_file(self.swagger_doc_file, response)
+        if self.swagger_coverage_config:
+            write_api_doc_to_file(
+                self.swagger_doc_file,
+                api_doc_data=response,
+                paths_to_delete=self.ignored_paths,
+            )
 
     def generate_report(self):
         inner_location = "swagger-coverage-commandline/bin/swagger-coverage-commandline"

{swagger-coverage-3.3.0 → swagger_coverage-3.5.0}/swagger_coverage_py/results_writers/base_schemas_manager.py

@@ -17,13 +17,18 @@ class ApiDocsManagerBase:
         self._uri = uri
         self._method = method
         self._response: Response = response
-        self.__other_request_params = kwargs
+        self._other_request_params = kwargs
 
     def _get_path_params(self) -> list:
         params_ = []
         for key, value in self._uri.uri_params.items():
             params_.append(
-                {"name": key, "in": "path", "required": False, "x-example": urllib.parse.unquote(str(value))}
+                {
+                    "name": key,
+                    "in": "path",
+                    "required": False,
+                    "x-example": urllib.parse.unquote(str(value)),
+                }
             )
         return params_
 
@@ -55,11 +60,8 @@ class ApiDocsManagerBase:
                 request_body: dict = {
                     "content": {
                         "application/json": {
-                            "schema": {
-                                "type": "object",
-                                "properties": properties
-                            },
-                            "example": json.loads(self._response.request.body)
+                            "schema": {"type": "object", "properties": properties},
+                            "example": json.loads(self._response.request.body),
                         }
                     }
                 }
@@ -70,11 +72,9 @@ class ApiDocsManagerBase:
                         "application/json": {
                             "schema": {
                                 "type": "array",
-                                "items": {
-                                    "type": items_type
-                                },
+                                "items": {"type": items_type},
                             },
-                            "example": json.loads(self._response.request.body)
+                            "example": json.loads(self._response.request.body),
                         }
                     }
                 }
@@ -85,7 +85,9 @@ class ApiDocsManagerBase:
                             "schema": {
                                 "type": "string",
                             },
-                            "example": urllib.parse.unquote(str(self._response.request.body))
+                            "example": urllib.parse.unquote(
+                                str(self._response.request.body)
+                            ),
                         }
                     }
                 }
@@ -94,21 +96,37 @@ class ApiDocsManagerBase:
 
         return request_body
 
-    def _get_query_params(self) -> list:
-        q_params = list(self.__other_request_params.get("params", {}).items())
+    def _get_other_request_params(self, params_key: str, params_in: str) -> list:
+        prams_raw = self._other_request_params.get(params_key, {})
+        if prams_raw:
+            params = list(prams_raw.items())
+        else:
+            params = []
+
         raw = self._uri.raw.split("?")
         if len(raw) > 1:
-            q_params += [tuple(x.split("=")) for x in str(raw[1]).split("&")]
-        if not q_params:
+            params += [tuple(x.split("=")) for x in str(raw[1]).split("&")]
+        if not params:
             return []
 
         params_ = []
-        for key, value in q_params:
+        for key, value in params:
             params_.append(
-                {"name": key, "in": "query", "required": False, "x-example": urllib.parse.unquote(str(value))}
+                {
+                    "name": key,
+                    "in": params_in,
+                    "required": False,
+                    "x-example": urllib.parse.unquote(str(value)),
+                }
             )
         return params_
 
+    def _get_query_params(self) -> list:
+        return self._get_other_request_params(params_key="params", params_in="query")
+
+    def _get_header_params(self) -> list:
+        return self._get_other_request_params(params_key="headers", params_in="header")
+
     def __get_output_subdir(self):
         return re.match(r"(^\w*)://(.*)", self._uri.host).group(2)
 

{swagger-coverage-3.3.0 → swagger_coverage-3.5.0}/swagger_coverage_py/results_writers/openapi_schemas_manager.py

@@ -11,10 +11,15 @@ class OpenApiSchemasManager(ApiDocsManagerBase):
 
     def _paths(self):
         path_ = self._uri.raw.split("?")[0]
+        params = (
+            self._get_path_params()
+            + self._get_query_params()
+            + self._get_header_params()
+        )
         dict_ = {
             path_: {
                 self._method: {
-                    "parameters": self._get_path_params() + self._get_query_params(),
+                    "parameters": params,
                     "responses": {self._response.status_code: {}},
                 }
             }

{swagger-coverage-3.3.0 → swagger_coverage-3.5.0}/swagger_coverage_py/results_writers/swagger_schemas_manager.py

@@ -29,7 +29,10 @@ class SwaggerSchemasManager(ApiDocsManagerBase):
     def _paths(self):
         path_ = self._uri.raw.split("?")[0]
         params = (
-            self._get_path_params() + self._get_query_params() + self._get_body_params()
+            self._get_path_params()
+            + self._get_query_params()
+            + self._get_body_params()
+            + self._get_header_params()
         )
         dict_ = {
             path_: {

swagger-coverage-3.3.0/swagger_coverage_py/docs_writers/api_doc_writer.py

@@ -1,32 +0,0 @@
-import json
-
-import requests
-import yaml
-
-from swagger_coverage_py.configs import API_DOCS_FORMAT, API_DOCS_TYPE
-
-
-def __write_api_doc_to_json(file_path: str, api_doc_data: requests.Response):
-    api_doc_data = api_doc_data.json()
-    if API_DOCS_TYPE == "swagger" and not api_doc_data.get("swagger", None):
-        api_doc_data["swagger"] = "2.0"
-
-    with open(file_path, "w+") as file:
-        file.write(json.dumps(api_doc_data))
-
-
-def __write_api_doc_to_yaml(file_path: str, api_doc_data: requests.Response):
-    data = yaml.safe_load(str(api_doc_data.text))
-
-    if API_DOCS_TYPE == "swagger" and not data.get("swagger", None):
-        data["swagger"] = "2.0"
-
-    with open(file_path, "w+") as file:
-        file.write(yaml.safe_dump(data, indent=4, sort_keys=False))
-
-
-def write_api_doc_to_file(file_path: str, api_doc_data: requests.Response):
-    if API_DOCS_FORMAT == "json":
-        __write_api_doc_to_json(file_path, api_doc_data)
-    else:
-        __write_api_doc_to_yaml(file_path, api_doc_data)