API DocsRESTProtobuf descriptor service

CheckProtobufDescriptorCompatibility

Used to check if a protobuf descriptor is compatible with the existing descriptors.

POST
/api/v2/protobuf-descriptors:check-compatibility

Query Parameters

protobufDescriptor.messageTypeFullNamestring

protobufDescriptor.fileDescriptorSetstring

Format: "byte"

protobufDescriptor.protoFileNamestring

protobufDescriptor.namespacestring

protobufDescriptor.protobufDescriptorIdstring

curl -X POST "<API_URL>/api/v2/protobuf-descriptors:check-compatibility?protobufDescriptor.messageTypeFullName=string&protobufDescriptor.fileDescriptorSet=string&protobufDescriptor.protoFileName=string&protobufDescriptor.namespace=string&protobufDescriptor.protobufDescriptorId=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "isValid": true,
  "incompatibleProtobufDescriptorFields": [
    {
      "protobufDescriptorId": "string",
      "messageFullName": "string",
      "desiredFieldName": "string",
      "currentFieldName": "string",
      "fieldNumber": "string",
      "reason": "string",
      "details": "string"
    }
  ]
}

Previous

AddProtobufDescriptor POST

Next

DeleteProtobufDescriptors DELETE