ccompat api missing field in answer

[Shawcs]

Description

Registry Version:2.5.10
Persistence type: kafkasql

I found a regression in the response of one of the rest endpoint of the ccompat/v6 and ccompat/v7

when requesting: /apis/ccompat/v6/subjects/{subject}/versions/latest or /apis/ccompat/v7/subjects/{subject}/versions/latest
if the schema is not AVRO the response doesn't return the schemaType

Steps to Reproduce

Launch a 2.5.5 Registry image (it's the one I tried but I didn't checked with other version)

• register a json schema like:

curl --request POST \
  --url 'https://broker-schema-registry.com/apis/registry/v2/groups/default/artifacts?ifExists=RETURN&cononical=true' \
  --header 'X-Registry-ArtifactId: bank-json-value' \
  --header 'X-Registry-ArtifactType: JSON' \
  --header 'X-Registry-Name: com.json' \
  --data '{
  "id" : "urn:jsonschema:com:OperationRef",
  "title" : "OperationRef",
  "$defs" : {
    "OperationRef" : {
      "type" : "object",
      "id" : "urn:jsonschema:com:OperationRef",
      "properties" : {
        "reference" : {
          "type" : "string"
        },
        "type" : {
          "type" : "string"
        }
      }
    },
    "TransactionRef" : {
      "type" : "object",
      "id" : "urn:jsonschema:com:TransactionRef",
      "properties" : {
        "type" : {
          "type" : "string"
        },
        "value" : {
          "type" : "string"
        }
      }
    }
  }
}'

• recover the latest subject for this artifact with the ccompat api with:

curl --request GET \
  --url https://broker-schema-registry.com/apis/ccompat/v6/subjects/bank-json-value/versions/latest
#OR
curl --request GET \
  --url https://broker-schema-registry..com/apis/ccompat/v7/subjects/bank-json-value/versions/latest

• response:

{
	"id": 3,
	"subject": "bank-json-value",
	"version": 1,
	"schema": "{\n  \"id\" : \"urn:jsonschema:com:OperationRef\",\n  \"title\" : \"OperationRef\",\n  \"$defs\" : {\n    \"OperationRef\" : {\n      \"type\" : \"object\",\n      \"id\" : \"urn:jsonschema:com:OperationRef\",\n      \"properties\" : {\n        \"reference\" : {\n          \"type\" : \"string\"\n        },\n        \"type\" : {\n          \"type\" : \"string\"\n        }\n      }\n    },\n    \"TransactionRef\" : {\n      \"type\" : \"object\",\n      \"id\" : \"urn:jsonschema:com:TransactionRef\",\n      \"properties\" : {\n        \"type\" : {\n          \"type\" : \"string\"\n        },\n        \"value\" : {\n          \"type\" : \"string\"\n        }\n      }\n    }\n  }\n}",
	"schemaType": "JSON",
	"references": []
}

Launch a 2.5.10 Registry Image, clear the kafkasql-journal topic

• register a schema in the same way as before

• get the schema metadata the same way:

curl --request GET \
  --url https://broker-schema-registry.com/apis/ccompat/v6/subjects/bank-json-value/versions/latest
#OR
curl --request GET \
  --url https://broker-schema-registry..com/apis/ccompat/v7/subjects/bank-json-value/versions/latest

• response:

{
	"id": 22,
	"subject": "bank-json-value",
	"version": 1,
	"schema": "{\n  \"id\" : \"urn:jsonschema:com:OperationRef\",\n  \"title\" : \"OperationRef\",\n  \"$defs\" : {\n    \"OperationRef\" : {\n      \"type\" : \"object\",\n      \"id\" : \"urn:jsonschema:com:OperationRef\",\n      \"properties\" : {\n        \"reference\" : {\n          \"type\" : \"string\"\n        },\n        \"type\" : {\n          \"type\" : \"string\"\n        }\n      }\n    },\n    \"TransactionRef\" : {\n      \"type\" : \"object\",\n      \"id\" : \"urn:jsonschema:com:TransactionRef\",\n      \"properties\" : {\n        \"type\" : {\n          \"type\" : \"string\"\n        },\n        \"value\" : {\n          \"type\" : \"string\"\n        }\n      }\n    }\n  }\n}",
	"references": []
}

Expected vs Actual Behaviour

The API should give the schemaType like in the 2.5.5 version and as stated in the confluent API (as we are in the ccompat api) here: https://docs.confluent.io/platform/current/schema-registry/develop/api.html#get--subjects-(string-%20subject)-versions-(versionId-%20version)

Also the swagger of the ccompat api should be updated (actually for both version 2.5.5 and 2.5.10) because the schema type is never referenced in the 200 response code documentation

[carlesarnal]

Hello @Shawcs thanks for the report. I have confirmed this. Apparently, during the refactor, I missed a parameter in a function (and a test, of course). I'll create a PR fixing it.

Thanks!