diff --git a/tap-person-schema.adoc b/tap-person-schema.adoc index 8cfe95b..e379b42 100644 --- a/tap-person-schema.adoc +++ b/tap-person-schema.adoc @@ -1,4 +1,4 @@ -TAP Person Schema +# TAP Person Schema ====================== :Date: July 2020 :Revision: v1.0.0 @@ -8,8 +8,8 @@ TAP Person Schema Copyright (C) 2020 University Corporation for Advanced Internet Development, Inc. -About the Core Schema ---------------------- +## About the Core Schema + The TAP Core Schema defines a dictionary of common attributes used across various components of the TAP portfolio. The authoritative Core Schema is abstract -- it is not bound to any particular representation. However, to be @@ -20,8 +20,8 @@ A Representation of the Core Schema is typically bound to a _Protocol_, which defines the context in which the Representation is used. For example, the ID Match Protocol uses the JSON Representation of the Core Schema. -About Core Schema Attributes ----------------------------- +## About Core Schema Attributes + There are no required attributes from the perspective of the Core Schema. It is up to a given Protocol using the Core Schema to determine which attributes are required, and how such status is conveyed between participants if not @@ -52,8 +52,8 @@ cased. Attribute names are case insensitive, but should be case preserving. -Attribute Data Types -~~~~~~~~~~~~~~~~~~~~ +### Attribute Data Types + Core Schema attributes are typed, as follows: * *binary*: Representation specific encoding of binary data. @@ -84,8 +84,8 @@ Core Schema attributes are typed, as follows: specified for a given attribute. Strings support UTF-8 unless otherwise specified for a given attribute or Representation. -Supplemental Local ("Ad Hoc") Attributes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +## Supplemental Local ("Ad Hoc") Attributes + Additional attributes may be locally defined in order to supplement the Core Schema attributes defined in this document. These attributes are referred to as _Ad Hoc_ attributes. @@ -105,8 +105,8 @@ should not be used) against the likelihood that these values are highly tailored to the local deployment (in which case namespacing should be used to avoid conflict with potential revisions to the Core Schema). -Attribute Metadata -~~~~~~~~~~~~~~~~~~ +### Attribute Metadata + The following Metadata attributes are available: * *created*: A _dateTime_ describing when the attribute value was created. @@ -127,8 +127,8 @@ The following Metadata attributes are available: * *source*: A string representing the authority or source of the associated record or attribute. -Record Metadata -~~~~~~~~~~~~~~~ +### Record Metadata + The same attributes defined for Attribute Metadata may also be used for record metadata.