v2.0.1 - Success Response Refinement & Cleaner Payloads

[PasinduOG]

We are happy to announce the release of API Response v2.0.1! 🎉

This release focuses on optimizing response payloads, improving the separation of concerns, and providing cleaner JSON structures for your successful API calls.

⚠️ Note: This release includes a structural change to success responses. Please review the migration notes below before upgrading.

🚀 What's New & Changed?

🧹 Removed Trace ID from Success Responses

To drastically clean up success payloads and reduce JSON size, we have removed the traceId field from standard success responses (ApiResponse).

• Why? Trace IDs are primarily meant for tracking issues. Including them in every single successful response unnecessarily bloated the payload.
• Errors still have them: Trace IDs are still automatically included in all error responses (ProblemDetail format) generated by the GlobalExceptionHandler.
• Tracing Success Flows: If you need distributed tracing for success flows, we recommend using HTTP headers in combination with the provided TraceIdFilter.

✨ Improvements

• Cleaner JSON Payloads: Your success responses are now laser-focused on essential data (status, message, content, timestamp).
• Better Separation of Concerns: Error tracking belongs in error payloads, while distributed tracing belongs in HTTP headers.
• Reduced Bandwidth: Smaller response bodies mean faster API responses and reduced bandwidth consumption.

---

🔄 Migration Guide (v2.0.0 ➡️ v2.0.1)

If your client applications or tests were explicitly asserting the existence of a traceId in success responses, you will need to update them.

❌ Before (v2.0.0 Success Response):

{
  "status": 200,
  "traceId": "550e8400-e29b-41d4-a716-446655440000",
  "message": "User found",
  "content": { ... },
  "timestamp": "2026-02-15T10:30:45.123Z"
}

✅ After (v2.0.1 Success Response):

{
  "status": 200,
  "message": "User found",
  "content": { ... },
  "timestamp": "2026-02-15T10:30:45.123Z"
}

(Error responses remain unchanged and will still include the traceId)

---

📦 Installation

Update your dependency to version 2.0.1:

Maven

<dependency>
    <groupId>io.github.pasinduog</groupId>
    <artifactId>api-response</artifactId>
    <version>2.0.1</version>
</dependency>

Gradle

implementation 'io.github.pasinduog:api-response:2.0.1'

---

Full Changelog: v2.0.0...v2.0.1

---

This discussion was created from the release v2.0.1 - Success Response Refinement & Cleaner Payloads.