powertools-lambda-java icon indicating copy to clipboard operation
powertools-lambda-java copied to clipboard

Maintenance: Audit & reduce public API surface area

Open scottgerring opened this issue 1 year ago • 1 comments

Summary

As part of the V2 improvements we have an opportunity to work on public-facing API changes. We should reflect on our current API surface and where there is room for improvement in terms of what is exposed to the user. Where we make a change from V1, we should document a migration path.

Why is this needed?

As it stands we have quite a large API surface area that can 1/ make it difficult for customers to use the API ("which one of these options should I use to interact with this module?) and 2/ make it difficult to maintain the modules, as any public API cannot be changed.

Which area does this relate to?

No response

Solution

No response

Acknowledgment

scottgerring avatar Jul 13 '23 08:07 scottgerring

This has been done for some modules:

  • Batch: #1317
  • Large messages: #1310
  • Metrics: #1041
  • Logging: #1435

This will be done for the other modules:

  • Idempotency: #1467
  • Parameters: #1403
  • Tracing: #1468
  • Validation: #1469
  • Serialization: #1470

scottgerring avatar Sep 28 '23 06:09 scottgerring