Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an option to serialize empty collection fields #419

Merged
merged 3 commits into from
Feb 4, 2025

Conversation

sfackler
Copy link
Member

@sfackler sfackler commented Jan 21, 2025

Before this PR

Serialized objects would always omit empty collection fields. Some Conjure implementations fail to handle these properly.

After this PR

==COMMIT_MSG==
Add an option to serialize empty collection fields.
==COMMIT_MSG==

Closes #372

@sfackler sfackler requested a review from a team January 21, 2025 21:21
@changelog-app
Copy link

changelog-app bot commented Jan 21, 2025

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
  • Improvement
  • Fix
  • Break
  • Deprecation
  • Manual task
  • Migration

Description

Add an option to serialize empty collection fields.

Check the box to generate changelog(s)

  • Generate changelog entry

@sfackler sfackler merged commit 6a686d4 into master Feb 4, 2025
5 checks passed
@sfackler sfackler deleted the include-empty-collections branch February 4, 2025 18:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Include optional keys when serializing objects
4 participants