REST API Guidelines Changelog¶

This page contains the changelog of the REST API Guidelines. You find the sources of all released versions of the REST API Guidelines here.

February 27, 2025: Release of version 2.4.0¶

• Added recommendations for common meta data
• Added Tools page
• Improved wording of link names in pagination section

July 12, 2024: Release of version 2.3.0¶

• Aligned wording used for API, API client and API provider in the API Media Type Guidelines
• Improved the JSON examples in the API Media Type Guidelines
• Decreased severity of API version response headers to SHOULD, see API Versioning
• Added Optimistic Locking with ETags to best practices
• Overhaul of Sparse Fieldsets section

February 21, 2024: Release of version 2.2.0¶

• Added Security section
• Added Caching with ETags to best practices
• Added Correlation IDs and tracing in distributed systems to best practices
• Added Bulk Operations section
• Included Scope section
• Improved readability
• Aligned code snippet formatting

Sep 12, 2023: Release of version 2.1.0¶

• Introduced rules for filtering of resource collection responses (rule number 400 - 401)
• Introduced rules for common operations on resources (rule number 800 - 804)
• Incorporated review comments on media type rules
  • changed pluralize rule to be separate from document
  • changed links to JSON document RFC
• Other fixes

April 27, 2023: Release of version 2.0.0¶

• Completely new rewritten Guideline for technology REST
• Introduced rule hierarchy
• Introduced rule numbering and fixed anchor for references
• New Siemens Xcelerator cross-BU process