Fixing typos and adding extra information to upload
This commit is contained in:
parent
b8d2add858
commit
0513695586
1 changed files with 5 additions and 4 deletions
|
@ -5,10 +5,11 @@
|
||||||
{{ super() }}
|
{{ super() }}
|
||||||
<div>
|
<div>
|
||||||
<h4>Uploading Data</h4>
|
<h4>Uploading Data</h4>
|
||||||
<p>Uploading data is simple, all you need to is send a POST request with content-type <code>application/json</code> to <code>/result</code>.</p>
|
<p>Uploading data is simple, all you need to do is send a POST request with content-type <code>application/json</code> to <code>/result</code>.</p>
|
||||||
<p>Your JSON must respect all the required fields.</p>
|
<p>Your JSON must respect all the required fields, if not, you will get back a <code>400</code> :)</p>
|
||||||
<p>Example: <code>curl -H "Content-Type: application/json" -X POST -d '{"name":"Anonymous", "gpu":"GPU DUMMY TEXT","cpu":"CPU DUMMY TEXT","log":"So this will be a detailed log.","score": 1}' http://localhost:5000/result</code></p>
|
<p>Example: <code>curl -H "Content-Type: application/json" -X POST -d '{"name":"Anonymous", "gpu":"GPU DUMMY TEXT","cpu":"CPU DUMMY TEXT","log":"So this will be a detailed log.","score": 1}' http://localhost:5000/result</code></p>
|
||||||
<p>If the resource has been added sucessfully then the status code of <code>201</code> is returned.</p>
|
<p>If the resource has been added sucessfully then the status code of <code>201</code> is returned, any other status code can be considered an error</p>
|
||||||
<p>The <code>name</code> field can be used with the build in search functionality to search for your own results.</p>
|
<p>The <code>name</code> field can be used with the build in search functionality to search for results.</p>
|
||||||
|
<p>The <code>location</code> header can be inspected for an url to the newly created result.</p>
|
||||||
</div>
|
</div>
|
||||||
{% endblock %}
|
{% endblock %}
|
Loading…
Reference in a new issue