Skip to main content
Check Protocol Name Endpoint

Body

application/json

Request body for checking a protocol name against its protocol.

name
string
required

The protocol name to check, as the user typed it.

Maximum string length: 200
protocol
required

The protocol as UCP YAML text or a parsed mapping.

name_from_file
boolean
default:false

True when the name came from an uploaded protocol file rather than from the user. The check then returns 'uncheckable' without calling the model: the name is the vendor file's, so a mismatch is not something the user can act on.

Response

Successful Response

The verdict on whether a name describes its protocol.

verdict
string
required

'match' when nothing in the name contradicts the protocol, 'mismatch' when something does, 'uncheckable' when the name makes no claim to check (a codename, an identifier, or a name carried in from a file). Only 'mismatch' should surface anything in the UI.

confidence
number
required

Confidence in a 'mismatch' verdict, 0-1. Above 0.8 is a contradiction pinned to a number; around 0.5 is a judgement call on wording. Always 1.0 for 'match' and 'uncheckable'.

mismatches
NameMismatchResponse · object[]

One entry per contradicted claim, most important first.

summary
string
default:""

One sentence naming the contradiction. Empty unless mismatched.

suggested_name
string
default:""

A corrected name in the user's own style, or empty when there is nothing to correct or the correction equals the current name.