Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
khazelton authored Nov 6, 2020
1 parent 2a92ad0 commit 20af8f9
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,21 @@
## TAP Attribute Dictionary

The [TAP Attribute Dictionary](tap-core-person-schema.adoc) defines a large collection of
attributes used across one or more components of the TAP portfolio and across higher education more generally. It is best thought of as an *attribute library* that can be drawn from to construct other documents, specifications, and software artifacts.
attributes used across one or more components of the TAP portfolio and across higher education more generally. It is best thought of as an *attribute library* that can be drawn from to construct other documents, specifications, and software artifacts. As additional attributes of utility emerge from ongoing work, they may become new entries in the Attribute Dictionary.

The normative specification of the TAP Attribute Dictionary is an abstract data model -- it must be mapped to specific formats and protocols to be expressed in code.
The normative specification of the TAP Attribute Dictionary is an abstract data model -- To be of use in code, it must be mapped to specific formats and protocols.

TAP uses the word "schema" as a rather broad and loose term for data models generally. However, beyond that, TAP provides careful definitions of two specific schema-related terms, "representation" and "protocol".
TAP uses the word "schema" as a rather broad and loose term for data models generally. However, beyond that, TAP adheres to its own rigorous definitions of two specific schema-related terms, "representation" and "protocol".

* **Representation**: Mappings of the TAP Attribute Dictionary entries to a specific markup form, such as
* **Representation**: Mappings of the TAP Attribute Dictionary abstract entries to a specific markup form, such as
JSON, XML, LDAP, or YAML.
* [TAP Attribute Dictionary: How to Create a JSON Representation](tap-core-person-schema-create-json-representation.adoc) (CS-JSON)
* Example: "eduPerson LDIF" would refer to eduPerson attributes expressed in the LDIF **Representation** defined in _RFC2849 The LDAP Data Interchange Format (LDIF) - Technical Specification_

* **Protocol**: A formal specification defining the specific ways two entities interoperate to accomplish a set of actions. Protocols are

* **Protocol**: A formal specification defining the specific conventions by which two entities interoperate to accomplish a set of actions. Protocols are
designed to be implementable in software.
* Example: eduPerson attributes on an LDAP server can be queried by an LDAP client using the LDAP **protocol** defined in _RFC4519 Lightweight Directory Access Protocol (LDAP) Schema for User Applications_

Example 1: "eduPerson LDIF" would refer to eduPerson attributes expressed in the LDIF **Representation** defined in _RFC2849 The LDAP Data Interchange Format (LDIF) - Technical Specification_

Example 2: eduPerson attributes on an LDAP server can be queried by an LDAP client using the LDAP **protocol** defined in _RFC4519 Lightweight Directory Access Protocol (LDAP) Schema for User Applications_

0 comments on commit 20af8f9

Please sign in to comment.