Commit e71daa78 authored by Robert Knight's avatar Robert Knight

Expand the documentation of the _services_ config key

 * Clarify that the service list augments rather than replaces the
   default list which consists of the public Hypothesis service.

 * Document the keys of objects in the _services_ array
parent 654cebcd
...@@ -37,7 +37,12 @@ _Boolean_. Controls whether the in-document highlights are shown by default. ...@@ -37,7 +37,12 @@ _Boolean_. Controls whether the in-document highlights are shown by default.
### `services` ### `services`
_Array_. A list of annotation services which the client should retrieve _Array_. A list of additional annotation services which the client should
annotations from, optionally including information about the identity of the retrieve annotations from, optionally including information about the identity
user on that service. When omitted, the client will default to connecting to of the user on that service. This list is in addition to the public
the public [Hypothesis](https://hypothes.is/) service. [Hypothesis](https://hypothes.is/) service.
Each service description is an object with the keys:
* `authority` _String_. The domain name which the annotation service is associated with.
* `grantToken` _String|null_. An OAuth grant token which the client can exchange for an access token in order to make authenticated requests to the service. If _null_, the user will only be able to read rather than create or modify annotations. (Default: _null_)
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment