Commit 9cf8cc7b authored by Gilles Mouchard's avatar Gilles Mouchard
Browse files

Merged with tools_specs_corrections.

Added documentation for get_users CLI.
parent aa3e8488
Pipeline #19461 passed with stages
in 10 minutes and 5 seconds
......@@ -43,7 +43,7 @@ function help()
console.log("");
console.log("Examples:");
console.log("");
console.log("get_users");
console.log("get_users --user=admin");
console.log("");
console.log("Report bugs to <" + PKM.info.contact.email + ">");
console.log("");
......
......@@ -477,6 +477,7 @@ class PKM
'tools_specs/NER.json',
'tools_specs/openjml.json',
'tools_specs/semparser.json',
'tools_specs/rawtext_semparser.json',
'tools_specs/SRLChunk.json',
'tools_specs/testar.json',
'tools_specs/TraceRecovery.json',
......
......@@ -1103,6 +1103,24 @@ Options:
Examples:
get_user_projects --user=garfield</code></pre>
<p><strong>get_users</strong></p>
<pre><code>Usage: get_users &lt;options&gt;
Get all PKM users.
See &#39;pkm_config.json&#39; for default settings.
Options:
--help display this help and exit
--version output version information and exit
--user=&lt;name&gt; MongoDB user name
--host=&lt;host:port&gt; MongoDB host (default: &#39;pkm-api_mongodb_1:27017&#39;)
--pkm-db=&lt;database&gt; MongoDB PKM management database (default: &#39;pkm&#39;)
--debug enable debugging messages (default: disabled)
Examples:
get_users --user=admin</code></pre>
<p><strong>initialize_PKM</strong></p>
<pre><code>Usage: initialize_PKM &lt;options&gt;
......
......@@ -1241,6 +1241,27 @@ The following REST API documentations (generated with OpenAPI generator) are ava
get_user_projects --user=garfield
**get_users**
Usage: get_users <options>
Get all PKM users.
See 'pkm_config.json' for default settings.
Options:
--help display this help and exit
--version output version information and exit
--user=<name> MongoDB user name
--host=<host:port> MongoDB host (default: 'pkm-api_mongodb_1:27017')
--pkm-db=<database> MongoDB PKM management database (default: 'pkm')
--debug enable debugging messages (default: disabled)
Examples:
get_users --user=admin
**initialize_PKM**
Usage: initialize_PKM <options>
......
......@@ -451,7 +451,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2268">line 2268</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2269">line 2269</a>
</li></ul></dd>
 
......@@ -715,7 +715,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2053">line 2053</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2054">line 2054</a>
</li></ul></dd>
 
......@@ -897,7 +897,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2631">line 2631</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2632">line 2632</a>
</li></ul></dd>
 
......@@ -1056,7 +1056,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2314">line 2314</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2315">line 2315</a>
</li></ul></dd>
 
......@@ -1166,7 +1166,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1486">line 1486</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1487">line 1487</a>
</li></ul></dd>
 
......@@ -1313,7 +1313,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1448">line 1448</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1449">line 1449</a>
</li></ul></dd>
 
......@@ -1423,7 +1423,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1416">line 1416</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1417">line 1417</a>
</li></ul></dd>
 
......@@ -1533,7 +1533,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1504">line 1504</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1505">line 1505</a>
</li></ul></dd>
 
......@@ -1631,7 +1631,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1522">line 1522</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1523">line 1523</a>
</li></ul></dd>
 
......@@ -1778,7 +1778,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1428">line 1428</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1429">line 1429</a>
</li></ul></dd>
 
......@@ -1937,7 +1937,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2444">line 2444</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2445">line 2445</a>
</li></ul></dd>
 
......@@ -2096,7 +2096,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2454">line 2454</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2455">line 2455</a>
</li></ul></dd>
 
......@@ -2391,7 +2391,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1919">line 1919</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1920">line 1920</a>
</li></ul></dd>
 
......@@ -2706,7 +2706,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2183">line 2183</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2184">line 2184</a>
</li></ul></dd>
 
......@@ -2908,7 +2908,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2231">line 2231</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2232">line 2232</a>
</li></ul></dd>
 
......@@ -3018,7 +3018,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1849">line 1849</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1850">line 1850</a>
</li></ul></dd>
 
......@@ -3106,7 +3106,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1892">line 1892</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1893">line 1893</a>
</li></ul></dd>
 
......@@ -13311,7 +13311,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2604">line 2604</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2605">line 2605</a>
</li></ul></dd>
 
......@@ -14583,7 +14583,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2354">line 2354</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2355">line 2355</a>
</li></ul></dd>
 
......@@ -16334,7 +16334,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2649">line 2649</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2650">line 2650</a>
</li></ul></dd>
 
......@@ -16493,7 +16493,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2572">line 2572</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2573">line 2573</a>
</li></ul></dd>
 
......@@ -18011,7 +18011,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1495">line 1495</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1496">line 1496</a>
</li></ul></dd>
 
......@@ -20634,7 +20634,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1513">line 1513</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1514">line 1514</a>
</li></ul></dd>
 
......@@ -21518,7 +21518,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1548">line 1548</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1549">line 1549</a>
</li></ul></dd>
 
......@@ -21966,7 +21966,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1565">line 1565</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1566">line 1566</a>
</li></ul></dd>
 
......@@ -24460,7 +24460,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1531">line 1531</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1532">line 1532</a>
</li></ul></dd>
 
......@@ -24607,7 +24607,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1438">line 1438</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1439">line 1439</a>
</li></ul></dd>
 
......@@ -28203,7 +28203,7 @@ The returned user instance is ready for creating/updating user in the PKM manage
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2341">line 2341</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2342">line 2342</a>
</li></ul></dd>
 
......@@ -28385,7 +28385,7 @@ The returned user instance is ready for creating/updating user in the PKM manage
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2465">line 2465</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2466">line 2466</a>
</li></ul></dd>
 
......@@ -40972,7 +40972,7 @@ The returned user instance is ready for creating/updating user in the PKM manage
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2656">line 2656</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2657">line 2657</a>
</li></ul></dd>
 
......@@ -44742,7 +44742,7 @@ The returned user instance is ready for creating/updating user in the PKM manage
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1865">line 1865</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1866">line 1866</a>
</li></ul></dd>
 
......@@ -44880,7 +44880,7 @@ This function hides PKM management roles that are internal to the implementation
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2327">line 2327</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2328">line 2328</a>
</li></ul></dd>
 
......@@ -45039,7 +45039,7 @@ This function hides PKM management roles that are internal to the implementation
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2620">line 2620</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line2621">line 2621</a>
</li></ul></dd>
 
......@@ -52552,7 +52552,7 @@ If validation is enabled and a valid schema is present, these methods throw an e
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1474">line 1474</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1475">line 1475</a>
</li></ul></dd>
 
......
......@@ -505,6 +505,7 @@ class PKM
'tools_specs/NER.json',
'tools_specs/openjml.json',
'tools_specs/semparser.json',
'tools_specs/rawtext_semparser.json',
'tools_specs/SRLChunk.json',
'tools_specs/testar.json',
'tools_specs/TraceRecovery.json',
......
......@@ -11305,7 +11305,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1536">line 1536</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1537">line 1537</a>
</li></ul></dd>
......@@ -11648,7 +11648,7 @@
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1553">line 1553</a>
<a href="core_pkm.js.html">core/pkm.js</a>, <a href="core_pkm.js.html#line1554">line 1554</a>
</li></ul></dd>
......
......@@ -267,6 +267,11 @@ The following REST API documentations (generated with OpenAPI generator) are ava
%deps "${BIN}/cli_to_md" "${PKM_API}/cli/get_user_projects.js"
%"${BIN}/cli_to_md" "${PKM_API}/cli/get_user_projects.js"
**get_users**
%deps "${BIN}/cli_to_md" "${PKM_API}/cli/get_users.js"
%"${BIN}/cli_to_md" "${PKM_API}/cli/get_users.js"
**initialize_PKM**
%deps "${BIN}/cli_to_md" "${PKM_API}/cli/initialize_PKM.js"
......
......@@ -39,12 +39,12 @@
"text" : {
"description" : "The text to translate into code",
"required" : true,
"type" : "string",
"type" : "string"
},
"context" : {
"description" : "Some context used to improve code generation. Currently unused by the tool",
"required" : false,
"type" : "string",
"type" : "string"
}
}
}
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment