Skip to main content

Changelog

Stay up-to-date with the latest changes, improvements, and new features in the Trading Card API documentation site.

Version History​

All notable changes to the Trading Card API Documentation are documented here. We follow Semantic Versioning and the Keep a Changelog format.

🚧 Unreleased​

What's Coming Next

These features are currently in development and will be included in the next release.

📦 [0.2.15] - 2025-09-24​

✨ Features​

  • OAuth vs API Keys Blog Post (#170) - Added comprehensive blog post comparing OAuth 2.0 and API Key authentication methods, explaining rationale for current OAuth implementation and announcing upcoming API key support

📦 0.2.14 - 2025-09-19​

🔧 Improvements​

  • Automation PR Enhancement (#158) - Enhanced API changelog automation to include site changelog updates and version bumps, uses hotfix branch prefix, and provides comprehensive PRs with all necessary site maintenance

📦 0.2.13 - 2025-09-19​

🐛 Bug Fixes​

  • API Changelog File Replacement (#155) - Fixed API changelog generation script to preserve historical data instead of replacing entire file, maintaining all previous release information while adding new releases

📦 0.2.12 - 2025-09-19​

🐛 Bug Fixes​

  • Script Force Flag and Workflow Token (#150) - Fixed --force flag handling in PR creation script and updated workflow to use CHANGELOG_UPDATE_TOKEN for proper PR creation permissions

📦 0.2.11 - 2025-09-19​

🐛 Bug Fixes​

  • PR Creation Label Requirements (#147) - Removed label requirements from create-changelog-pr.js to fix PR creation failures

📦 0.2.10 - 2025-09-19​

🐛 Bug Fixes​

  • runCommand Null Reference Error (#145) - Fixed null reference error in create-changelog-pr.js script when execSync returns null with stdio inherit

📦 0.2.9 - 2025-09-19​

🐛 Bug Fixes​

  • PR Creation Script Path (#143) - Fixed script path and internal path issues in create-changelog-pr.js preventing automated PR creation

📦 0.2.8 - 2025-09-19​

🐛 Bug Fixes​

  • API Changelog Script Path (#141, #142) - Fixed incorrect script path in api-changelog-update.yaml workflow preventing changelog generation

📦 0.2.7 - 2025-09-19​

🐛 Bug Fixes​

  • Webhook Validation for Repository Dispatch (#139, #140) - Fixed webhook secret validation for repository_dispatch events to work with GitHub's webhook system

📦 0.2.6 - 2025-09-18​

🐛 Bug Fixes​

  • Deployment Creation Token (#137) - Fixed deployment creation to use DEPLOY_APP_TOKEN instead of GITHUB_TOKEN for proper permissions

📦 0.2.5 - 2025-09-18​

🐛 Bug Fixes​

  • Deployment Workflow Not Triggering (#135, #136) - Fixed deployment workflow to actually trigger using DEPLOY_APP_TOKEN and proper deployment event pattern

📦 0.2.4 - 2025-09-18​

🐛 Bug Fixes​

  • Version Calculation and Release Notes Debugging (#132, #133) - Fixed version calculation and added release notes visibility to build logs

📦 0.2.3 - 2025-09-18​

🐛 Bug Fixes​

  • Build Release Workflow Versioning (#130, #131) - Fixed semantic versioning and improved release notes extraction from CHANGELOG.md

📦 0.2.2 - 2025-09-18​

🐛 Bug Fixes​

  • Build Release Workflow Permissions (#128, #129) - Fixed workflow permissions and modernized release creation using GitHub CLI

📦 0.2.1 - 2025-09-18​

🐛 Bug Fixes​

  • Build Release Workflow (#126, #127) - Fixed script paths to use new scripts/version/ directory structure

📦 0.2.0 - 2025-09-18​

🚀 Major Features Added​

  • Automated API Changelog System (#100, #101, #102)
    • Webhook-based automation for zero-maintenance API changelog updates
    • Intelligent change detection preventing unnecessary PRs
    • Enterprise-grade security with webhook secret validation
    • Comprehensive error handling with retry logic and debugging artifacts
    • Structured JSON output for advanced automation consumption
  • Blog Featured Images (#88)
    • Professional responsive featured image support for all blog posts
    • Mobile-first design with breakpoints (300px → 200px → 150px)
    • Manual BlogImage component with professional styling
    • Featured images for all existing blog posts
  • Live API Changelog Integration (#86, #99, #103)
    • Real-time API release information display
    • Complete integration with API repository changelog
    • Automatic synchronization with API releases
  • Comprehensive PHP SDK Documentation (#83, #91, #92, #95)
    • Complete PHP SDK documentation suite with guides and examples
    • SDK overview page with feature comparison and roadmap
    • Installation, quickstart, and advanced usage documentation
    • PHP SDK changelog integration and display
  • Professional Documentation Infrastructure (#82, #85, #97, #98)
    • API rate limits and quotas comprehensive documentation
    • Public changelog page with user-friendly formatting
    • Enhanced documentation structure and navigation

🔧 Technical Infrastructure Added​

  • Versioning and Release System (#84, #90)
    • Automated semantic version generation based on git history
    • Version management scripts (version.sh, version-bump.sh, version-preview.sh)
    • Automated changelog generation with commit categorization
    • GitHub Actions workflows for automated releases and deployments
  • CI/CD Pipeline Enhancements
    • Comprehensive CI workflow for build validation and script testing
    • Release notes generation for GitHub releases
    • GitHub deployment integration with DigitalOcean App Platform
    • Enhanced error handling and debugging capabilities

📝 Content and Documentation Added​

  • Professional Blog Content (#28, #43, #87, #89)
    • Trading Card API v0.4.0 release announcement blog post
    • Initial blog posts improving blog page display
    • Professional blog structure and formatting
  • Comprehensive Developer Guides (#29, #30, #31, #32, #33, #34, #44, #45, #46, #47, #48, #50)
    • Card price tracking application development guide
    • Collection management application development guide
    • Marketplace integration comprehensive guide
    • Mobile application integration guide
    • Data analysis applications development guide
    • Authentication services implementation guide
  • Enhanced Site Infrastructure (#35, #36, #49, #65, #66, #67)
    • Beta notice/disclaimer system for documentation pages
    • Comprehensive Google Analytics setup for production site
    • Fixed and updated all footer links with proper navigation

🔧 System Improvements and Optimizations​

  • API Reference and Navigation (#25, #27, #39, #40, #41, #42)
    • Updated and fixed API reference page functionality
    • Renamed master branch to main with updated workflows
    • Added admin site link to header navigation
    • Enhanced API reference structure and usability
  • Site Performance and User Experience (#23, #24, #37, #38)
    • Removed Algolia search to simplify site architecture
    • Removed dark/light mode toggle to fix styling issues
    • Streamlined site functionality for better performance
  • Deployment and Infrastructure (#12, #13, #14, #15, #16, #17, #18, #19, #20, #21)
    • Removed logo from site header for cleaner design
    • Removed GitHub link from header navigation
    • Removed Netlify from deployment options
    • Added Google Analytics integration
    • Homepage redesign from ready API to early access/beta
    • Enhanced deployment infrastructure

🐛 Critical Bug Fixes​

  • Production Stability (#68, #69)
    • Fixed production crash from undefined process variable
    • Resolved process undefined error affecting site stability
  • Documentation Links and Navigation (#93, #96)
    • Fixed broken links throughout documentation
    • Corrected anchor references to match Docusaurus generation
    • Updated all cross-references and internal linking
  • Infrastructure and Build Issues
    • Fixed featured image layout and positioning issues
    • Resolved CI workflow validation and build problems
    • Fixed PROJECT_ROOT path calculation in version management
    • Corrected PHP SDK installation and usage documentation

🗑️ Cleanup and Modernization​

  • Removed obsolete .cache/api-releases.json from repository
  • Removed redundant CI workflow steps and unused build processes
  • Removed GitHub Pages deployment (DigitalOcean handles deployment)
  • Removed unnecessary workflow files (build-develop.yaml, build-release-candidate.yaml)
  • Cleaned up version preview workflow (not needed for core functionality)
  • Streamlined build processes and removed redundant lint steps

📦 0.1.0 - 2025-09-16​

Initial Release

This marks the first major release of the Trading Card API documentation site with full feature parity.

✨ Added​

🏗️ Core Documentation Site​

  • Complete Docusaurus-based documentation site for Trading Card API
  • Responsive design with mobile-first approach
  • Custom styling and branding for Trading Card API

🏗️ Documentation Content​

  • Introduction and overview pages
  • Getting started guides (authentication, first request, overview)
  • Comprehensive API documentation (endpoints, models)
  • Code examples in JavaScript, PHP, and Python
  • Conceptual guides and filtering documentation

🏗️ Developer Guides​

  • Building card price tracker applications
  • Collection management system guides
  • Marketplace integration documentation
  • Mobile app integration guides
  • Data analysis and filtering guides
  • Authentication service documentation

🏗️ Interactive Features​

  • Live API explorer at /api endpoint
  • Interactive code examples with syntax highlighting
  • Beta notice system for user notifications
  • Google Analytics integration for usage tracking

🏗️ Blog System​

  • Blog posts about API updates and best practices
  • Author management system
  • RSS feed support for blog content
  • Welcome post and getting started tutorials

🏗️ Components and Features​

  • Custom React components (CodeExample, Stats, BetaNotice)
  • Homepage with hero section and feature highlights
  • Use case showcase (6 primary use cases)
  • Early access program integration
  • Contact forms and email integration

🏗️ Technical Infrastructure​

  • OpenAPI specification integration
  • Automatic API documentation generation
  • Static site generation and deployment
  • SEO optimization and meta tags
  • Privacy policy and terms of service pages

🏗️ Development Tools​

  • npm scripts for build, serve, and development
  • Hot reloading for development
  • Clear documentation structure
  • Version management system (this release)

🔗 Additional Resources​

📖 Related Documentation​

🐙 GitHub Resources​

🏷️ Version Information​

  • Current Version: Check the package.json for the latest version
  • Release Schedule: New versions are released as features are completed
  • Breaking Changes: We'll always provide migration guides for any breaking changes

🔔 Stay Updated​

📧 Get Notified​

💬 Community​

Questions or Feedback?

Have questions about a specific change or want to suggest improvements? We'd love to hear from you! Reach out through GitHub Issues or email support.