• ST-4372 Removed check for empty entity claims on a party
We noticed a breaking change for people using the NPL API client generation from OpenAPI specification files
The addition of the pageSize parameter for list getter functions breaks the usage of clients without named parameters.
We noticed in the typescript-axios client. Please let us know if it breaks other clients.
Adding an optional query parameter like pageSize is not considered a breaking change under standard API practices. According to the OpenAPI Diff project’s formal definition of breaking changes, introducing an optional request parameter is classified as a non-breaking change. This aligns with REST API principles, which state that clients should handle additional optional parameters gracefully.
If issues arise when using the generated typescript-axis client, they likely stem from how the client code manages optional parameters, rather than from the API change itself. Ensuring that client implementations can accommodate optional parameters will maintain compatibility with the API.