Pydantic, exclude_defaults=True re-add apiVersion and kind

[haarchri]

Description of your changes

In Pydantic, exclude_defaults=True in model_dump excludes fields that have their value equal to the default. If a field like
apiVersion is set to its default value 's3.aws.upbound.io/v1beta2' (and not explicitly provided during initialization), it will be excluded from the serialized output.

so we will explicit add apiVersion and kind

Fixes #

I have:

• Read and followed Crossplane's contribution process.
• Added or updated unit tests for my change.

Tests

tested via

dependencies = [
  "click==8.1.7",
  "grpcio==1.66.2",
  "crossplane-function-sdk-python @ git+https://github.com/haarchri/function-sdk-python@test"
]

[tool.hatch.metadata]
allow-direct-references = true

before:

up composition render  apis/xstoragebuckets/composition.yaml examples/storagebucket/example.yaml
---
apiVersion: platform.example.com/v1alpha1
kind: XStorageBucket
metadata:
  name: example
status:
  conditions:
  - lastTransitionTime: "2024-01-01T00:00:00Z"
    message: 'Unready resources: bucket'
    reason: Creating
    status: "False"
    type: Ready
---
metadata:
  annotations:
    crossplane.io/composition-resource-name: bucket
  generateName: example-
  labels:
    crossplane.io/composite: example
  ownerReferences:
  - apiVersion: platform.example.com/v1alpha1
    blockOwnerDeletion: true
    controller: true
    kind: XStorageBucket
    name: example
    uid: ""
spec:
  forProvider:
    region: us-west-1

—

with this PR:

up composition render  apis/xstoragebuckets/composition.yaml examples/storagebucket/example.yaml
---
apiVersion: platform.example.com/v1alpha1
kind: XStorageBucket
metadata:
  name: example
status:
  conditions:
  - lastTransitionTime: "2024-01-01T00:00:00Z"
    message: 'Unready resources: bucket'
    reason: Creating
    status: "False"
    type: Ready
---
apiVersion: s3.aws.upbound.io/v1beta1
kind: Bucket
metadata:
  annotations:
    crossplane.io/composition-resource-name: bucket
  generateName: example-
  labels:
    crossplane.io/composite: example
  ownerReferences:
  - apiVersion: platform.example.com/v1alpha1
    blockOwnerDeletion: true
    controller: true
    kind: XStorageBucket
    name: example
    uid: ""
spec:
  forProvider:
    region: us-west-1

[negz]

I don't love this workaround but I can't think of a better option.

I used exclude_defaults to stop model_dump from serializing optional fields as explicit None values. We could use exclude_none instead, but I think apart from apiVersion and kind we really don't want to include defaults - since we want to leave the defaulting to server-side apply.

[negz]

Actually, how feasible would it be to do the following?

1. Update the models to remove all default values (except for apiVersion and kind)
2. Switch to exclude_none

[haarchri]

people will lose the information which default values are available - in lsp - mhm

[haarchri]

apiVersion and kind are special - so i don't think the solution at all is a problem

[negz]

Overriding failing tests - they need to be fixed in main.