Bug 20624: Add RESTOAuth2ClientCredentials syspref
[srvgit] / koha-tmpl / intranet-tmpl / prog / en / modules / admin / preferences / web_services.pref
index 7244675..d9ad25f 100644 (file)
@@ -1,4 +1,16 @@
 Web services:
+    REST API:
+        -
+            - "Set the default number of results returned by the REST API endpoints to"
+            - pref: "RESTdefaultPageSize"
+              class: integer
+            - "per page."
+        -
+            - pref: RESTOAuth2ClientCredentials
+              choices:
+                  yes: Enable
+                  no: "Disable"
+            - "the OAuth2 client credentials grant for the REST API."
     OAI-PMH:
         -
             - pref: OAI-PMH
@@ -17,7 +29,7 @@ Web services:
               class: integer
             - records at a time in response to a ListRecords or ListIdentifiers query.
         -
-            - YAML OAI Koha server configuration file:
+            - "YAML OAI Koha server configuration file:"
             - pref: "OAI-PMH:ConfFile"
               class: file
             - . If empty, Koha OAI Server operates in normal mode, otherwise it operates in extended mode. In extended mode, it's possible to parameter other formats than marcxml or Dublin Core. OAI-PMH:ConfFile specify a YAML configuration file which list available metadata formats and XSL file used to create them from marcxml records.
@@ -27,20 +39,37 @@ Web services:
                   yes: Enable
                   no: Disable
             - automatic update of OAI-PMH sets when a bibliographic record is created or updated
+        -
+            - Koha's deletedbiblio table
+            - pref: "OAI-PMH:DeletedRecord"
+              choices:
+                  persistent: will never be emptied or truncated (persistent)
+                  transient: might be emptied or truncated at some point (transient)
+                  no: will never have any data in it (no)
+            - "."
     ILS-DI:
         -
             - pref: ILS-DI
               choices:
                 yes: Enable
                 no: Disable
-            - ILS-DI services for OPAC users
+            - "ILS-DI services for OPAC users (available at: /cgi-bin/koha/ilsdi.pl)"
         -
+            - Allow IP addresses
             - pref: ILS-DI:AuthorizedIPs
               class: Text
-            - allowed IPs to use the ILS-DI services
+            - to use the ILS-DI services (when enabled). Separate the IP addresses with commas and without spaces. Leave the field blank to allow any IP address.
     Reporting:
         -
             - Only return
             - pref: SvcMaxReportRows
               class: integer
             - rows of a report requested via the reports web service.
+    IdRef:
+        -
+            - pref: IdRef
+              choices:
+                yes: Enable
+                no: Disable
+            - the IdRef webservice from the opac detail page. IdRef allows to request authorities from the Sudoc database.
+            - Please note that this feature is available only for UNIMARC.