azure-functions-openapi 0.4.0__tar.gz

azure_functions_openapi-0.4.0/.coveragerc

@@ -0,0 +1,4 @@
+# .coveragerc
+[run]
+relative_files = True
+source = src/azure_functions_openapi

azure_functions_openapi-0.4.0/.editorconfig

@@ -0,0 +1,12 @@
+# This file sets code formatting rules that are respected by many editors and IDEs
+# It helps maintain consistent coding style across different environments
+
+root = true
+
+[*]
+charset = utf-8                  # Use UTF-8 encoding for all files
+end_of_line = lf                 # Use LF (Unix-style) line endings
+indent_style = space            # Use spaces instead of tabs
+indent_size = 4                 # Indent with 4 spaces
+trim_trailing_whitespace = true # Remove any whitespace characters at the end of lines
+insert_final_newline = true     # Ensure every file ends with a newline

azure_functions_openapi-0.4.0/.github/copilot-instructions.md

@@ -0,0 +1 @@
+- @azure Rule - Use Azure Best Practices: When generating code for Azure, running terminal commands for Azure, or performing operations related to Azure, invoke your `azure_development-get_best_practices` tool if available.

azure_functions_openapi-0.4.0/.github/workflows/deploy-docs.yml

@@ -0,0 +1,32 @@
+name: Deploy MkDocs to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.8"
+
+      - name: Install dependencies
+        run: |
+          pip install mkdocs mkdocs-material
+
+      - name: Build docs to verify build before deploy
+        run: mkdocs build --strict
+
+      - name: Deploy to GitHub Pages
+        run: mkdocs gh-deploy --force

azure_functions_openapi-0.4.0/.github/workflows/test.yml

@@ -0,0 +1,48 @@
+name: Test and Coverage
+
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Create virtualenv and install dev dependencies
+        run: |
+          make install PYTHON=python
+
+      - name: Show workspace contents (debug)
+        run: ls -R
+
+      - name: Run tests with coverage (Makefile)
+        run: |
+          . .venv/bin/activate
+          make coverage
+
+      - name: Verify coverage output
+        run: ls -lh coverage.xml
+
+      - name: Upload coverage to Codecov
+        if: matrix.python-version == '3.9'
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage.xml
+          verbose: true
+          fail_ci_if_error: true
+        env:
+          CODECOV_RETRIES: 3

azure_functions_openapi-0.4.0/.gitignore

@@ -0,0 +1,179 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+.vscode/
+
+# Coverage
+junit.xml

azure_functions_openapi-0.4.0/.pre-commit-config.yaml

@@ -0,0 +1,36 @@
+repos:
+  # Format code using Black (PEP8-compliant, compatible with Python 3.9+)
+  - repo: https://github.com/psf/black
+    rev: 23.11.0
+    hooks:
+      - id: black
+
+  # Lint and auto-fix style using Ruff (Python 3.9 compatible)
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.4.4  # Latest stable release, compatible with Python 3.9
+    hooks:
+      - id: ruff
+        args: [--fix]
+
+  # Perform static type checking with mypy using Python 3.9 environment
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.15.0
+    hooks:
+      - id: mypy
+        language: system  # Ensure it uses Python 3.9 (activate venv or set PATH)
+        args:
+          [
+            "--config-file=pyproject.toml",
+            "--install-types",
+            "--non-interactive"
+          ]
+
+  # Run security checks using Bandit, focused on src/ directory (exclude tests/)
+  - repo: https://github.com/PyCQA/bandit
+    rev: 1.7.7  # Compatible with Python 3.9+
+    hooks:
+      - id: bandit
+        language: python
+        name: bandit-src-only
+        entry: bandit -r src/ -x tests/
+        pass_filenames: false  # Don't pass file names individually (analyze whole dir)

azure_functions_openapi-0.4.0/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+<!-- insertion marker -->
+## [v0.4.0](https://github.com/yeongseon/azure-functions-openapi/releases/tag/v0.4.0) - 2025-05-13
+
+<small>[Compare with v0.3.0](https://github.com/yeongseon/azure-functions-openapi/compare/v0.3.0...v0.4.0)</small>
+
+### Fixed
+
+- fix: move isort settings under lint section in pyproject.toml ([90d2cf3](https://github.com/yeongseon/azure-functions-openapi/commit/90d2cf324673f0d3d758a8aa1aaeb4d8ba375077) by Yeongseon Choe).
+- fix(example): resolve double /api prefix and update route in spec ([daa54de](https://github.com/yeongseon/azure-functions-openapi/commit/daa54de05bd1680c1be8411b152fc2b4ebcece5c) by Yeongseon Choe).
+- fix(openapi): avoid requestBody for GET methods ([2f6b8f6](https://github.com/yeongseon/azure-functions-openapi/commit/2f6b8f63b8c17e9cb4cd0dcfdd90c74394f7bfde) by Yeongseon Choe).
+- fix: add type hints and support Pydantic v2, clean test/lint output ([cf7e8b3](https://github.com/yeongseon/azure-functions-openapi/commit/cf7e8b3f5a418ff765077d014424ca36af039bd0) by Yeongseon Choe).
+
+## [v0.3.0](https://github.com/yeongseon/azure-functions-openapi/releases/tag/v0.3.0) - 2025-05-07
+
+<small>[Compare with v0.2.0](https://github.com/yeongseon/azure-functions-openapi/compare/v0.2.0...v0.3.0)</small>
+
+## [v0.2.0](https://github.com/yeongseon/azure-functions-openapi/releases/tag/v0.2.0) - 2025-05-03
+
+<small>[Compare with first commit](https://github.com/yeongseon/azure-functions-openapi/compare/ff19e445109dada7de213bc92f2765e154878050...v0.2.0)</small>
+

azure_functions_openapi-0.4.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Yeongseon Choe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

azure_functions_openapi-0.4.0/Makefile

@@ -0,0 +1,104 @@
+# ------------------------
+# Path variables
+# ------------------------
+PYTHON     ?= python3.9
+VENV_DIR   = .venv
+UV         = $(VENV_DIR)/bin/uv
+PIP        = $(VENV_DIR)/bin/pip
+PYTHON_BIN = $(VENV_DIR)/bin/python
+
+# ------------------------
+# Help
+# ------------------------
+help: ## Show this help.
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
+
+# ------------------------
+# Setup
+# ------------------------
+install: ## Set up the virtual environment and install development dependencies
+	$(PYTHON) -m venv $(VENV_DIR)
+	$(PIP) install uv
+	$(UV) pip install --link-mode=copy -e ".[dev]"
+
+# ------------------------
+# Quality Checks
+# ------------------------
+format: ## Format code using black
+	$(VENV_DIR)/bin/black src/ tests/
+
+lint: ## Lint using ruff
+	$(VENV_DIR)/bin/ruff check src/ tests/
+
+typecheck: ## Static type checking using mypy
+	$(VENV_DIR)/bin/mypy src/
+
+test: ## Run tests using pytest
+	PYTHONPATH=$(PWD) $(VENV_DIR)/bin/pytest -v tests/
+
+check: format lint typecheck coverage precommit-run ## Run all quality checks including test coverage
+
+# ------------------------
+# Cleaning
+# ------------------------
+clean: ## Remove caches and build artifacts
+	rm -rf __pycache__/ *.egg-info .mypy_cache .pytest_cache dist build
+
+# ------------------------
+# Build
+# ------------------------
+dist: ## Build source and wheel distributions
+	$(VENV_DIR)/bin/hatch build
+
+# ------------------------
+# Versioning
+# ------------------------
+version-patch: ## Bump patch version
+	$(VENV_DIR)/bin/hatch version patch
+
+version-minor: ## Bump minor version
+	$(VENV_DIR)/bin/hatch version minor
+
+version-major: ## Bump major version
+	$(VENV_DIR)/bin/hatch version major
+
+# ------------------------
+# Release automation
+# ------------------------
+release-patch: version-patch git-release ## Patch version bump and release (commit + tag + push)
+release-minor: version-minor git-release ## Minor version bump and release
+release-major: version-major git-release ## Major version bump and release
+
+git-release: ## Commit, tag, and push the release
+	git add .
+	git commit -m "chore: release v$(shell grep -oP '__version__ = \"\K[^\"]+' src/azure_functions_openapi/__init__.py)"
+	git tag v$(shell grep -oP '__version__ = \"\K[^\"]+' src/azure_functions_openapi/__init__.py)
+	git push origin main --tags
+
+# ------------------------
+# Pre-commit
+# ------------------------
+precommit-install: ## Install pre-commit hooks
+	$(VENV_DIR)/bin/pre-commit install
+
+precommit-run: ## Run all pre-commit hooks on all files
+	$(VENV_DIR)/bin/pre-commit run --all-files
+
+# ------------------------
+# Changelog
+# ------------------------
+changelog: ## Generate CHANGELOG.md from git tags
+	$(VENV_DIR)/bin/git-changelog --output CHANGELOG.md --template keepachangelog
+
+# ------------------------
+# Test coverage
+# ------------------------
+coverage: ## Run tests with coverage report (text and XML + JUnit)
+	PYTHONPATH=$(PWD) $(VENV_DIR)/bin/pytest \
+		--cov=src/azure_functions_openapi \
+		--cov-report=term-missing \
+		--cov-report=xml \
+		--junitxml=junit.xml -o junit_family=legacy
+
+coverage-html: ## Run tests with coverage and generate HTML report
+	PYTHONPATH=$(PWD) $(VENV_DIR)/bin/pytest --cov=src/azure_functions_openapi --cov-report=html