You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We have a number of types for identifiers (see common.ts) which are used more or less consistently in the API spec.
Currently their role and purpose may not be obvious (what is Id, what is Name?). We should:
document these types
add a new DocId type for document identifiers. It should replace Id everywhere it is used as document identifier.
Id should be kept as a general-purpose string type that distinguishes between unique identifiers in the system (be them internal or external identifiers) and text strings.
The text was updated successfully, but these errors were encountered:
We have a number of types for identifiers (see common.ts) which are used more or less consistently in the API spec.
Currently their role and purpose may not be obvious (what is
Id
, what isName
?). We should:DocId
type for document identifiers. It should replaceId
everywhere it is used as document identifier.Id
should be kept as a general-purpose string type that distinguishes between unique identifiers in the system (be them internal or external identifiers) and text strings.The text was updated successfully, but these errors were encountered: