docs: add private endpoint feature

SDM-TIB · Nov 14, 2023 · dd10359 · dd10359
1 parent 25a26cc
commit dd10359
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/docs/feature.rst b/docs/feature.rst
@@ -13,6 +13,11 @@ The following is a list of what is supported:
         +   ``sh:message`` is ignored, i.e., the message is not included in the result
         +   only ``$this`` is supported as placeholder
 *   simple logical constraints, i.e., ``sh:or``
+*   Trav-SHACL is capable of validating
+
+        +   public SPARQL endpoints
+        +   private SPARQL endpoints via HTTP Basic Auth (since v1.6.0)
+        +   RDFLib graphs (since v1.3.0)
 
 The following is a list of some of the more important features that are not yet covered:
 

diff --git a/docs/library.rst b/docs/library.rst
@@ -117,6 +117,8 @@ Now the data is accessible and you can validate it against the provided example
     shape_schema = ShapeSchema(
         schema_dir='./shapes/LUBM',
         endpoint='http://localhost:9090/sparql',
+        endpoint_user=None,  # username if validating a private endpoint
+        endpoint_password=None,  # password if validating a private endpoint
         graph_traversal=GraphTraversal.DFS,
         heuristics=parse_heuristics(prio_target + ' ' + prio_degree + ' ' + prio_number),
         use_selective_queries=True,
@@ -140,6 +142,8 @@ Before executing the above script, let us have a look at the different parameter
 
 * ``schema_dir`` path to the directory containing the shape files
 * ``endpoint`` URL of the endpoint to evaluated; alternatively, an RDFLib graph can be passed
+* ``endpoint_user`` (optional) username if validating a private endpoint; default: ``None``
+* ``endpoint_password`` (optional) password if validating a private endpoint; default: ``None``
 * ``graph_traversal`` (optional) defines the graph traversal algorithm to be used, is one of ``[GraphTraversal.BFS, GraphTraversal.DFS]``; default: ``GraphTraversal.DFS``
 * ``heuristics`` (optional) used to determine the seed shape. Use the method ``parse_heuristics`` with a string in order to set the desired heuristics; default: ``parse_heuristics('TARGET IN BIG')``.