Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

swagger.html path changed

This commit is contained in:
Thomas Richter 2013-04-08 09:47:34 +02:00
parent d725117a65
commit 0760fa8c8d
4 changed files with 55 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
html/admin/api-docs.json
View File

@ -1,7 +1,7 @@
{
"apiVersion":"1.2beta",
"swaggerVersion":"1.1",
"basePath":"http://127.0.0.1:8529/_admin/html/api-docs",
"basexPath":"http://192.168.173.10:8529/_admin/html/api-docs",
"apis":[ {
"path": "/document",
"description": "Interface for Documents"

52
html/admin/api-docs/api-docs.json Normal file
View File

@ -0,0 +1,52 @@
{
"apiVersion":"1.2beta",
"swaggerVersion":"1.1",
"apis":[ {
"path": "/document",
"description": "Interface for Documents"
},
{
"path": "/edges",
"description": "Interface for Edges"
},
{
"path": "/collection",
"description": "Interface for Collections"
},
{
"path": "/graph",
"description": "Interface for Graphs"
},
{
"path": "/user",
"description": "Interface for Users"
},
{
"path": "/system",
"description": "Interface for System"
},
{
"path": "/cursor",
"description": "Interface for Cursors"
},
{
"path": "/explain",
"description": "Interface for Explain"
},
{
"path": "/index",
"description": "Interface for Indexes"
},
{
"path": "/simple",
"description": "Interface for SimpleQueries"
},
{
"path": "/query",
"description": "Interface for Queries"
},
{
"path": "/structure",
"description": "Interface for Structures"
}]
}

18
html/admin/api-docs/document
View File

@ -67,22 +67,6 @@
"operations": [
{
"errorResponses": [
{
"reason": "If the document exists, this is returned and the JSON representation of the document is the body of the response. ",
"code": "200"
},
{
"reason": "If the <b>document-handle</b> points to a non-existing document, then a <b>HTTP 404</b> is returned and the body contains an error document. ",
"code": "404"
},
{
"reason": "If the \"If-None-Match\" header is given, then it must contain exactly one etag. The document is returned, if it has a different revision than the given etag. Otherwise a <b>HTTP 304</b> is returned. ",
"code": "304"
},
{
"reason": "If the \"If-Match\" header is given, then it must contain exactly one etag. The document is returned, if it has the same revision ad the given etag. Otherwise a <b>HTTP 412</b> is returned. As an alternative you can supply the etag in an attribute <b>rev</b> in the URL. ",
"code": "412"
},
{
"reason": "is returned if the document was found ",
"code": "200"
@ -156,7 +140,7 @@
"notes": "Like <b>GET</b>, but only returns the header fields and not the body. You can use this call to get the current revision of a document or check if the document was deleted. <br><br>",
"summary": "reads a document header",
"httpMethod": "HEAD",
"examples": "<br><br><pre><code class=\"json\" >> curl -X HEAD --dump - http://localhost:8529/_api/document/73482/29591342\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"29591342\"\n</code></pre><br> var cn = \"productshead\"; db._drop(cn); db._create(cn); var collection = db._collection(cn); var document = db.productshead.save({\"hallo\":\"world\"}); var url = \"/_api/document/\" + document._id; var response = logCurlRequest('HEAD', url, \"{}\"); assert(response.code === 200); logJsonResponse(response); db._drop(cn); @END_EXAMPLE_ARANGOSH_RUN ",
"examples": "<br><br><pre><code class=\"json\" >unix> curl --data @- --dump - http://localhost:8529/_api/document/productshead/32256602\n{}\n\n</code></pre><br>",
"nickname": "readsADocumentHeader"
}
],

2
html/admin/swagger.html
View File

@ -58,7 +58,7 @@
<script type="text/javascript">
$(function () {
window.swaggerUi = new SwaggerUi({
discoveryUrl:"api-docs.json",
discoveryUrl:"http://192.168.173.10:8529/_admin/html/api-docs/api-docs.json",
apiKey: false,
dom_id:"swagger-ui-container",
supportHeaderParams: true,