cURL
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>" } ] }
Used to check if a protobuf descriptor is compatible with the existing descriptors.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Bearer <token>
<token>
Show child attributes
A successful response.
Was this page helpful?