Skip to content

Releases: basher83/Proxmox-OpenAPI

v1.1.1 - Documentation & Project Organization

25 Jul 20:01
39ea826

Choose a tag to compare

📚 Documentation Improvements & Project Organization

This release focuses on establishing clear project direction and improving documentation for contributors and users.

✨ What's New

Documentation

  • ROADMAP.md: Comprehensive roadmap with feature tracking and implementation plans
    • 6 major features tracked with status indicators
    • Clear release timeline through Q1 2026
    • Success metrics and technical requirements

Dependency Management

  • Enhanced Renovate Configuration:
    • Semantic commits for all dependency updates
    • Dependency dashboard for better visibility
    • Automerge for dev dependencies and GitHub Actions
    • Security vulnerability alerts with automatic PRs
    • Grouped Python dependencies for easier review

🔄 Changes

  • Updated README.md to reference the new ROADMAP document
  • Corrected CHANGELOG dates to match actual repository history
  • Simplified project focus on appropriate tooling

🗑️ Removed

  • Removed all Dagger references and implementation strategy
  • Simplified containerization approach to use Docker/Docker Compose
  • Removed over-engineered solutions in favor of simpler alternatives

📊 Project Status

The project now has:

  • Clear versioning with proper git tags
  • Documented roadmap with prioritized features
  • Improved dependency management
  • Corrected historical timeline

🎯 Next Steps

According to our roadmap, the next priorities are:

  1. CI/CD Pipeline Enhancement (High Priority)
  2. Test Suite Implementation (High Impact)
  3. Enhanced Validation (Medium Priority)

📥 Downloads

Download the pre-generated specifications:

Full Changelog: v1.1.0...v1.1.1

v1.1.0 - Performance & Developer Experience

25 Jul 20:00
ac097a9

Choose a tag to compare

🚀 Performance Optimizations & Enhanced Development Experience

This release brings performance improvements and significantly enhanced developer tooling for a better contribution experience.

✨ What's New

Performance

  • orjson Integration: ~3% faster JSON serialization for large API specifications
  • Optimized Workflows: Streamlined CI/CD with native Python validation

Developer Experience

  • Claude AI Integration: Added .claude directory for AI-assisted development
  • MCP Server Support: Model Context Protocol integrations
  • Enhanced DevContainer: Modern tooling with VS Code extensions
  • Serena Project Configuration: Improved project management
  • Security Hooks: Pre/post tool use hooks for enhanced safety

Infrastructure

  • Secret Management: Infisical configuration support
  • Environment Setup: .envrc for GitHub token management
  • Performance Guide: Comprehensive documentation in docs/performance-guide.md

🔧 Changes

  • Updated to Python 3.13
  • Upgraded devcontainer to mcr.microsoft.com/devcontainers/universal:v3
  • Simplified CI/CD workflow
  • Scripts now output directly to target directories

🐛 Fixes

  • Fixed null type handling in parser
  • Regenerated API specifications with validation fixes
  • Cleaned up development artifacts and duplicate files

📊 Performance Metrics

Generation time improvements:

  • PVE API: ~3% faster
  • PBS API: ~3% faster
  • Memory usage: Unchanged

📥 Downloads

Download the pre-generated specifications:

Full Changelog: v1.0.0...v1.1.0

v1.0.0 - Initial Release

25 Jul 19:59

Choose a tag to compare

🎉 Initial Release - Unified Parser Implementation

This is the first official release of Proxmox OpenAPI specifications generator, featuring a unified parser for both Proxmox Virtual Environment (PVE) and Proxmox Backup Server (PBS) APIs.

✨ Features

  • Unified Parser: Central parsing engine for both PVE and PBS APIs
  • Performance Optimizations:
    • File caching (40-60% performance improvement)
    • Regex pattern pre-compilation (10-20% performance improvement)
  • Comprehensive OpenAPI 3.0.3 specification generation
  • Multi-format Output: JSON and YAML formats
  • Automated Validation: Built-in openapi-spec-validator

📊 API Coverage

  • PVE API: ~385 endpoints, ~687 operations, 3.8MB JSON output
  • PBS API: ~233 endpoints, ~348 operations, 1.1MB JSON output

🛠️ Technical Stack

  • Python 3.9+ with UV package manager
  • Ruff for code formatting and linting
  • MyPy for type checking

📥 Downloads

Download the pre-generated specifications:

🚀 Getting Started

# Clone the repository
git clone https://github.com/basher83/Proxmox-OpenAPI.git
cd Proxmox-OpenAPI

# Install dependencies with UV
uv sync --extra all

# Generate specifications
cd scripts/pve && uv run python generate_openapi.py && uv run python convert_to_yaml.py
cd scripts/pbs && uv run python generate_openapi.py && uv run python convert_to_yaml.py

Full Changelog: https://github.com/basher83/Proxmox-OpenAPI/commits/v1.0.0