REST API documentation update

FitLayout · Nov 5, 2023 · 51d67b7 · 51d67b7
1 parent 6c97af6
commit 51d67b7
Show file tree

Hide file tree

Showing 27 changed files with 1,683 additions and 194 deletions.
diff --git a/restapi/Apis/AdminApi.md b/restapi/Apis/AdminApi.md
@@ -1,6 +1,6 @@
 # AdminApi
 
-All URIs are relative to *http://localhost:9080/fitlayout-web*
+All URIs are relative to *http://localhost:8080/fitlayout-web*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

diff --git a/restapi/Apis/ArtifactApi.md b/restapi/Apis/ArtifactApi.md
@@ -1,6 +1,6 @@
 # ArtifactApi
 
-All URIs are relative to *http://localhost:9080/fitlayout-web*
+All URIs are relative to *http://localhost:8080/fitlayout-web*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
@@ -145,7 +145,7 @@ null (empty response body)
 
 <a name="getArtifactsInfo"></a>
 # **getArtifactsInfo**
-> getArtifactsInfo(repoId)
+> getArtifactsInfo(repoId, page)
 
 Retrieves information about all artifacts in the repository (artifact contents not included).
 
@@ -154,6 +154,7 @@ Retrieves information about all artifacts in the repository (artifact contents n
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **repoId** | **String**| The ID of the artifact repository to use | [default to null]
+ **page** | **String**|  | [optional] [default to null]
 
 ### Return type
 
@@ -170,7 +171,7 @@ null (empty response body)
 
 <a name="listArtifacts"></a>
 # **listArtifacts**
-> List listArtifacts(repoId)
+> List listArtifacts(repoId, page)
 
 Gets a list of artifact IRIs.
 
@@ -179,6 +180,7 @@ Gets a list of artifact IRIs.
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **repoId** | **String**| The ID of the artifact repository to use | [default to null]
+ **page** | **String**|  | [optional] [default to null]
 
 ### Return type
 

diff --git a/restapi/Apis/AuthApi.md b/restapi/Apis/AuthApi.md
@@ -1,6 +1,6 @@
 # AuthApi
 
-All URIs are relative to *http://localhost:9080/fitlayout-web*
+All URIs are relative to *http://localhost:8080/fitlayout-web*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

diff --git a/restapi/Apis/QueryApi.md b/restapi/Apis/QueryApi.md
@@ -0,0 +1,115 @@
+# QueryApi
+
+All URIs are relative to *http://localhost:8080/fitlayout-web*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**addQuery**](QueryApi.md#addQuery) | **POST** /api/r/{repoId}/query | Adds a saved a query
+[**deleteQuery**](QueryApi.md#deleteQuery) | **DELETE** /api/r/{repoId}/query/{id} | Deletes a saved query
+[**getQuery**](QueryApi.md#getQuery) | **GET** /api/r/{repoId}/query/{id} | Obtains a saved query
+[**list**](QueryApi.md#list) | **GET** /api/r/{repoId}/query | Obtains all the saved queries
+
+
+<a name="addQuery"></a>
+# **addQuery**
+> addQuery(repoId, SavedQueryDTO)
+
+Adds a saved a query
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **repoId** | **String**| The ID of the artifact repository to use | [default to null]
+ **SavedQueryDTO** | [**SavedQueryDTO**](../Models/SavedQueryDTO.md)|  | [optional]
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+
+<a name="deleteQuery"></a>
+# **deleteQuery**
+> deleteQuery(repoId, id)
+
+Deletes a saved query
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **repoId** | **String**| The ID of the artifact repository to use | [default to null]
+ **id** | **Long**|  | [default to null]
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+<a name="getQuery"></a>
+# **getQuery**
+> getQuery(repoId, id)
+
+Obtains a saved query
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **repoId** | **String**| The ID of the artifact repository to use | [default to null]
+ **id** | **Long**|  | [default to null]
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+<a name="list"></a>
+# **list**
+> list(repoId)
+
+Obtains all the saved queries
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **repoId** | **String**| The ID of the artifact repository to use | [default to null]
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
diff --git a/restapi/Apis/RepositoryApi.md b/restapi/Apis/RepositoryApi.md
@@ -1,19 +1,20 @@
 # RepositoryApi
 
-All URIs are relative to *http://localhost:9080/fitlayout-web*
+All URIs are relative to *http://localhost:8080/fitlayout-web*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**addNamespace**](RepositoryApi.md#addNamespace) | **PUT** /api/r/{repoId}/repository/namespaces/{prefix} | Adds a namespace definition for the given prefix
 [**addQuadruple**](RepositoryApi.md#addQuadruple) | **POST** /api/r/{repoId}/repository/add | Adds a new quadruple to the repository
 [**addQuadruples**](RepositoryApi.md#addQuadruples) | **POST** /api/r/{repoId}/repository/addQuads | Adds a list of new quadruple to the repository
-[**addStatements**](RepositoryApi.md#addStatements) | **POST** /api/r/{repoId}/repository/statements | Imports statements to the repository
+[**addStatements**](RepositoryApi.md#addStatements) | **POST** /api/r/{repoId}/repository/statements | Imports (adds) statements to the repository
 [**checkRepo**](RepositoryApi.md#checkRepo) | **GET** /api/r/{repoId}/repository/checkRepo | Checks the repository whether it exists and is properly initialized
 [**clearNamespaces**](RepositoryApi.md#clearNamespaces) | **DELETE** /api/r/{repoId}/repository/namespaces | Removes all namespace declarations from the repository
 [**deleteNamespace**](RepositoryApi.md#deleteNamespace) | **DELETE** /api/r/{repoId}/repository/namespaces/{prefix} | Removes a namespace definition for the given prefix
 [**deleteQuadruples**](RepositoryApi.md#deleteQuadruples) | **POST** /api/r/{repoId}/repository/deleteQuads | Removes a list of quadruples from the repository
 [**deleteStatements**](RepositoryApi.md#deleteStatements) | **DELETE** /api/r/{repoId}/repository/statements | Deletes statements from the repository
 [**describeSubject**](RepositoryApi.md#describeSubject) | **GET** /api/r/{repoId}/repository/describe/{iri} | Gets the RDF description for the given subject IRI
+[**forceInitRepo**](RepositoryApi.md#forceInitRepo) | **GET** /api/r/{repoId}/repository/forceInitRepo | Re-initializes an empty repository with the necessary RDF metadata (schemas)
 [**getContexts**](RepositoryApi.md#getContexts) | **GET** /api/r/{repoId}/repository/contexts | Gets a list of contexts that have been defined for the repository
 [**getNamespace**](RepositoryApi.md#getNamespace) | **GET** /api/r/{repoId}/repository/namespaces/{prefix} | Gets a namespace URI for the given prefix
 [**getNamespaces**](RepositoryApi.md#getNamespaces) | **GET** /api/r/{repoId}/repository/namespaces | Gets a list of namespace declarations that have been defined for the repository
@@ -24,6 +25,7 @@ Method | HTTP request | Description
 [**query**](RepositoryApi.md#query) | **POST** /api/r/{repoId}/repository/query | Executes any SPARQL query on the underlying RDF repository
 [**queryObject**](RepositoryApi.md#queryObject) | **GET** /api/r/{repoId}/repository/object/{iri} | Gets all triples for the given object IRI
 [**querySubject**](RepositoryApi.md#querySubject) | **GET** /api/r/{repoId}/repository/subject/{iri} | Gets all triples for the given subject IRI
+[**replaceStatements**](RepositoryApi.md#replaceStatements) | **PUT** /api/r/{repoId}/repository/statements | Replaces all statements in the repository
 [**selectQuery**](RepositoryApi.md#selectQuery) | **POST** /api/r/{repoId}/repository/selectQuery | Executes a SPARQL SELECT query on the underlying RDF repository
 [**touch**](RepositoryApi.md#touch) | **GET** /api/r/{repoId}/repository/touch | Updates the last access time of the given repository to current time
 [**updateQuery**](RepositoryApi.md#updateQuery) | **POST** /api/r/{repoId}/repository/updateQuery | Executes a SPARQL UPDATE query on the underlying RDF repository
@@ -112,7 +114,7 @@ Name | Type | Description  | Notes
 # **addStatements**
 > ResultValue addStatements(repoId, baseURI, context, body)
 
-Imports statements to the repository
+Imports (adds) statements to the repository
 
 ### Parameters
 
@@ -121,7 +123,7 @@ Name | Type | Description  | Notes
  **repoId** | **String**| The ID of the artifact repository to use | [default to null]
  **baseURI** | **String**|  | [optional] [default to null]
  **context** | **String**|  | [optional] [default to null]
- **body** | **Object**|  | [optional]
+ **body** | **File**|  | [optional]
 
 ### Return type
 
@@ -269,7 +271,7 @@ Name | Type | Description  | Notes
 
 <a name="describeSubject"></a>
 # **describeSubject**
-> SubjectDescriptionResult describeSubject(repoId, iri)
+> SubjectDescriptionResult describeSubject(repoId, iri, limit)
 
 Gets the RDF description for the given subject IRI
 
@@ -279,6 +281,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **repoId** | **String**| The ID of the artifact repository to use | [default to null]
  **iri** | **String**|  | [default to null]
+ **limit** | **Integer**|  | [optional] [default to 2048]
 
 ### Return type
 
@@ -293,6 +296,31 @@ Name | Type | Description  | Notes
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
+<a name="forceInitRepo"></a>
+# **forceInitRepo**
+> ResultValue forceInitRepo(repoId)
+
+Re-initializes an empty repository with the necessary RDF metadata (schemas)
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **repoId** | **String**| The ID of the artifact repository to use | [default to null]
+
+### Return type
+
+[**ResultValue**](../Models/ResultValue.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
 <a name="getContexts"></a>
 # **getContexts**
 > SelectQueryResult getContexts(repoId)
@@ -478,7 +506,7 @@ Name | Type | Description  | Notes
 
 <a name="query"></a>
 # **query**
-> SelectQueryResult query(repoId, limit, offset, body)
+> SelectQueryResult query(repoId, distinct, limit, offset, body)
 
 Executes any SPARQL query on the underlying RDF repository
 
@@ -487,7 +515,8 @@ Executes any SPARQL query on the underlying RDF repository
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **repoId** | **String**| The ID of the artifact repository to use | [default to null]
- **limit** | **Long**|  | [optional] [default to 100]
+ **distinct** | **Boolean**|  | [optional] [default to false]
+ **limit** | **Long**|  | [optional] [default to 2048]
  **offset** | **Long**|  | [optional] [default to 0]
  **body** | **String**|  | [optional]
 
@@ -516,7 +545,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **repoId** | **String**| The ID of the artifact repository to use | [default to null]
  **iri** | **String**|  | [default to null]
- **limit** | **Integer**|  | [optional] [default to 100]
+ **limit** | **Integer**|  | [optional] [default to 2048]
 
 ### Return type
 
@@ -543,7 +572,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **repoId** | **String**| The ID of the artifact repository to use | [default to null]
  **iri** | **String**|  | [default to null]
- **limit** | **Integer**|  | [optional] [default to 100]
+ **limit** | **Integer**|  | [optional] [default to 2048]
 
 ### Return type
 
@@ -558,9 +587,37 @@ Name | Type | Description  | Notes
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
+<a name="replaceStatements"></a>
+# **replaceStatements**
+> ResultValue replaceStatements(repoId, baseURI, context, body)
+
+Replaces all statements in the repository
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **repoId** | **String**| The ID of the artifact repository to use | [default to null]
+ **baseURI** | **String**|  | [optional] [default to null]
+ **context** | **String**|  | [optional] [default to null]
+ **body** | **File**|  | [optional]
+
+### Return type
+
+[**ResultValue**](../Models/ResultValue.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+- **Content-Type**: application/ld+json, text/turtle, application/rdf+xml, application/n-triples, application/n-quads
+- **Accept**: application/json
+
 <a name="selectQuery"></a>
 # **selectQuery**
-> SelectQueryResult selectQuery(repoId, limit, offset, body)
+> SelectQueryResult selectQuery(repoId, distinct, limit, offset, body)
 
 Executes a SPARQL SELECT query on the underlying RDF repository
 
@@ -569,7 +626,8 @@ Executes a SPARQL SELECT query on the underlying RDF repository
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **repoId** | **String**| The ID of the artifact repository to use | [default to null]
- **limit** | **Long**|  | [optional] [default to 100]
+ **distinct** | **Boolean**|  | [optional] [default to false]
+ **limit** | **Long**|  | [optional] [default to 2048]
  **offset** | **Long**|  | [optional] [default to 0]
  **body** | **String**|  | [optional]
 

diff --git a/restapi/Apis/RepositoryOperatorApi.md b/restapi/Apis/RepositoryOperatorApi.md
@@ -0,0 +1,34 @@
+# RepositoryOperatorApi
+
+All URIs are relative to *http://localhost:8080/fitlayout-web*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**repositoryListOperators**](RepositoryOperatorApi.md#repositoryListOperators) | **GET** /api/r/{repoId}/operator | Gets a list of available area tree operator services for the repository.
+
+
+<a name="repositoryListOperators"></a>
+# **repositoryListOperators**
+> List repositoryListOperators(repoId)
+
+Gets a list of available area tree operator services for the repository.
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **repoId** | **String**| The ID of the artifact repository to use | [default to null]
+
+### Return type
+
+[**List**](../Models/ParametrizedServiceDescr.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+