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.33 - 2025-11-22
🔧 Changed
- Made "Tell Us About Your Project" field required in early access application form (#276)
- Updated early access messaging to rolling basis acceptance instead of fixed capacity
- Updated API access description to clarify read-only beta access
📦 0.2.32 - 2025-11-22
🔄 API Updates
- API Release 0.7.5 - Updated documentation with latest API release information and synchronized changelog
📦 0.2.31 - 2025-11-16
🐛 Fixed
- Fixed backticks still being interpreted in build-release workflow (#271)
- Changed from
echotoprintfto prevent ALL shell interpretation - Resolves backticks being stripped from release notes
- Resolves validation script being accidentally executed during release note generation
- Fixes command substitution errors that occurred despite using
--notes-file
- Changed from
- Fixed wrong version comparison link in release notes (#271)
- Changed auto-detection to use most recent tag (not 2nd most recent)
- Script runs before new tag exists, so it should compare against the current latest
- Fixes comparison links showing wrong previous version (e.g., 0.2.28 instead of 0.2.29)
📦 0.2.30 - 2025-11-16
🐛 Fixed
- Fixed build-release workflow failing with backticks in release notes (#267)
- Updated GitHub Actions workflow to use
--notes-fileinstead of inline--notes - Prevents shell interpretation of markdown backticks as command substitution
- Resolves "command not found" errors during automated releases
- Updated GitHub Actions workflow to use
- Fixed update-changelog.sh creating CHANGELOG.md in wrong location (#267)
- Corrected PROJECT_ROOT path calculation (now goes up 2 levels instead of 1)
- CHANGELOG.md now correctly updates in project root instead of scripts/ directory
✨ Added
- Added release notes validation script (#267)
- New
scripts/validation/validate-release-notes.shvalidates changelog structure - Checks for shell-unsafe characters in release notes
- Verifies release notes can be generated successfully
- Runs automatically in CI on all PRs to main/develop/release branches
- Prevents merge if validation fails
- New
📦 0.2.29 - 2025-11-16
✨ Added
- OAuth scopes and authorization documentation for v0.6.0 (#244)
- NEW: Authorization and OAuth Scopes concepts page - Comprehensive 700+ line guide covering:
- Five granular OAuth scopes: read:published, read:draft, read:all-status, write, delete
- Status-based access control and automatic filtering
- Scope combinations for different use cases (public apps, admin tools, CMS)
- Requesting scopes with code examples in 4 languages (PHP, JavaScript, Python, cURL)
- Security best practices and principle of least privilege
- Troubleshooting scope errors (insufficient_scope, not seeing expected data)
- Migration guide from simple read/write scopes to granular scopes
- Enhanced Getting Started authentication guide with "Understanding OAuth Scopes" section
- Updated all OAuth authentication examples to use granular scopes (read:published write)
- Added to Concepts section in navigation
- Clarified scope selection for Personal Access Tokens
- NEW: Authorization and OAuth Scopes concepts page - Comprehensive 700+ line guide covering:
- NEW: How-To section - Task-focused step-by-step tutorials (#243)
- Created new "How-To" documentation category positioned between Concepts and Guides
- Clear separation: Concepts (reference) → How-To (tasks) → Guides (applications)
- NEW: Upload Card Images tutorial - Comprehensive 900+ line step-by-step guide covering:
- Image preparation and validation requirements
- Complete upload workflow for front and back images
- Code examples in 4 languages (PHP, JavaScript, Python, cURL) with error handling
- Retrieving and verifying uploaded images with ?include=images
- Responsive display techniques using automatic thumbnails
- Update and delete operations
- Inline troubleshooting at each step (file size, dimensions, MIME types, duplicates, auth errors)
- Cross-links to advanced guides (responsive images, CDN integration, building card tracker)
- How-To index page with section overview and navigation
- Scalable structure for future task-focused tutorials
- Card Images highlighted in Getting Started guide (#242)
- Added Card Images to core resources table in introduction.md
- Added Card Images to Core Resources diagram in overview.md
- Enhanced "Image Delivery" section to "Card Images & Delivery" with upload/management capabilities
- Linked to Working with Images guide for detailed documentation
- Card Images now prominently featured as a core API capability (v0.7.0)
- Card model documentation updates for v0.6.0 and v0.7.0 (#240)
- NEW: Card code examples section - Comprehensive examples showing
image_uuidfield and?include=imagesparameter - Code examples in all 4 languages (PHP, JavaScript, Python, cURL) demonstrating:
- Fetching cards with
image_uuidfield (v0.6.0+) - Including card images in responses using
?include=images(v0.7.0+) - Listing cards with images and processing included resources
- Fetching cards with
- Updated Building Card Tracker guide:
- Added
image_uuidto Card data structure example - Added
imagesrelationship to Card data structure - NEW: "Fetching Cards with Images" section - Practical examples showing efficient image fetching patterns
- Added
- Created API repo issue #1089 for OpenAPI spec updates (missing
imagesrelationship documentation)
- NEW: Card code examples section - Comprehensive examples showing
- Set Sources API documentation for v0.6.0 (#239)
- NEW: Data Provenance and Set Sources concepts page - Comprehensive guide explaining what Set Sources are, why to use them, and best practices
- Comprehensive code examples in all 4 languages (PHP, JavaScript, Python, cURL)
- Create, list, retrieve, update, and delete set source operations
- Filter sources by set ID examples
- Include sources in set requests (?include=sources)
- Source verification tracking examples
- Track multiple source types (checklist, metadata, images)
- Added "Set Source Tracking and Data Attribution" section to Collection Management guide
- Practical integration examples for data provenance and verification
- Best practices for source management and attribution
- Added Data Quality section to Concepts index
- Comprehensive card images code examples for all languages (#238)
- NEW: cURL examples - Complete command-line examples for all Card Images operations
- Enhanced PHP examples with file validation, error handling, update/delete operations
- Enhanced JavaScript examples with upload progress tracking using axios
- Enhanced Python examples with progress tracking using requests-toolbelt
- Upload examples with file size and type validation in all languages
- List card images examples for filtering by card ID
- Download examples with CDN redirect handling and error checking
- Update image metadata examples (changing front/back type)
- Delete card image examples with error handling
- Batch download examples for all size variants
- Added cURL to code examples index and navigation sidebar
- All examples include comprehensive error handling and best practices
- Personal Access Token (PAT) authentication documentation for v0.6.0 (#241)
- Comprehensive PAT authentication guide with step-by-step token generation
- Comparison table between OAuth 2.0 and PAT authentication methods
- Code examples for PAT initialization in PHP, JavaScript, and Python
- Security best practices for token management and storage
- Token management guide (viewing, revoking, rotating)
- PAT troubleshooting section with common issues and solutions
- Updated authentication overview to include both OAuth and PAT methods
- Updated Getting Started guide to mention PAT as development-friendly option
- Enhanced all code examples with PAT authentication alongside OAuth
- Card Images API documentation for v0.7.0 (#234)
- Complete endpoint reference for all 6 Card Images endpoints
- Comprehensive "Working with Images" guide with upload, download, and management examples
- File upload examples in PHP, JavaScript, and Python code examples
- Card image management section in Building Card Tracker guide
- Image validation, caching, and best practices documentation
- Support for front/back images with size variants (thumbnails)
- Image thumbnails and responsive images documentation (#235)
- New "Responsive Card Images" comprehensive guide with srcset, sizes, picture element, and lazy loading
- Responsive image code examples in PHP, JavaScript, and Python
- Detailed thumbnail size specifications (small 150px, medium 300px, large 600px)
- Enhanced download endpoint documentation with size variant details
- Performance best practices for responsive image delivery
- Framework integration examples (React, Vue, vanilla JS)
- CDN integration documentation for v0.7.0 (#236)
- Comprehensive "CDN Integration" guide with versioned URLs and cache invalidation
- CDN redirect behavior documentation (302 to CDN, not proxied)
- Cache header documentation (1-year TTL, immutable directive)
- Global edge delivery and performance optimization guide
- URL structure and version parameter documentation
- Complete integration examples in PHP, JavaScript, and Python
- Troubleshooting guide for CDN-related issues
- Performance expectations and monitoring best practices
🔧 Changed
- Simplified release notes generation to use CHANGELOG.md content directly (#228)
- Updated GitHub release v0.2.23 with actual changelog content instead of generic placeholders
- Updated OpenAPI specification from API repository (includes Card Images API)
- Enhanced documentation generator script with multipart/form-data file upload examples
- Enhanced documentation generator with responsive image examples (#235)
- Updated "Working with Images" guide with cross-references to responsive images guide (#235)
- Updated code examples to use versioned CDN URLs (#236)
- PHP examples show fetching metadata with versioned URLs
- JavaScript examples include React component with CDN URLs
- Python examples demonstrate Flask/Django integration with versioned URLs
- Enhanced "Responsive Card Images" guide with versioned URL documentation (#236)
- Updated "Working with Images" guide with CDN delivery information (#236)
- Added CDN integration to Getting Started overview (#236)
- Added CDN Integration to Concepts index (#236)
🐛 Fixed
- Corrected image size specifications in "Working with Images" guide (was 400px/800px/1200px, now correctly 150px/300px/600px) (#235)
🗑️ Removed
- Automatic git commit parsing from release notes generation (#228)
- Generic placeholder content from release notes generator
- Deployment information section from release notes
- Contributing links section from release notes
📦 0.2.28 - 2025-11-15
🔧 Changed
- Updated API changelog documentation to include version 0.7.3
- Updated release statistics to reflect latest API version 0.7.3
- Updated version information throughout API changelog
🔄 API Updates
- API Release 0.7.3 - Updated documentation with latest API release information and synchronized changelog
📦 0.2.27 - 2025-11-15
🔧 Changed
- Updated API changelog documentation to include version 0.7.2
- Updated release statistics to reflect latest API version 0.7.2
- Updated version information throughout API changelog
🔄 API Updates
- API Release 0.7.2 - Updated documentation with latest API release information and synchronized changelog
📦 0.2.26 - 2025-11-15
🔧 Changed
- Updated API changelog documentation to include version 0.7.1
- Updated release statistics to reflect latest API version 0.7.1
- Updated version information throughout API changelog
🔄 API Updates
- API Release 0.7.1 - Updated documentation with latest API release information and synchronized changelog
📦 0.2.25 - 2025-11-15
🔧 Changed
- Updated API changelog documentation to include version 0.7.0
- Updated release statistics to reflect latest API version 0.7.0
- Updated version information throughout API changelog
🔄 API Updates
- API Release 0.7.0 - Updated documentation with latest API release information and synchronized changelog
📦 0.2.24 - 2025-11-11
🔧 Changed
- Updated API changelog documentation to include versions 0.6.0 and 0.6.1
- Updated release statistics to reflect latest API version 0.6.1
- Updated version information throughout API changelog
🔄 API Updates
- API Release 0.6.1 - Updated documentation with API version 0.6.1 changelog (version script hotfix)
- API Release 0.6.0 - Updated documentation with API version 0.6.0 changelog (major feature release)
📦 0.2.23 - 2025-11-08
✨ Added
- Brevo API integration for email marketing (#207)
- NewsletterForm component with double opt-in (#209)
- EarlyAccessForm component with 6 fields and Brevo integration (#210)
- Homepage newsletter signup section (#211)
- Footer newsletter form (all pages) (#212)
- Blog post newsletter section (#213)
- Early Access application page at
/early-access(#214) - Newsletter confirmation page at
/newsletter-confirmed(#215) - Early access submitted page at
/early-access-submitted(#215) - Newsletter subscription opt-in for early access applicants
- First and last name capture in forms
- Comprehensive form validation and analytics tracking
- Comprehensive versioning and release system similar to API repository
- Automated semantic version generation based on git history and branch types
- 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 workflow for build validation and script testing
- Release notes generation for GitHub releases
- GitHub deployment integration with DigitalOcean App Platform
- Professional deployment tracking and status updates
- Comprehensive PHP SDK documentation suite with detailed guides
- SDK overview page with feature comparison and roadmap
- Complete PHP SDK installation and setup guide
- PHP SDK quick start guide with all usage patterns (facade, helper, direct class)
- Detailed API resources reference covering all 10+ available resources
- Comprehensive error handling documentation with exception hierarchy
- Real-world PHP SDK examples (price tracking, collection management, marketplace integration)
- Laravel-specific integration patterns (controllers, commands, jobs, testing)
🔧 Changed
- Simplified release workflows - removed unnecessary beta/RC workflows for documentation site
- Reorganized version scripts with consistent .sh file extensions
- Streamlined deployment process with controlled releases (auto-deploy disabled)
- Updated PHP SDK documentation with correct package name and installation steps
- Streamlined PHP SDK overview page to eliminate redundancy with sub-pages
🐛 Fixed
- Corrected PHP SDK package name from tradingcardapi/php-sdk to cardtechie/tradingcardapi-sdk-php
- Fixed PHP SDK installation instructions to include Laravel-specific setup
- Updated minimum requirements to PHP 8.1+ and Laravel 10.0+
- Corrected GitHub repository links throughout PHP SDK documentation
- Fixed PROJECT_ROOT path calculation in version-bump.sh script
- Removed redundant lint step from CI workflow
🗑️ Removed
- Non-existent PHP SDK documentation site link from support section