From 0760fa8c8da458f88a714d280455c6a8eb85587a Mon Sep 17 00:00:00 2001 From: Thomas Richter Date: Mon, 8 Apr 2013 09:47:34 +0200 Subject: [PATCH] swagger.html path changed --- html/admin/api-docs.json | 2 +- html/admin/api-docs/api-docs.json | 52 +++++++++++++++++++++++++++++++ html/admin/api-docs/document | 18 +---------- html/admin/swagger.html | 2 +- 4 files changed, 55 insertions(+), 19 deletions(-) create mode 100644 html/admin/api-docs/api-docs.json diff --git a/html/admin/api-docs.json b/html/admin/api-docs.json index e5f2fdc693..def52be025 100644 --- a/html/admin/api-docs.json +++ b/html/admin/api-docs.json @@ -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" diff --git a/html/admin/api-docs/api-docs.json b/html/admin/api-docs/api-docs.json new file mode 100644 index 0000000000..b2cb506e4c --- /dev/null +++ b/html/admin/api-docs/api-docs.json @@ -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" + }] + } diff --git a/html/admin/api-docs/document b/html/admin/api-docs/document index 1d0ccfd370..7e22f64346 100644 --- a/html/admin/api-docs/document +++ b/html/admin/api-docs/document @@ -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 document-handle points to a non-existing document, then a HTTP 404 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 HTTP 304 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 HTTP 412 is returned. As an alternative you can supply the etag in an attribute rev in the URL. ", - "code": "412" - }, { "reason": "is returned if the document was found ", "code": "200" @@ -156,7 +140,7 @@ "notes": "Like GET, 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.

", "summary": "reads a document header", "httpMethod": "HEAD", - "examples": "

> 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

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": "

unix> curl --data @- --dump - http://localhost:8529/_api/document/productshead/32256602\n{}\n\n

", "nickname": "readsADocumentHeader" } ], diff --git a/html/admin/swagger.html b/html/admin/swagger.html index f063d40c5d..2885a4e211 100644 --- a/html/admin/swagger.html +++ b/html/admin/swagger.html @@ -58,7 +58,7 @@