Skip to content

C
coopwire-hypothesis
Commit 94584bb2 authored by Sheetal Umesh Kumar's avatar Sheetal Umesh Kumar
Browse files
Options

Update docs to mandatory apiUrl field in the service.

parent 0fbe2470
Show whitespace changes
Inline Side-by-side
Showing with 5 additions and 0 deletions
docs/publishers/config.rst
View file @ 94584bb2
...@@ -102,6 +102,7 @@ loads. ...@@ -102,6 +102,7 @@ loads.
window.hypothesisConfig = function () { window.hypothesisConfig = function () {
return { return {
services: [{ services: [{
apiUrl: 'https://hypothes.is/api',
authority: 'partner.org', authority: 'partner.org',
grantToken: '***', grantToken: '***',
icon: 'https://openclipart.org/download/272629/sihouette-animaux-10.svg' icon: 'https://openclipart.org/download/272629/sihouette-animaux-10.svg'
...@@ -126,6 +127,10 @@ loads. ...@@ -126,6 +127,10 @@ loads.
Each item in the :option:`services` array should be an object describing an Each item in the :option:`services` array should be an object describing an
annotation service, with the following keys: annotation service, with the following keys:
.. option:: apiUrl
``String``. The base URL of the service API.
.. option:: authority .. option:: authority
``String``. The domain name which the annotation service is associated with. ``String``. The domain name which the annotation service is associated with.
......
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