Skip to content

Preserve x-kubernetes-preserve-unknown-fields when serializing plain YAML-loaded CRDs #3016

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.

Sign up for GitHub

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

Open
Copilot wants to merge 3 commits into
base: main
Choose a base branch
from
+66 −5
Open

Preserve x-kubernetes-preserve-unknown-fields when serializing plain YAML-loaded CRDs #3016

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eb08c49
Initial plan
Copilot Aug 17, 2026
c55f7fb
Preserve Kubernetes baseName fields during model serialization
Copilot Aug 17, 2026
dc9edb3
Address review feedback on serializer fallback key detection
Copilot Aug 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/gen/models/ObjectSerializer.ts
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

44 changes: 44 additions & 0 deletions src/serializer_test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,50 @@ describe('ObjectSerializer', () => {
});
});

it('should serialize known objects with Kubernetes baseName fields', () => {
const s = {
apiVersion: 'apiextensions.k8s.io/v1',
kind: 'CustomResourceDefinition',
metadata: {
name: 'foos.example.com',
},
spec: {
group: 'example.com',
scope: 'Namespaced',
names: {
plural: 'foos',
singular: 'foo',
kind: 'Foo',
},
versions: [
{
name: 'v1',
served: true,
storage: true,
schema: {
openAPIV3Schema: {
type: 'object',
properties: {
podTemplate: {
type: 'object',
'x-kubernetes-preserve-unknown-fields': true,
},
},
},
},
},
],
},
};
const res = ObjectSerializer.serialize(s, 'V1CustomResourceDefinition');
deepStrictEqual(
res.spec.versions[0].schema.openAPIV3Schema.properties.podTemplate[
'x-kubernetes-preserve-unknown-fields'
],
true,
);
});

[
{
name: 'should serialize a registered custom object',
Expand Down
22 changes: 18 additions & 4 deletions src/yaml_test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,13 @@ spec:
type: object
properties:
foobar:
anyOf:
- type: integer
- type: string
x-kubernetes-int-or-string: true
anyOf:
- type: integer
- type: string
x-kubernetes-int-or-string: true
podTemplate:
type: object
x-kubernetes-preserve-unknown-fields: true
`;
const ns = loadYaml<V1CustomResourceDefinition>(yaml);

Expand All @@ -48,6 +51,17 @@ spec:
ns.spec.versions[0]!.schema!.openAPIV3Schema!.properties!['foobar']['x-kubernetes-int-or-string'],
undefined,
);
strictEqual(
ns.spec.versions[0]!.schema!.openAPIV3Schema!.properties!['podTemplate']
.x_kubernetes_preserve_unknown_fields,
true,
);
strictEqual(
ns.spec.versions[0]!.schema!.openAPIV3Schema!.properties!['podTemplate'][
'x-kubernetes-preserve-unknown-fields'
],
undefined,
);
});

it('should load all safely', () => {
Expand Down