Skip to main content
POST
/
api
/
v2
/
protobuf-descriptors:check-compatibility
CheckProtobufDescriptorCompatibility
curl --request POST \
  --url https://your-sift-api-url.com/api/v2/protobuf-descriptors:check-compatibility \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "protobufDescriptor": {
    "messageTypeFullName": "<string>",
    "fileDescriptorSet": "aSDinaTvuI8gbWludGxpZnk=",
    "protoFileName": "<string>",
    "namespace": "<string>",
    "protobufDescriptorId": "<string>"
  }
}'
{
  "isValid": true,
  "incompatibleProtobufDescriptorFields": [
    {
      "protobufDescriptorId": "<string>",
      "messageFullName": "<string>",
      "desiredFieldName": "<string>",
      "currentFieldName": "<string>",
      "fieldNumber": "<string>",
      "reason": "<string>",
      "details": "<string>",
      "fieldKind": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
protobufDescriptor
object

Response

A successful response.

isValid
boolean
incompatibleProtobufDescriptorFields
object[]