Changelog

All notable changes to the Bill Tracking API will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

Planned Features

• OAuth 2.0 authentication support
• GraphQL API endpoint
• Webhook notifications for bill status changes
• Batch operations for bill tracking
• Advanced search with ElasticSearch integration
• Real-time WebSocket connections for live updates

[1.0.0] - 2025-01-28

Added

• Initial public release of Bill Tracking API
• Core endpoints for bill tracking and monitoring
• Activity logging system for audit trails
• Advocacy campaign management
• Bill event calendar functionality
• Capitol report generation
• Multi-tenant architecture with header-based authentication
• Comprehensive dropdown/reference data endpoints
• Rate limiting (1000 requests/hour per tenant)
• Support for pagination in all list endpoints
• Error handling with standardized response format

Endpoints Included

• Activity Logging: /api/1.0/activity/log/*
• Advocacy: /api/1.0/Advocacy/*
• Bill Events: /api/1.0/bill/event/*
• Capitol Reports: /api/1.0/CapitolReport/*
• Dropdown Data: /api/1.0/dropdown/*
• Data Sync: /api/1.0/DataSync/*
• Client Management: /api/1.0/client/*

Security

• HTTPS required for all API calls
• Header-based authentication with api-version and tenant-code
• Request validation and sanitization
• Rate limiting to prevent abuse

Documentation

• Comprehensive API documentation
• OpenAPI 3.0 specification
• Postman collection for testing
• Integration examples in multiple languages
• Quick reference guide

---

Migration Guides

Migrating to v1.0.0

If you're migrating from a beta or pre-release version:

Breaking Changes

• Authentication headers are now mandatory
• Date format standardized to ISO 8601
• Pagination parameters renamed:
  • page → pageNumber
  • limit → pageSize
• Error response structure standardized

Required Header Changes

- X-API-Key: YOUR_API_KEY
+ api-version: 1.0
+ tenant-code: YOUR_TENANT_CODE

Date Format Changes

- "date": "01/15/2025"
+ "date": "2025-01-15"

- "timestamp": "2025-01-15 14:30:00"
+ "timestamp": "2025-01-15T14:30:00Z"

Pagination Changes

{
-  "page": 1,
-  "limit": 20,
+  "pageNumber": 1,
+  "pageSize": 20,
   "sortBy": "date",
   "isAscending": false
}

Error Response Changes

{
-  "error": true,
-  "errorMessage": "Invalid request",
+  "error": "ValidationError",
+  "message": "Invalid request",
+  "details": {
+    "code": "VALIDATION_FAILED",
+    "timestamp": "2025-01-28T10:30:00Z",
+    "requestId": "req-123456"
+  }
}

---

Version History

Version	Release Date	Status	Support Until
1.0.0	2025-01-28	Current	Active
0.9.0	2024-12-01	Deprecated	2025-06-01
0.8.0	2024-10-15	Unsupported	2025-01-01

---

Deprecation Policy

• Deprecation Notice: 6 months advance notice for breaking changes
• Sunset Period: 12 months support after deprecation
• Migration Support: Migration guides and tools provided
• Communication: Email notification to all registered developers

Deprecation Timeline Example

1. Announcement (Month 0): Feature marked as deprecated
2. Migration Period (Months 1-6): Both old and new versions supported
3. Final Warning (Month 6): Reminder sent to remaining users
4. Sunset (Month 12): Deprecated feature removed

---

How to Stay Updated

Notification Channels

• Email: Subscribe at developers.engagifii.com
• RSS Feed: https://api.engagifii.com/changelog.rss
• Status Page: https://status.engagifii.com
• Developer Portal: https://developers.engagifii.com

Version Headers

Check the current API version in response headers:

X-API-Version: 1.0.0
X-API-Deprecated: false
X-API-Sunset-Date: null

---

Reporting Issues

Found a bug or have a feature request?

Bug Reports

Email: api-bugs@engagifii.com

Include:

• API version
• Tenant code (do not include sensitive data)
• Request/response examples
• Error messages and timestamps
• Steps to reproduce

Feature Requests

Submit via: https://developers.engagifii.com/feature-requests

Security Issues

Do not report security issues publicly Email: security@engagifii.com

---

Release Notes Format

Version Naming

• Major (X.0.0): Breaking changes
• Minor (1.X.0): New features, backward compatible
• Patch (1.0.X): Bug fixes, backward compatible

Change Categories

• Added: New features
• Changed: Changes in existing functionality
• Deprecated: Soon-to-be removed features
• Removed: Removed features
• Fixed: Bug fixes
• Security: Security patches

---

This changelog is maintained by the Engagifii API TeamLast Updated: 2025-01-28