Change Log

The API Change Log provides a detailed history of updates, changes, and fixes made to the Roomex PMS API. It helps integrators understand version-specific features and plan for upgrades. Each version includes a description of changes, the release date, and any deprecated features.

Format

1. Version Overview

• Version Number: Semantic versioning (e.g., 1.0.0, 1.1.0, 2.0.0).
• Release Date: The date the version was released.
• Summary: A brief description of the changes.

2. Changes by Category

• Added: New features or endpoints.
• Changed: Updates to existing features.
• Deprecated: Features marked for future removal.
• Removed: Features that are no longer supported.
• Fixed: Bugs that were resolved.

3. Upgrade Notes

Include any steps or considerations for upgrading to the new version.

Example Change Log Entries

Version 2.0.0

Release Date: 2025-02-15 Summary: Major release introducing authentication improvements and new reservation endpoints.

• Added:
  • New endpoint: POST /api/v2/card/authenticate for enhanced user validation.
  • New error codes for reservation workflows.
• Changed:
  • GET /api/v1/reservation/status now includes lastModifiedDate.
  • Updated response format for POST /api/v1/card/authorize to include incidentalsCoverageDetails.
• Deprecated:
  • Endpoint POST /api/v1/card/authorize will be removed in version 3.0.0.
• Fixed:
  • Resolved timeout issues on POST /api/v1/reservation/checkin.
  • Fixed incorrect error message for invalid membershipId.

Upgrade Notes:

• Update integrations to use POST /api/v2/card/authenticate for future compatibility.
• Review updated response fields in GET /api/v1/reservation/status.

Roomex's Change Log Approach

1. Use Semantic Versioning: Follow the MAJOR.MINOR.PATCH format:
   • MAJOR: Breaking changes.
   • MINOR: Backward-compatible feature additions.
   • PATCH: Backward-compatible bug fixes.
2. Be Clear and Concise: Describe changes in developer-friendly language.
3. Update Regularly: Ensure the log is updated with every release.
4. Provide Examples: Add example payloads or code snippets for new features.
5. Include Deprecation Warnings: Inform developers about future removals.