Sift | Docs
APIReferenceREST (HTTP/JSON)Protobuf descriptor service

CheckProtobufDescriptorCompatibility

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

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

Request Body

application/jsonRequired

protobufDescriptorobject

curl -X POST "<API_URL>/api/v2/protobuf-descriptors:check-compatibility" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "protobufDescriptor": {
      "messageTypeFullName": "string",
      "fileDescriptorSet": "string",
      "protoFileName": "string",
      "namespace": "string",
      "protobufDescriptorId": "string"
    }
  }'

A successful response.

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

Previous

AddProtobufDescriptor POST

Next

DeleteProtobufDescriptors DELETE