conjure-java icon indicating copy to clipboard operation
conjure-java copied to clipboard

More descriptive error messages when generation fails due to invalid query param type

Open mpritham opened this issue 9 months ago • 1 comments

Before this PR

Deserialization of query parameters of type <container>[<container>[T]] are ambiguous. If we encounter an empty value over the wire, we're not able to disambiguate an empty collection from a missing value. We throw an error with the message "unknown type" which isn't as descriptive as it could be.

Additionally, we should throw an error earlier during Conjure definition validation defined in this class cc: @kunalrkak

After this PR

==COMMIT_MSG== More descriptive error messages when generation fails due to invalid query param types ==COMMIT_MSG==

Possible downsides?

mpritham avatar Mar 04 '25 15:03 mpritham

Generate changelog in changelog/@unreleased

What do the change types mean?
  • feature: A new feature of the service.
  • improvement: An incremental improvement in the functionality or operation of the service.
  • fix: Remedies the incorrect behaviour of a component of the service in a backwards-compatible way.
  • break: Has the potential to break consumers of this service's API, inclusive of both Palantir services and external consumers of the service's API (e.g. customer-written software or integrations).
  • deprecation: Advertises the intention to remove service functionality without any change to the operation of the service itself.
  • manualTask: Requires the possibility of manual intervention (running a script, eyeballing configuration, performing database surgery, ...) at the time of upgrade for it to succeed.
  • migration: A fully automatic upgrade migration task with no engineer input required.

Note: only one type should be chosen.

How are new versions calculated?
  • ❗The break and manual task changelog types will result in a major release!
  • 🐛 The fix changelog type will result in a minor release in most cases, and a patch release version for patch branches. This behaviour is configurable in autorelease.
  • ✨ All others will result in a minor version release.

Type

  • [ ] Feature
  • [x] Improvement
  • [ ] Fix
  • [ ] Break
  • [ ] Deprecation
  • [ ] Manual task
  • [ ] Migration

Description More descriptive error messages when generation fails due to invalid query param types

Check the box to generate changelog(s)

  • [x] Generate changelog entry

changelog-app[bot] avatar Mar 04 '25 15:03 changelog-app[bot]

This PR has been automatically marked as stale because it has not been touched in the last 14 days. If you'd like to keep it open, please leave a comment or add the 'long-lived' label, otherwise it'll be closed in 7 days.

stale[bot] avatar Jun 27 '25 04:06 stale[bot]