Changelog

All notable changes to this project will be documented in this file.

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

[Unreleased]

[2.3.1] - 2024-05-29

Fixed

• broken link to the internal WAF products. thx to R.D.

[2.3.0] - 2022-07-05

Added

• clarified preferences for data formats
• added preferences for schema technologies
• added best practices concerning state retrieval / initialload

Fixed

• Removed duplicate best practices
• Removed references of OpenAPI in the eventdriven documentation
• Removed considerations concerning postels law for greater simplicity in the best practices section

[2.2.0] - 2022-02-15

Added

• Updated references to superordinated SBB Architecture Principles, which underwent major changes
• Defined scope of application for SBB API Principles more precisely

[2.1.0] - 2021-04-08

Added

• New Architecture Principle: Smart endpoints and dumb pipes

[2.0.0] - 2020-11-20

Added

• Exception to security principle: Allowing API Keys for certain use cases

[1.7.0] - 2020-11-13

Added

• New principles: Must define API Plans

[1.6.0] - 2020-09-18

Added

• Best Practice: ODATA is not preferred, but allowed

[1.5.2] - 2020-08-14

Fixed

• Wrong code formatting in RESTful API Best Practices

[1.5.1] - 2020-08-13

Fixed

• Wrong Status code 405 -> 406 for Not Acceptable

[1.5.0] - 2020-07-24

Added

• New Best Practice: Handle duplicate messages

[1.4.0] - 2020-07-01

Added

• Introducing Changelog File
• Resolved open TODO: principle for backward compatibility

[1.3.0] - 2020-06-26

Added

• Semantic Versioning for API Principles
• New Best Practice: Define format for number and integer types
• New Best Practice: Path segment naming
• New Best Practice: Use snake_case for query parameters

  Fixed

• Switching from snake case to camel case in JSONs (adjusting API principles to already established best practices in organization) -> this is a change of recommended best practices and thus not considered as a breaking change
• Fixed some typos

[1.2.0] - 2020-04-17

Added

• Principle for standard APIs and APIs of commercial products and SaaS

[1.1.0] - 2020-03-27

Added

• Principles for CorrelationIDs and Tracing
• Principles for Event Driven APIs
• Adding code of conduct for contributions

  Fixed

• Some Typos and Styling

[1.0.0] - 2019-12-18

Added

• First version of SBB’s API Principles that is also approved by the central architecture board