[tracker/wip/carlosg/doc-updates: 21/23] libtracker-sparql: Add further docs to TrackerEndpointHttp




commit 0e8d238bfda556175fd8ea8fcf9da0a458d2b115
Author: Carlos Garnacho <carlosg gnome org>
Date:   Fri Mar 18 16:27:47 2022 +0100

    libtracker-sparql: Add further docs to TrackerEndpointHttp
    
    Stress further the importance around ::block-remote-address and
    GTlsCertificate, and mention that HTTP endpoints do not implement
    updates.

 src/libtracker-sparql/tracker-endpoint-http.c | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)
---
diff --git a/src/libtracker-sparql/tracker-endpoint-http.c b/src/libtracker-sparql/tracker-endpoint-http.c
index 03a7eb4ea..6248284e9 100644
--- a/src/libtracker-sparql/tracker-endpoint-http.c
+++ b/src/libtracker-sparql/tracker-endpoint-http.c
@@ -33,7 +33,17 @@
  * Access to these endpoints may be managed via the
  * #TrackerEndpointHttp::block-remote-address signal, the boolean
  * return value expressing whether the connection is blocked or not.
- * Inspection of the requester address is left up to the user.
+ * Inspection of the requester address is left up to the user. The
+ * default value allows all requests independently of their provenance,
+ * users are encouraged to add a handler.
+ *
+ * If the provided #GTlsCertificate is %NULL, the endpoint will allow
+ * plain HTTP connections. Users are encouraged to provide a certificate
+ * in order to use HTTPS.
+ *
+ * As a security measure, and in compliance with the SPARQL 1.1 specifications,
+ * the HTTP endpoint does not support database updates or modifications in any
+ * way. The database is completely owned by the host.
  *
  * A #TrackerEndpointHttp may be created on a different thread/main
  * context than the one creating the #TrackerSparqlConnection.


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]