Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
Benn Oshrin committed Aug 31, 2020
1 parent a4f39f7 commit f63aa4c
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@

The [TAP Core Schema](core-schema.adoc) 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 useful the Core Schema must then be mapped to a
specific representation, such as JSON.
authoritative Core Schema is abstract -- it cannot be used directly, but is
best thought of as an *attribute library* that can be used to construct other
documents.

The following types of documents are defined as part of the Core Schema library:

* **Representations**: Mappings of the Core Schema to a specific form, such as
JSON, XML, or YAML.

* **Profiles**: Selections of Core Schema attributes for a particular purpose.

* **Protocols**: A specification for implementation, based on a Representation
and perhaps a Profile. Of all the Core Schema documents, only Protocols are
actually implementable in software.

As an example, the **eduPerson LDAP Schema** would be a *Protocol* that
references the *eduPerson Profile* and the *LDAP Representation*.

0 comments on commit f63aa4c

Please sign in to comment.