io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps does not retain extensions

[lburgazzoli]

i.e. there's no way to get the value of x-descriptors

  accessKey:
    title: Access Key
    description: The access key obtained from AWS
    type: string
    format: password
    x-descriptors:
    - urn:alm:descriptor:com.tectonic.ui:password

Looking at the JSONSchemaProps class, it looks like it handle a specific set of json extensions.

Would be nice to have a generic support for extensions.

[lburgazzoli]

Original issue: apache/camel-kamelets#284

[manusa]

That's a generated class, is your field be available in the additionalProperties?

[lburgazzoli]

I've tried with this:

///usr/bin/env jbang "$0" "$@" ; exit $?
//DEPS org.slf4j:slf4j-simple:1.7.30
//DEPS io.fabric8:kubernetes-client:5.4.1
//DEPS io.fabric8:camel-k-model-v1alpha1:5.4.1

import java.io.ByteArrayInputStream;
import java.nio.charset.StandardCharsets;
import io.fabric8.camelk.v1alpha1.Kamelet;
import io.fabric8.kubernetes.client.utils.Serialization;

class kl {
    public static String KAMELET = ""
        + "apiVersion: camel.apache.org/v1alpha1\n"
        + "kind: Kamelet\n"
        + "metadata:\n"
        + "  name: aws-s3-sink\n"
        + "spec:\n"
        + "  definition:\n"
        + "    type: object\n"
        + "    properties:\n"
        + "      accessKey:\n"
        + "        type: string\n"
        + "        format: password\n"
        + "        x-descriptors:\n"
        + "          - urn:alm:descriptor:com.tectonic.ui:password\n";
    
    public static void main(String... args) throws Exception {
        try (var is = new ByteArrayInputStream(KAMELET.getBytes(StandardCharsets.UTF_8))) {
            var result = Serialization.unmarshal(is, Kamelet.class);

            System.out.println("> " + result);
        }
    }
}

And what I get is an exception caused by:

com.fasterxml.jackson.databind.exc.UnrecognizedPropertyException: 
Unrecognized field "x-descriptors" (class io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaProps), 
not marked as ignorable 
(43 known properties: "definitions", "default", "x-kubernetes-list-map-keys", "$schema", "multipleOf", "x-kubernetes-int-or-string", "minItems", "exclusiveMinimum", "not", "allOf", "additionalItems", "id", "oneOf", "required", "maximum", "nullable", "exclusiveMaximum", "anyOf", "minProperties", "externalDocs", "dependencies", "example", "x-kubernetes-preserve-unknown-fields", "$ref", "properties", "format", "additionalProperties", "description", "enum", "minimum", "pattern", "minLength", "x-kubernetes-map-type", "x-kubernetes-embedded-resource", "patternProperties", "maxLength", "uniqueItems", "maxProperties", "type", "maxItems", "items", "title", "x-kubernetes-list-type"])

[rohanKanojia]

I'm not able to find x-descriptors field in equivalent go struct: https://github.com/kubernetes/apiextensions-apiserver/blob/master/pkg/apis/apiextensions/v1/types_jsonschema.go#L20

[lburgazzoli]

It is a our own JSON Schema extension, is not part of k8s but should be put in additionalProperties I guess as there is a https://github.com/apache/camel-k/blob/main/config/crd/bases/camel.apache.org_kamelets.yaml#L82 (not sure if that is on the right position but does not fails in camel-k)

[iocanel]

We can probably configure jackson to be more relax. I think that in this case the x-descriptors will end up under addtionalProperties. How would that work for you @lburgazzoli ?

[lburgazzoli]

that would be perfectly fine with me

[stale]

This issue has been automatically marked as stale because it has not had any activity since 90 days. It will be closed if no further activity occurs within 7 days. Thank you for your contributions!