Skip to main content

Enhanced Java SDK Documentation for Collected Parameters

· 2 min read

We've enhanced SDK documentation completeness and alignment with the actual implementation. This update includes model documentation for parameter collection classes and updated endpoint documentation that presents collected parameters as unified model references, resulting in clearer and more accurate SDK documentation.

Key Enhancements

Model Documentation Section

The SDK README's model documentation section now includes dedicated entries for parameter collection classes, making it easier for developers to understand and utilize these structured input models.

Endpoint Documentation Section

The SDK README's endpoint documentation section now presents collected parameters as unified model references rather than displaying individual inner parameters separately.

Compare how endpoint parameters are now documented:

Create User Profile

Creates a new user profile with personal information and preferences

Parameters
ParameterTypeTagsDescription
inputCreateUserProfileInputRequiredInput structure for the method CreateUserProfileAsync

Impact

Developers working with endpoints that use parameter collection will benefit from:

  • Clear visibility into the model classes used for parameter grouping
  • Streamlined endpoint documentation that matches the SDK's actual interface

These improvements are automatically applied when regenerating your SDK, ensuring your documentation stays synchronized with the underlying implementation without requiring any changes to your existing integration code.