Param decoders often want to leverage the methods provided by PlainSerDe in order to get consistent handling of invalid inputs but are forced to instantiate their own local copy of UndertowRuntime. While this works today, it could be a bit dangerous in the future if the PlainSerDe becomes configurable and the behavior of the server's UndertowRuntime does not match the behavior of this local UndertowRuntime.
class FooParamDecoder implements CollectionParamDecoder<Foo> {
private static final PlainSerDe PLAIN_SER_DE =
ConjureUndertowRuntime.builder().build().plainSerDe();
@Override
public Foo decode(Collection<String> values) {
return PLAIN_SER_DE.deserializeComplex(values, FooParamDecoder::decode);
}
private decode(String value) { ... }
}
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.
`ParamDecoder` and `CollectionParamDecoder` types can not be instantiated with constructors that take `UndertowRuntime` and/or `Endpoint`.
**Check the box to generate changelog(s)**
- [x] Generate changelog entry
Param decoders often want to leverage the methods provided by
PlainSerDe
in order to get consistent handling of invalid inputs but are forced to instantiate their own local copy ofUndertowRuntime
. While this works today, it could be a bit dangerous in the future if thePlainSerDe
becomes configurable and the behavior of the server'sUndertowRuntime
does not match the behavior of this localUndertowRuntime
.