Commit 32619849 authored by Gilles Mouchard's avatar Gilles Mouchard
Browse files

Updated the documentation regarding the developments and bug fixes of the past few weeks.

parent 32dc468d
Pipeline #19733 passed with stages
in 8 minutes and 7 seconds
......@@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="date" content='02/17/22'>
<meta name="date" content='02/18/22'>
<title>D1.5 Open source PKM server-side software</title>
<link rel="stylesheet" href='../style/style.css' type="text/css">
</head>
......@@ -44,7 +44,7 @@
<p>Chapter 2, which is intended for users and system administrators, presents the building, configuration, and installation process of the PKM and parsers. Chapters 3, 4, and 5, which are intended for developers, present the PKM implementation. Chapter 6 concludes this document. The appendix talks about the Javascript SDK of the PKM server, the generation flow of the REST servers and SDKs for the clients, and the test procedure that was implemented to automate the test of the PKM server and more generally the DECODER Project tool-chain.</p>
</div>
<div id="footer">
<span><a href="../index.html">D1.5 Open source PKM server-side software</a> - 02/17/22</span>
<span><a href="../index.html">D1.5 Open source PKM server-side software</a> - 02/18/22</span>
</div>
</body>
</html>
......@@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="date" content='02/17/22'>
<meta name="date" content='02/18/22'>
<title>D1.5 Open source PKM server-side software</title>
<link rel="stylesheet" href='../style/style.css' type="text/css">
</head>
......@@ -162,7 +162,7 @@ Commands:
<pre><code>$ docker-compose up</code></pre>
</div>
<div id="footer">
<span><a href="../index.html">D1.5 Open source PKM server-side software</a> - 02/17/22</span>
<span><a href="../index.html">D1.5 Open source PKM server-side software</a> - 02/18/22</span>
</div>
</body>
</html>
......@@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="date" content='02/17/22'>
<meta name="date" content='02/18/22'>
<title>D1.5 Open source PKM server-side software</title>
<link rel="stylesheet" href='../style/style.css' type="text/css">
</head>
......@@ -2086,7 +2086,7 @@ PKM.logout(key).then((pkm) =&gt;
<p>The <em>PKM REST API</em> provides access to the PKM over HTTP/HTTPS. The PKM has an <a href="https://www.openapis.org">OpenAPI</a> 3 specification available at <a href="https://gitlab.ow2.org/decoder/pkm-api/-/blob/master/api/pkm-openapi.yaml">https://gitlab.ow2.org/decoder/pkm-api/-/blob/master/api/pkm-openapi.yaml</a>, which enables to automatically generate the SDK for many programming languages, see Appendix A.2. Appendix A.2 contains detailed explanations about implementation design of the REST server, which provides front-ends and third party tools developers with the PKM REST API.</p>
</div>
<div id="footer">
<span><a href="../index.html">D1.5 Open source PKM server-side software</a> - 02/17/22</span>
<span><a href="../index.html">D1.5 Open source PKM server-side software</a> - 02/18/22</span>
</div>
</body>
</html>
......@@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="date" content='02/17/22'>
<meta name="date" content='02/18/22'>
<title>D1.5 Open source PKM server-side software</title>
<link rel="stylesheet" href='../style/style.css' type="text/css">
</head>
......@@ -136,7 +136,7 @@ DELETE /git/working_trees/{dbName}/{gitWorkingTree}?dontDeletePkmFiles=…</code
<p>These operations allow deleting Git working trees created with <code>'clone'</code>. These operations can also delete the corresponding files in the PKM. There is no other way to delete Git working trees, and the only way to create a new Git working tree is to run a <code>clone</code> command.</p>
</div>
<div id="footer">
<span><a href="../index.html">D1.5 Open source PKM server-side software</a> - 02/17/22</span>
<span><a href="../index.html">D1.5 Open source PKM server-side software</a> - 02/18/22</span>
</div>
</body>
</html>
......@@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="date" content='02/17/22'>
<meta name="date" content='02/18/22'>
<title>D1.5 Open source PKM server-side software</title>
<link rel="stylesheet" href='../style/style.css' type="text/css">
</head>
......@@ -86,7 +86,7 @@
<p>Appendix A.2 contains detailed explanations about implementation design of the REST server that provides developer with the REST API.</p>
</div>
<div id="footer">
<span><a href="../index.html">D1.5 Open source PKM server-side software</a> - 02/17/22</span>
<span><a href="../index.html">D1.5 Open source PKM server-side software</a> - 02/18/22</span>
</div>
</body>
</html>
......@@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="date" content='02/17/22'>
<meta name="date" content='02/18/22'>
<title>D1.5 Open source PKM server-side software</title>
<link rel="stylesheet" href='../style/style.css' type="text/css">
</head>
......@@ -22,7 +22,7 @@
<p>The PKM server have also its own limitations that deserve attention in future developments. The PKM files, and more generally the artefacts in the PKM, have no revision numbers so that it is not easy to track progressive enhancement of the knowledge in the PKM. The PKM users management, especially concerning the user’s roles, is tightly geared to the MongoDB user’s management, which is database oriented, but it is not necessarily convenient for a SaaS approach. Direct upload (as attachment in a POST HTTP request) toward the database is unsupported due to the limitations of OpenAPI supporting tools.</p>
</div>
<div id="footer">
<span><a href="../index.html">D1.5 Open source PKM server-side software</a> - 02/17/22</span>
<span><a href="../index.html">D1.5 Open source PKM server-side software</a> - 02/18/22</span>
</div>
</body>
</html>
......@@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="date" content='02/17/22'>
<meta name="date" content='02/18/22'>
<title>D1.5 Open source PKM server-side software</title>
<link rel="stylesheet" href='../style/style.css' type="text/css">
</head>
......@@ -73,7 +73,7 @@
<p>The tests use the popular <a href="https://curl.se/">cURL</a> program to communicate with the PKM and tools through their REST APIs.</p>
</div>
<div id="footer">
<span><a href="../index.html">D1.5 Open source PKM server-side software</a> - 02/17/22</span>
<span><a href="../index.html">D1.5 Open source PKM server-side software</a> - 02/18/22</span>
</div>
</body>
</html>
......@@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="date" content='02/17/22'>
<meta name="date" content='02/18/22'>
<title>D1.5 Open source PKM server-side software</title>
<link rel="stylesheet" href='style/style.css' type="text/css">
</head>
......@@ -133,7 +133,7 @@
</ul>
</div>
<div id="footer">
<span><a href="index.html">D1.5 Open source PKM server-side software</a> - 02/17/22</span>
<span><a href="index.html">D1.5 Open source PKM server-side software</a> - 02/18/22</span>
</div>
</body>
</html>
......@@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="date" content='02/17/22'>
<meta name="date" content='02/18/22'>
<title>D1.4 Open source client-side software</title>
<link rel="stylesheet" href='../style/style.css' type="text/css">
</head>
......@@ -65,7 +65,7 @@
<p>Figure 3 shows the logical organization of this document (chapter numbers are highlighted in blue circles), which follows the order of actions to use properly the PKM and the parsers. Chapter 2 shows how to get the general server information such as the version numbers. Chapter 3 presents the management of the user’s session and particularly the way to authenticate with the PKM. Chapters 4 and 5 present the administrative tasks such as the users and project management. Chapter 6 presents how to deal with Git repositories. Chapter 7 shows how to populate the PKM with artefacts. Chapter 8 presents how to invoke parser to generate new artefacts. Chapter 9 shows how to query artefacts of a project. Chapter 10 concludes this document. The Appendix details the REST APIs and the command line interface (CLI).</p>
</div>
<div id="footer">
<span><a href="../index.html">D1.4 Open source client-side software</a> - 02/17/22</span>
<span><a href="../index.html">D1.4 Open source client-side software</a> - 02/18/22</span>
</div>
</body>
</html>
......@@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="date" content='02/17/22'>
<meta name="date" content='02/18/22'>
<title>D1.4 Open source client-side software</title>
<link rel="stylesheet" href='../style/style.css' type="text/css">
</head>
......@@ -20,7 +20,7 @@
<p>This document has described the PKM APIs: a command line interface (CLI) and REST APIs. While the command line interface has been historically the first PKM API available, the REST APIs made it obsolete because it was unsuitable for a SaaS deployment where the data and computing resources are deported in the cloud. Indeed, the REST APIs have allowed connecting the DECODER Project tools together over communication networks and creating a GUI front-end as a web application. Every components of the DECODER Project tool-chain, running on separate docker containers, are now able to exchange thanks to these REST APIs. Using the OpenAPI specifications made it easier to document REST APIs and write SDKs for PKM and parsers clients. The REST APIs will permit extending the DECODER Project tool-chain and connecting third party tools to the existing tool-chain. Hopefully, containerized tool-chain components and the REST APIs should enable a SaaS deployment in the future.</p>
</div>
<div id="footer">
<span><a href="../index.html">D1.4 Open source client-side software</a> - 02/17/22</span>
<span><a href="../index.html">D1.4 Open source client-side software</a> - 02/18/22</span>
</div>
</body>
</html>
......@@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="date" content='02/17/22'>
<meta name="date" content='02/18/22'>
<title>D1.4 Open source client-side software</title>
<link rel="stylesheet" href='../style/style.css' type="text/css">
</head>
......@@ -66,7 +66,7 @@
}</code></pre>
</div>
<div id="footer">
<span><a href="../index.html">D1.4 Open source client-side software</a> - 02/17/22</span>
<span><a href="../index.html">D1.4 Open source client-side software</a> - 02/18/22</span>
</div>
</body>
</html>
......@@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="date" content='02/17/22'>
<meta name="date" content='02/18/22'>
<title>D1.4 Open source client-side software</title>
<link rel="stylesheet" href='../style/style.css' type="text/css">
</head>
......@@ -37,7 +37,7 @@
<p>This operation creates another the user’s session, and returns a new PKM access key that identifies the new user’s session. The new user’s session is independent from the original user’s session which means that when the later ends, the former is still alive, and vice-versa.</p>
</div>
<div id="footer">
<span><a href="../index.html">D1.4 Open source client-side software</a> - 02/17/22</span>
<span><a href="../index.html">D1.4 Open source client-side software</a> - 02/18/22</span>
</div>
</body>
</html>
......@@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="date" content='02/17/22'>
<meta name="date" content='02/18/22'>
<title>D1.4 Open source client-side software</title>
<link rel="stylesheet" href='../style/style.css' type="text/css">
</head>
......@@ -149,7 +149,7 @@
<p>The writer do not recommend the use of these legacy commands.</p>
</div>
<div id="footer">
<span><a href="../index.html">D1.4 Open source client-side software</a> - 02/17/22</span>
<span><a href="../index.html">D1.4 Open source client-side software</a> - 02/18/22</span>
</div>
</body>
</html>
......@@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="date" content='02/17/22'>
<meta name="date" content='02/18/22'>
<title>D1.4 Open source client-side software</title>
<link rel="stylesheet" href='../style/style.css' type="text/css">
</head>
......@@ -134,7 +134,7 @@
<p>The writer do not recommend the use of these legacy commands.</p>
</div>
<div id="footer">
<span><a href="../index.html">D1.4 Open source client-side software</a> - 02/17/22</span>
<span><a href="../index.html">D1.4 Open source client-side software</a> - 02/18/22</span>
</div>
</body>
</html>
......@@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="date" content='02/17/22'>
<meta name="date" content='02/18/22'>
<title>D1.4 Open source client-side software</title>
<link rel="stylesheet" href='../style/style.css' type="text/css">
</head>
......@@ -79,11 +79,11 @@
<pre><code>GET /git/config/{dbName}/{gitWorkingTree}</code></pre>
<p>This operation returns in the response body the content of the Git config file of the given Git working tree <code>{gitWorkingTree}</code> of the project with the given name <code>{dbName}</code>.</p>
<p><strong>Get files from a Git working tree</strong> (REST API 🔐, see GitApi.getGitFiles in SDK):</p>
<pre><code>GET /git/files/{dbName}/{gitWorkingTree}</code></pre>
<p>This operation returns in the response body the files of the given Git working tree <code>{gitWorkingTree}</code> and the project with the given name <code>{dbName}</code>.</p>
<pre><code>GET /git/files/{dbName}/{gitWorkingTree}?abbrev=…</code></pre>
<p>This operation returns in the response body the files of the given Git working tree <code>{gitWorkingTree}</code> and the project with the given name <code>{dbName}</code>. When the <code>abbrev</code> query parameter is set to true, this operation returns only file metadata and suppresses the file content from the response.</p>
<p><strong>Get a file from a Git working tree</strong> (REST API 🔐, see GitApi.getGitFile in SDK):</p>
<pre><code>GET /git/files/{dbName}/{gitWorkingTree}/{filename}</code></pre>
<p>This operation returns in the response body the file with the given name <code>{filename}</code> of the given Git working tree <code>{gitWorkingTree}</code> and the project with the given name <code>{dbName}</code>.</p>
<pre><code>GET /git/files/{dbName}/{gitWorkingTree}/{filename}?abbrev=…</code></pre>
<p>This operation returns in the response body the file with the given name <code>{filename}</code> of the given Git working tree <code>{gitWorkingTree}</code> and the project with the given name <code>{dbName}</code>. When the <code>abbrev</code> query parameter is set to true, this operation returns only file metadata and suppresses the file content from the response.</p>
<p><strong>Get metadata about Git working trees</strong> (REST API 🔐, see GitApi.getGitWorkingTrees in SDK):</p>
<pre><code>GET /git/working_trees/{dbName}</code></pre>
<p>This operation returns in the response body the metadata of all Git working trees in the project with the given name <code>{dbName}</code>. The schema for the Git working trees is available on the <a href="https://gitlab.ow2.org/decoder/pkm-api/-/blob/master/api/pkm-git-working-tree-schema.json">pkm-api gitlab repository</a>.</p>
......@@ -113,7 +113,7 @@
<p>Note that the default behavior of the PKM is to fully synchronize the PKM Files and the Git working trees before and after running a Git command sequence, and after when deleting some files in a Git working tree.</p>
</div>
<div id="footer">
<span><a href="../index.html">D1.4 Open source client-side software</a> - 02/17/22</span>
<span><a href="../index.html">D1.4 Open source client-side software</a> - 02/18/22</span>
</div>
</body>
</html>
......@@ -108,15 +108,17 @@ This operation returns in the response body the content of the Git config file o
**Get files from a Git working tree** (REST API 🔐, see GitApi.getGitFiles in SDK):
GET /git/files/{dbName}/{gitWorkingTree}
GET /git/files/{dbName}/{gitWorkingTree}?abbrev=…
This operation returns in the response body the files of the given Git working tree `{gitWorkingTree}` and the project with the given name `{dbName}`.
When the `abbrev` query parameter is set to true, this operation returns only file metadata and suppresses the file content from the response.
**Get a file from a Git working tree** (REST API 🔐, see GitApi.getGitFile in SDK):
GET /git/files/{dbName}/{gitWorkingTree}/{filename}
GET /git/files/{dbName}/{gitWorkingTree}/{filename}?abbrev=…
This operation returns in the response body the file with the given name `{filename}` of the given Git working tree `{gitWorkingTree}` and the project with the given name `{dbName}`.
When the `abbrev` query parameter is set to true, this operation returns only file metadata and suppresses the file content from the response.
**Get metadata about Git working trees** (REST API 🔐, see GitApi.getGitWorkingTrees in SDK):
......
......@@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="date" content='02/17/22'>
<meta name="date" content='02/18/22'>
<title>D1.4 Open source client-side software</title>
<link rel="stylesheet" href='../style/style.css' type="text/css">
</head>
......@@ -1019,7 +1019,7 @@
<p>When the query part is missing, this deletes all the Methodology phases.</p>
</div>
<div id="footer">
<span><a href="../index.html">D1.4 Open source client-side software</a> - 02/17/22</span>
<span><a href="../index.html">D1.4 Open source client-side software</a> - 02/18/22</span>
</div>
</body>
</html>
......@@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="date" content='02/17/22'>
<meta name="date" content='02/18/22'>
<title>D1.4 Open source client-side software</title>
<link rel="stylesheet" href='../style/style.css' type="text/css">
</head>
......@@ -187,7 +187,7 @@
<p>When an Excavator job is running asynchronously, this operation allows polling the Excavator job with the given identifier <code>{jobId}</code> until job completion. The job is dequeued when client polls a completed job (either finished or failed).</p>
</div>
<div id="footer">
<span><a href="../index.html">D1.4 Open source client-side software</a> - 02/17/22</span>
<span><a href="../index.html">D1.4 Open source client-side software</a> - 02/18/22</span>
</div>
</body>
</html>
......@@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="date" content='02/17/22'>
<meta name="date" content='02/18/22'>
<title>D1.4 Open source client-side software</title>
<link rel="stylesheet" href='../style/style.css' type="text/css">
</head>
......@@ -46,49 +46,49 @@
<pre><code>GET /io/{dbName}/{filename}?key=…</code></pre>
<p>This operation returns in the response body the requested file content. Unlike other PKM operations, the client shall pass the PKM access key in the query part of URL using the parameter named <code>key</code>. This operation is convenient for directly downloading a file from the PKM through HTTP(S) with the right content type (MIME type), so that a web browser, which has support for the content type, can seamlessly display it.</p>
<p><strong>Get all files</strong> (REST API 🔐, see FilesApi.getFiles in SDK):</p>
<pre><code>GET /files/{dbName}</code></pre>
<p>This operation returns in the response body a list of all files in the project with the given name <code>{dbName}</code>.</p>
<pre><code>GET /files/{dbName}?abbrev=…</code></pre>
<p>This operation returns in the response body a list of all files in the project with the given name <code>{dbName}</code>. When the <code>abbrev</code> query parameter is set to true, this operation returns only file metadata and suppresses the file content from the response.</p>
<p><strong>Get a file</strong> (REST API 🔐, see FilesApi.getFile in SDK):</p>
<pre><code>GET /files/{dbName}/{filename}</code></pre>
<p>This operation returns in the response body a list containing only the file with the given name <code>{filename}</code> of the project with the given name <code>{dbName}</code>.</p>
<pre><code>GET /files/{dbName}/{filename}?abbrev=…</code></pre>
<p>This operation returns in the response body a list containing only the file with the given name <code>{filename}</code> of the project with the given name <code>{dbName}</code>. When the <code>abbrev</code> query parameter is set to true, this operation returns only file metadata and suppresses the file content from the response.</p>
<p><strong>Get files</strong> (CLI):</p>
<pre><code>$ get_files --user=garfield --db=OpenCV --root=$(pwd) &#39;OpenCV/modules/core/src/matrix_sparse.cpp&#39;</code></pre>
<p><strong>Get files of a directory</strong> (CLI):</p>
<pre><code>$ get_files --user=garfield --db=OpenCV --root=$(pwd) --directory=repository</code></pre>
<h3 id="source-codes">9.1.1 Source codes <a id="1.1"></a></h3>
<p><strong>Get source code files</strong> (REST API 🔐, see CodeApi.getRawSourceCodes in SDK):</p>
<pre><code>GET /code/rawsourcecode/{dbName}</code></pre>
<p>This operation returns in the response body a list of all source code files in the project with the given name <code>{dbName}</code>.</p>
<pre><code>GET /code/rawsourcecode/{dbName}?abbrev=…</code></pre>
<p>This operation returns in the response body a list of all source code files in the project with the given name <code>{dbName}</code>. When the <code>abbrev</code> query parameter is set to true, this operation returns only source code file metadata and suppresses the source code file content from the response.</p>
<p><strong>Get a source code file</strong> (REST API 🔐, see CodeApi.getRawSourceCode in SDK):</p>
<pre><code>GET /code/rawsourcecode/{dbName}/{filename}</code></pre>
<p>This operation returns in the response body a list containing only the source code file with the given name <code>{filename}</code> of the project with the given name <code>{dbName}</code>.</p>
<pre><code>GET /code/rawsourcecode/{dbName}/{filename}?abbrev=…</code></pre>
<p>This operation returns in the response body a list containing only the source code file with the given name <code>{filename}</code> of the project with the given name <code>{dbName}</code>. When the <code>abbrev</code> query parameter is set to true, this operation returns only source code file metadata and suppresses the source code file content from the response.</p>
<p><strong>Get source code files</strong> (CLI):</p>
<pre><code>$ get_source_files --user=garfield --db=myproject main.c</code></pre>
<h3 id="uml">9.1.2 UML <a id="1.2"></a></h3>
<p><strong>Get UML2 files</strong> (REST API 🔐, see UMLApi.getRawUMLs in SDK):</p>
<pre><code>GET /uml/rawuml/{dbName}</code></pre>
<p>This operation returns in the response body a list of all UML files in the project with the given name <code>{dbName}</code>.</p>
<pre><code>GET /uml/rawuml/{dbName}?abbrev=…</code></pre>
<p>This operation returns in the response body a list of all UML files in the project with the given name <code>{dbName}</code>. When the <code>abbrev</code> query parameter is set to true, this operation returns only UML file metadata and suppresses the UML file content from the response.</p>
<p><strong>Get a UML2 file</strong> (REST API 🔐, see UMLApi.getRawUML in SDK):</p>
<pre><code>GET /uml/rawuml/{dbName}/{filename}</code></pre>
<p>This operation returns in the response body a list containing only the UML file with the given name <code>{filename}</code> of the project with the given name <code>{dbName}</code>.</p>
<pre><code>GET /uml/rawuml/{dbName}/{filename}?abbrev=…</code></pre>
<p>This operation returns in the response body a list containing only the UML file with the given name <code>{filename}</code> of the project with the given name <code>{dbName}</code>. When the <code>abbrev</code> query parameter is set to true, this operation returns only UML file metadata and suppresses the UML file content from the response.</p>
<p><strong>Get UML2 files</strong> (CLI):</p>
<pre><code>$ get_uml_files --user=garfield --db=myproject model.uml</code></pre>
<h3 id="documentation">9.1.3 Documentation <a id="1.3"></a></h3>
<p><strong>Get documentation files</strong> (REST API 🔐, see DocApi.getRawDocs in SDK):</p>
<pre><code>GET /doc/rawdoc/{dbName}</code></pre>
<p>This operation returns in the response body a list of all documentation files in the project with the given name <code>{dbName}</code>.</p>
<pre><code>GET /doc/rawdoc/{dbName}?abbrev=…</code></pre>
<p>This operation returns in the response body a list of all documentation files in the project with the given name <code>{dbName}</code>. When the <code>abbrev</code> query parameter is set to true, this operation returns only documentation file metadata and suppresses the documentation file content from the response.</p>
<p><strong>Get a documentation file</strong> (REST API 🔐, see DocApi.getRawDoc in SDK):</p>
<pre><code>GET /doc/rawdoc/{dbName}/{filename}</code></pre>
<p>This operation returns in the response body a list containing only the documentation file with the given name <code>{filename}</code> of the project with the given name <code>{dbName}</code>.</p>
<pre><code>GET /doc/rawdoc/{dbName}/{filename}?abbrev=…</code></pre>
<p>This operation returns in the response body a list containing only the documentation file with the given name <code>{filename}</code> of the project with the given name <code>{dbName}</code>. When the <code>abbrev</code> query parameter is set to true, this operation returns only documentation file metadata and suppresses the documentation file content from the response.</p>
<p><strong>Get documentation files</strong> (CLI):</p>
<pre><code>$ get_doc_files --user=garfield --db=myproject doc.docx</code></pre>
<h3 id="executable-binaries">9.1.4 Executable binaries <a id="1.4"></a></h3>
<p><strong>Get executable binary files</strong> (REST API 🔐, see ExecutableBinaryApi.getExecutableBinaries in SDK):</p>
<pre><code>GET /bin/executable/{dbName}</code></pre>
<p>This operation returns in the response body a list of all executable binary files in the project with the given name <code>{dbName}</code>.</p>
<pre><code>GET /bin/executable/{dbName}?abbrev=…</code></pre>
<p>This operation returns in the response body a list of all executable binary files in the project with the given name <code>{dbName}</code>. When the <code>abbrev</code> query parameter is set to true, this operation returns only executable binary file metadata and suppresses the executable binary file content from the response.</p>
<p><strong>Get an executable binary file</strong> (REST API 🔐, see ExecutableBinaryApi.getExecutableBinary in SDK):</p>
<pre><code>GET /bin/executable/{dbName}/{filename}</code></pre>
<p>This operation returns in the response body a list containing only the executable binary file with the given name <code>{filename}</code> of the project with the given name <code>{dbName}</code>.</p>
<pre><code>GET /bin/executable/{dbName}/{filename}?abbrev=…</code></pre>
<p>This operation returns in the response body a list containing only the executable binary file with the given name <code>{filename}</code> of the project with the given name <code>{dbName}</code>. When the <code>abbrev</code> query parameter is set to true, this operation returns only executable binary file metadata and suppresses the executable binary file content from the response.</p>
<p><strong>Get executable binary files</strong> (CLI):</p>
<pre><code>$ get_executable_binary_files --user=garfield --db=linux --root=$(pwd) vmlinux</code></pre>
<h2 id="source-code">9.2 Source code <a id="2"></a></h2>
......@@ -362,11 +362,11 @@
<p>This operation returns in the response body the traceability matrix cell with the given identifier <code>{artefactId}</code> of the project with the given name <code>{dbName}</code>.</p>
<h2 id="logs-and-reports">9.9 Logs and reports <a id="9"></a></h2>
<p><strong>Get logs</strong> (REST API 🔐, see LogApi.getLogs in SDK):</p>
<pre><code>GET /log/{dbName}</code></pre>
<p>This operation returns in the response body a list of all logs in the project with the given name <code>{dbName}</code>.</p>
<pre><code>GET /log/{dbName}?abbrev=…</code></pre>
<p>This operation returns in the response body a list of all logs in the project with the given name <code>{dbName}</code>. When the <code>abbrev</code> query parameter is set to true, this operation returns only log metadata and suppresses the messages, warnings, errors, and details of log from the response.</p>
<p><strong>Get a log</strong> (REST API 🔐, see LogApi.getLog in SDK):</p>
<pre><code>GET /log/{dbName}/{artefactId}</code></pre>
<p>This operation returns in the response body the log with the given identifier <code>{artefactId}</code> of the project with the given name <code>{dbName}</code>.</p>
<pre><code>GET /log/{dbName}/{artefactId}?abbrev=…</code></pre>
<p>This operation returns in the response body the log with the given identifier <code>{artefactId}</code> of the project with the given name <code>{dbName}</code>. When the <code>abbrev</code> query parameter is set to true, this operation returns only log metadata and suppresses the messages, warnings, errors, and details of log from the response.</p>
<h2 id="testar">9.10 TESTAR <a id="10"></a></h2>
<p><strong>Get all TESTAR settings</strong> (REST API 🔐, see TESTARApi.getTESTARSettings in SDK):</p>
<pre><code>GET /testar/settings/{dbName}</code></pre>
......@@ -395,23 +395,23 @@
</ul>
<h2 id="projects">9.12 Projects <a id="12"></a></h2>
<p><strong>Get projects</strong> (REST API 🔐, see ProjectApi.getProjects in SDK):</p>
<pre><code>GET /project</code></pre>
<p>This operation returns in the response body the list of all projects.</p>
<pre><code>GET /project?abbrev=…</code></pre>
<p>This operation returns in the response body the list of all projects. When the <code>abbrev</code> query parameter is set to true, this operation returns only project name and members.</p>
<p><strong>Get projects</strong> (CLI):</p>
<pre><code>$ get_projects --user=garfield</code></pre>
<p><strong>Get a project</strong> (REST API 🔐, see ProjectApi.getProject in SDK):</p>
<pre><code>GET /project/{projectName}</code></pre>
<p>This operation returns in the response body the project with the given name <code>{projectName}</code>.</p>
<pre><code>GET /project/{projectName}?abbrev=…</code></pre>
<p>This operation returns in the response body the project with the given name <code>{projectName}</code>. When the <code>abbrev</code> query parameter is set to true, this operation returns only project name and members.</p>
<p><strong>Get a project</strong> (CLI):</p>
<pre><code>$ get_project --user=garfield --project=myproject</code></pre>
<p><strong>Get user’s projects</strong> (REST API 🔐, see UserApi.getUserProjects in SDK):</p>
<pre><code>GET /user/{userName}/project</code></pre>
<p>This operation returns in the response body the list of all projects when the user with given name <code>{userName}</code> is a member (i.e. he has a role in the project).</p>
<pre><code>GET /user/{userName}/project?abbrev=…</code></pre>
<p>This operation returns in the response body the list of all projects when the user with given name <code>{userName}</code> is a member (i.e. he has a role in the project). When the <code>abbrev</code> query parameter is set to true, this operation returns only project name and members.</p>
<p><strong>Get user’s projects</strong> (CLI):</p>
<pre><code>$ get_user_projects --user=garfield</code></pre>
<p><strong>Get user’s project</strong> (REST API 🔐, see UserApi.getUserProject in SDK):</p>
<pre><code>GET /user/{userName}/project/{projectName}</code></pre>
<p>This operation returns in the response body the project with given <code>{projectName}</code> where the user with given name <code>{userName}</code> is a member (i.e. he has a role in the project).</p>
<pre><code>GET /user/{userName}/project/{projectName}?abbrev=…</code></pre>
<p>This operation returns in the response body the project with given <code>{projectName}</code> where the user with given name <code>{userName}</code> is a member (i.e. he has a role in the project). When the <code>abbrev</code> query parameter is set to true, this operation returns only project name and members.</p>
<h2 id="users">9.13 Users <a id="13"></a></h2>
<p><strong>Get current user</strong> (REST API 🔐, see UserApi.getCurrentUser in SDK):</p>
<pre><code>GET /user/current</code></pre>
......@@ -452,7 +452,7 @@
<p>When the query part is missing, this returns all the Methodology phases.</p>
</div>
<div id="footer">
<span><a href="../index.html">D1.4 Open source client-side software</a> - 02/17/22</span>
<span><a href="../index.html">D1.4 Open source client-side software</a> - 02/18/22</span>
</div>
</body>
</html>
......@@ -42,15 +42,17 @@ This operation is convenient for directly downloading a file from the PKM throug
**Get all files** (REST API 🔐, see FilesApi.getFiles in SDK):
GET /files/{dbName}
GET /files/{dbName}?abbrev=…
This operation returns in the response body a list of all files in the project with the given name `{dbName}`.
When the `abbrev` query parameter is set to true, this operation returns only file metadata and suppresses the file content from the response.
**Get a file** (REST API 🔐, see FilesApi.getFile in SDK):
GET /files/{dbName}/{filename}
GET /files/{dbName}/{filename}?abbrev=…
This operation returns in the response body a list containing only the file with the given name `{filename}` of the project with the given name `{dbName}`.
When the `abbrev` query parameter is set to true, this operation returns only file metadata and suppresses the file content from the response.
**Get files** (CLI):
......@@ -64,15 +66,17 @@ This operation returns in the response body a list containing only the file with
**Get source code files** (REST API 🔐, see CodeApi.getRawSourceCodes in SDK):
GET /code/rawsourcecode/{dbName}
GET /code/rawsourcecode/{dbName}?abbrev=…
This operation returns in the response body a list of all source code files in the project with the given name `{dbName}`.
When the `abbrev` query parameter is set to true, this operation returns only source code file metadata and suppresses the source code file content from the response.
**Get a source code file** (REST API 🔐, see CodeApi.getRawSourceCode in SDK):
GET /code/rawsourcecode/{dbName}/{filename}
GET /code/rawsourcecode/{dbName}/{filename}?abbrev=…
This operation returns in the response body a list containing only the source code file with the given name `{filename}` of the project with the given name `{dbName}`.
When the `abbrev` query parameter is set to true, this operation returns only source code file metadata and suppresses the source code file content from the response.
**Get source code files** (CLI):
......@@ -82,15 +86,17 @@ This operation returns in the response body a list containing only the source co
**Get UML2 files** (REST API 🔐, see UMLApi.getRawUMLs in SDK):
GET /uml/rawuml/{dbName}
GET /uml/rawuml/{dbName}?abbrev=…
This operation returns in the response body a list of all UML files in the project with the given name `{dbName}`.
When the `abbrev` query parameter is set to true, this operation returns only UML file metadata and suppresses the UML file content from the response.
**Get a UML2 file** (REST API 🔐, see UMLApi.getRawUML in SDK):
GET /uml/rawuml/{dbName}/{filename}
GET /uml/rawuml/{dbName}/{filename}?abbrev=…
This operation returns in the response body a list containing only the UML file with the given name `{filename}` of the project with the given name `{dbName}`.
When the `abbrev` query parameter is set to true, this operation returns only UML file metadata and suppresses the UML file content from the response.
**Get UML2 files** (CLI):
......@@ -100,15 +106,17 @@ This operation returns in the response body a list containing only the UML file
**Get documentation files** (REST API 🔐, see DocApi.getRawDocs in SDK):
GET /doc/rawdoc/{dbName}
GET /doc/rawdoc/{dbName}?abbrev=…
This operation returns in the response body a list of all documentation files in the project with the given name `{dbName}`.
When the `abbrev` query parameter is set to true, this operation returns only documentation file metadata and suppresses the documentation file content from the response.
**Get a documentation file** (REST API 🔐, see DocApi.getRawDoc in SDK):
GET /doc/rawdoc/{dbName}/{filename}
GET /doc/rawdoc/{dbName}/{filename}?abbrev=…
This operation returns in the response body a list containing only the documentation file with the given name `{filename}` of the project with the given name `{dbName}`.
When the `abbrev` query parameter is set to true, this operation returns only documentation file metadata and suppresses the documentation file content from the response.
**Get documentation files** (CLI):
......@@ -118,15 +126,17 @@ This operation returns in the response body a list containing only the documenta
**Get executable binary files** (REST API 🔐, see ExecutableBinaryApi.getExecutableBinaries in SDK):
GET /bin/executable/{dbName}
GET /bin/executable/{dbName}?abbrev=…
This operation returns in the response body a list of all executable binary files in the project with the given name `{dbName}`.
When the `abbrev` query parameter is set to true, this operation returns only executable binary file metadata and suppresses the executable binary file content from the response.
**Get an executable binary file** (REST API 🔐, see ExecutableBinaryApi.getExecutableBinary in SDK):
GET /bin/executable/{dbName}/{filename}
GET /bin/executable/{dbName}/{filename}?abbrev=…
This operation returns in the response body a list containing only the executable binary file with the given name `{filename}` of the project with the given name `{dbName}`.
When the `abbrev` query parameter is set to true, this operation returns only executable binary file metadata and suppresses the executable binary file content from the response.