axmp-openapi-helper 0.1.0__tar.gz

axmp_openapi_helper-0.1.0/.cursorrules

@@ -0,0 +1,9 @@
+# docstring
+all docstring should be in english
+
+# test code
+all test code should be written by pytest
+all fixture should be located in the conftest.py
+
+# lint and formatting
+should use ruff for linting and formatting

axmp_openapi_helper-0.1.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[Bug]"
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

axmp_openapi_helper-0.1.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[Feature]"
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

axmp_openapi_helper-0.1.0/.github/ISSUE_TEMPLATE/release-template.md

@@ -0,0 +1,10 @@
+---
+name: Release template
+about: This is a Release Task template
+title: "[Release]"
+labels: ''
+assignees: ''
+
+---
+
+

axmp_openapi_helper-0.1.0/.gitignore

@@ -0,0 +1,174 @@
+# 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

axmp_openapi_helper-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+        args: [--markdown-linebreak-ext=md]
+      - id: end-of-file-fixer
+        exclude: \.(md|drawio)$
+      - id: debug-statements
+
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.9.10
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args: [ --fix ]
+        types_or: [python]
+        exclude: \.(md|drawio)$
+      # Run the formatter.
+      - id: ruff-format
+        types_or: [python]
+        exclude: \.(md|drawio)$

axmp_openapi_helper-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

axmp_openapi_helper-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Cloud Z MP
+
+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.

axmp_openapi_helper-0.1.0/PKG-INFO

@@ -0,0 +1,299 @@
+Metadata-Version: 2.4
+Name: axmp-openapi-helper
+Version: 0.1.0
+Summary: This is a openapi helper library for the ZMP AI Platform
+Project-URL: homepage, https://github.com/cloudz-mp
+Project-URL: repository, https://github.com/cloudz-mp/axmp-openapi-helper
+Project-URL: documentation, https://github.com/cloudz-mp/axmp-openapi-helper
+Project-URL: Bug Tracker, https://github.com/cloudz-mp/axmp-openapi-helper/issues
+Author-email: Kilsoo Kang <kilsoo75@gmail.com>
+License-File: LICENSE
+Requires-Python: <4.0,>=3.12
+Requires-Dist: colorlog>=6.9.0
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: pydantic>=2.11.7
+Requires-Dist: python-dotenv>=1.1.1
+Description-Content-Type: text/markdown
+
+# axmp-openapi-helper
+
+![Platform Badge](https://img.shields.io/badge/platform-zmp-red)
+![Component Badge](https://img.shields.io/badge/component-openapi_helper-red)
+![CI Badge](https://img.shields.io/badge/ci-github_action-green)
+![License Badge](https://img.shields.io/badge/license-MIT-green)
+![PyPI - Version](https://img.shields.io/pypi/v/axmp-openapi-helper)
+![PyPI - Implementation](https://img.shields.io/pypi/implementation/axmp-openapi-helper)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/axmp-openapi-helper)
+![PyPI - Wheel](https://img.shields.io/pypi/wheel/axmp-openapi-helper)
+![PyPI - Download](https://img.shields.io/pypi/dm/axmp-openapi-helper)
+
+## Introduction
+
+This is a openapi helper library for the ZMP AI Platform
+
+## Key Features
+
+- Support the OpenAPI Specification(>=3.0.0)
+- Generate the Arguments Schema for the LLM
+
+## Installation
+
+Install using pip:
+
+```bash
+pip install axmp-openapi-helper
+```
+
+Install using poetry:
+```bash
+poetry add axmp-openapi-helper
+```
+
+## Usage
+
+Basic example:
+
+```python
+import logging
+import logging.config
+
+from axmp_openapi_helper import (
+    MixedAPISpecConfig,
+    ZmpAPIWrapper,
+)
+
+logging.config.fileConfig("logging.conf", disable_existing_loggers=False)
+logging.getLogger("axmp_openapi_helper.openapi.zmpapi_models").setLevel(logging.INFO)
+logging.getLogger("axmp_openapi_helper.toolkits.toolkit").setLevel(logging.INFO)
+logger = logging.getLogger("appLogger")
+logger.setLevel(logging.DEBUG)
+
+if __name__ == "__main__":
+    mixed_api_spec_config = MixedAPISpecConfig.from_mixed_spec_file(
+        file_path="runner/openapi/zmp_mixed_api_spec.json"
+    )
+
+    zmp_api_wrapper = ZmpAPIWrapper(
+        "https://api.test.company.com",
+        mixed_api_spec_config=mixed_api_spec_config,
+        auth_type=AuthenticationType.CUSTOM,
+        custom_auth_header_key="X-Access-Key",
+        custom_auth_header_value="xxxxx",
+    )
+
+    operations = zmp_api_wrapper.get_operations()
+    for operation in operations:
+        print("-" * 100)
+        print(operation.args_schema)
+        for field_name, field_info in operation.args_schema.model_fields.items():
+            print(
+                f"\t{field_name}: {field_info.annotation}, {field_info.default}, {field_info.description}"
+            )
+
+    response = zmp_api_wrapper.run(
+        "GET",
+        "/api/alert/v1/alerts",
+        query_params=None
+    )
+    print(response)
+```
+
+Mixed API Spec Config Sample
+
+```json
+{
+    "backends": [
+        {
+            "backend": "zcp-alert-backend",
+            "config": {
+                "file_path": "runner/openapi/zcp/zcp_alert_backend_openapi_spec.json",
+                "prefix": "/api/alert/v1",
+                "apis": [
+                    {
+                        "path":"/api/alert/v1/alerts",
+                        "methods": ["get"]
+                    },
+                    {
+                        "path":"/api/alert/v1/alerts",
+                        "methods": ["post"]
+                    },
+                    {
+                        "path":"/api/alert/v1/alerts/{alert_id}",
+                        "methods": ["get"]
+                    },
+                    {
+                        "path":"/api/alert/v1/alerts/webhook",
+                        "methods": ["post"]
+                    },
+                    {
+                        "path":"/api/alert/v1/alerts/{alert_id}/{action}",
+                        "methods": ["patch"]
+                    },
+                    {
+                        "path":"/api/alert/v1/alerts/bulk/{action}",
+                        "methods": [
+                            {
+                                "method": "patch",
+                                "description": "Bulk action on alerts"
+                            }
+                        ]
+                    }
+                ]
+            }
+        },
+        {
+            "backend": "zcp-mcm-backend",
+            "config": {
+                "file_path": "runner/openapi/zcp/zcp_mcm_backend_openapi_spec.json",
+                "prefix": "/api/mcm/resource/v1beta1",
+                "apis": [
+                    {
+                        "path":"/api/mcm/resource/v1beta1/workload/pods",
+                        "methods": [
+                            {
+                                "method": "get",
+                                "description": "Get pods using the query parameters"
+                            }
+                        ]
+                    },
+                    {
+                        "path":"/api/mcm/resource/v1beta1/workload/pods/{name}",
+                        "methods": [
+                            {
+                                "method": "get",
+                                "description": "Get pod details by name and cluster and namespace parameters"
+                            }
+                        ]
+                    },
+                    {
+                        "path":"/api/mcm/resource/v1beta1/workload/pods/events",
+                        "methods": [
+                            {
+                                "method": "get",
+                                "description": "Get pod events by id which is consists of cluster, namespace and pod name. seperated by $. e.g.)id=cluster1$namespace1$pod1"
+                            }
+                        ]
+                    },
+                    {
+                        "path":"/api/mcm/resource/v1beta1/workload/pods/metrics",
+                        "methods": [
+                            {
+                                "method": "get",
+                                "description": "Get pod metrics by id which is consists of cluster, namespace and pod name. seperated by $. e.g.)id=cluster1$namespace1$pod1"
+                            }
+                        ]
+                    },
+                    {
+                        "path":"/api/mcm/resource/v1beta1/accesscontrol/clusterrolebindings",
+                        "methods": ["get", "delete"]
+                    },
+                    {
+                        "path":"/api/mcm/resource/v1beta1/clusters",
+                        "methods": [
+                            {
+                                "method":   "get",
+                                "description": "Get clusters using the query parameters"
+                            }
+                        ]
+                    }
+                ]
+            }
+        },
+        {
+            "backend": "zcp-monitoring-backend",
+            "config": {
+                "file_path": "runner/openapi/zcp/zcp_monitoring_backend_openapi_spec.json",
+                "prefix": "/api/monitoring/v1beta1",
+                "apis": [
+                    {
+                        "path":"/api/monitoring/v1beta1/realms/{realm}/rules/{namespace}",
+                        "methods": [
+                            {
+                                "method": "get",
+                                "description": "Get rule groups by realm and namespace"
+                            }
+                        ]
+                    },
+                    {
+                        "path":"/api/monitoring/v1beta1/realms/{realm}/events",
+                        "methods": [
+                            {
+                                "method": "get",
+                                "description": "Get events by realm"
+                            }
+                        ]
+                    },
+                    {
+                        "path":"/api/monitoring/v1beta1/realms/{realm}/metrics/clusters",
+                        "methods": [
+                            {
+                                "method": "get",
+                                "description": "Get metrics of clusters by realm"
+                            }
+                        ]
+                    },
+                    {
+                        "path":"/api/monitoring/v1beta1/realms/{realm}/metrics/nodes",
+                        "methods": [
+                            {
+                                "method": "get",
+                                "description": "Get metrics of nodes by realm"
+                            }
+                        ]
+                    },
+                    {
+                        "path":"/api/monitoring/v1beta1/realms/{realm}/metrics/pods",
+                        "methods": [
+                            {
+                                "method": "get",
+                                "tool_name": "get_metrics_of_pods_by_realm",
+                                "description": "Get metrics of pods by realm"
+                            }
+                        ]
+                    }
+                ]
+            }
+        }
+    ]
+}
+```
+
+For more detailed usage instructions, please refer to our [documentation](link).
+
+## Development Setup
+
+1. Clone the repository
+```bash
+git clone https://github.com/yourusername/axmp-openapi-helper.git
+cd axmp-openapi-helper
+```
+
+2. Create and activate virtual environment
+```bash
+python -m venv .venv
+source .venv/bin/activate  # Windows: venv\Scripts\activate
+```
+
+3. Install development dependencies
+```bash
+poetry install
+```
+
+## Contributing
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Contact
+
+- Issue Tracker: https://github.com/cloudz-mp/axmp-openapi-helper/issues
+- Email: kilsoo75@gmail.com
+
+