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

Fixed REST API documentation. Some values were not recognized as paramters by swagger script

This commit is contained in:
Michael Hackstein 2014-08-07 14:14:25 +02:00
parent e96a51f44d
commit a5b35f224a
8 changed files with 21 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
arangod/RestHandler/RestDocumentHandler.cpp
View File

@ -429,7 +429,7 @@ bool RestDocumentHandler::readDocument () {
/// @startDocuBlock REST_DOCUMENT_READ
/// @brief reads a single document
///
/// @RESTHEADER{GET /_api/document/document-handle,Read document}
/// @RESTHEADER{GET /_api/document/{document-handle},Read document}
///
/// @RESTURLPARAMETERS
///
@ -835,7 +835,7 @@ bool RestDocumentHandler::getAllDocumentsCoordinator (
/// @startDocuBlock REST_DOCUMENT_READ_HEAD
/// @brief reads a single document head
///
/// @RESTHEADER{HEAD /_api/document/document-handle,Read document header}
/// @RESTHEADER{HEAD /_api/document/{document-handle},Read document header}
///
/// @RESTURLPARAMETERS
///
@ -917,7 +917,7 @@ bool RestDocumentHandler::checkDocument () {
/// @startDocuBlock REST_DOCUMENT_REPLACE
/// @brief replaces a document
///
/// @RESTHEADER{PUT /_api/document/document-handle,Replace document}
/// @RESTHEADER{PUT /_api/document/{document-handle},Replace document}
///
/// @RESTBODYPARAM{document,json,required}
/// A JSON representation of the new document.
@ -1138,7 +1138,7 @@ bool RestDocumentHandler::replaceDocument () {
/// @startDocuBlock REST_DOCUMENT_UPDATE
/// @brief updates a document
///
/// @RESTHEADER{PATCH /_api/document/document-handle, Patch document}
/// @RESTHEADER{PATCH /_api/document/{document-handle}, Patch document}
///
/// @RESTBODYPARAM{document,json,required}
/// A JSON representation of the document update.
@ -1554,7 +1554,7 @@ bool RestDocumentHandler::modifyDocumentCoordinator (
/// @startDocuBlock REST_DOCUMENT_DELETE
/// @brief deletes a document
///
/// @RESTHEADER{DELETE /_api/document/document-handle, Deletes document}
/// @RESTHEADER{DELETE /_api/document/{document-handle}, Deletes document}
///
/// @RESTURLPARAMETERS
///

10
arangod/RestHandler/RestEdgeHandler.cpp
View File

@ -353,7 +353,7 @@ bool RestEdgeHandler::createDocumentCoordinator (string const& collname,
/// @startDocuBlock API_EDGE_READ
/// @brief reads a single edge
///
/// @RESTHEADER{GET /_api/edge/document-handle, Read edge}
/// @RESTHEADER{GET /_api/edge/{document-handle}, Read edge}
///
/// @RESTURLPARAMETERS
///
@ -433,7 +433,7 @@ bool RestEdgeHandler::createDocumentCoordinator (string const& collname,
/// @startDocuBlock API_EDGE_READ_HEAD
/// @brief reads a single edge head
///
/// @RESTHEADER{HEAD /_api/edge/document-handle, Read edge header}
/// @RESTHEADER{HEAD /_api/edge/{document-handle}, Read edge header}
///
/// @RESTURLPARAMETERS
///
@ -480,7 +480,7 @@ bool RestEdgeHandler::createDocumentCoordinator (string const& collname,
/// @startDocuBlock API_EDGE_REPLACE
/// @brief replaces an edge
///
/// @RESTHEADER{PUT /_api/edge/document-handle,replaces an edge}
/// @RESTHEADER{PUT /_api/edge/{document-handle},replaces an edge}
///
/// @RESTBODYPARAM{edge,json,required}
/// A JSON representation of the new edge data.
@ -608,7 +608,7 @@ bool RestEdgeHandler::createDocumentCoordinator (string const& collname,
/// @startDocuBlock API_EDGE_UPDATES
/// @brief updates an edge
///
/// @RESTHEADER{PATCH /_api/edge/document-handle, Patches edge}
/// @RESTHEADER{PATCH /_api/edge/{document-handle}, Patches edge}
///
/// @RESTBODYPARAM{document,json,required}
/// A JSON representation of the edge update.
@ -712,7 +712,7 @@ bool RestEdgeHandler::createDocumentCoordinator (string const& collname,
/// @startDocuBlock API_EDGE_DELETE
/// @brief deletes an edge
///
/// @RESTHEADER{DELETE /_api/edge/document-handle, Deletes edge}
/// @RESTHEADER{DELETE /_api/edge/{document-handle}, Deletes edge}
///
/// @RESTURLPARAMETERS
///

4
arangod/RestHandler/RestReplicationHandler.cpp
View File

@ -647,7 +647,7 @@ void RestReplicationHandler::handleCommandLoggerSetConfig () {
////////////////////////////////////////////////////////////////////////////////
/// @brief handle a dump batch command
///
/// @RESTHEADER{PUT /_api/replication/batch/id, Prolong existing dump batch}
/// @RESTHEADER{PUT /_api/replication/batch/{id}, Prolong existing dump batch}
///
/// @RESTBODYPARAM{body,json,required}
/// A JSON object with the batch configration.
@ -687,7 +687,7 @@ void RestReplicationHandler::handleCommandLoggerSetConfig () {
////////////////////////////////////////////////////////////////////////////////
/// @brief handle a dump batch command
///
/// @RESTHEADER{DELETE /_api/replication/batch/id, Deletes an existing dump batch}
/// @RESTHEADER{DELETE /_api/replication/batch/{id}, Deletes an existing dump batch}
///
/// @RESTURLPARAMETERS
///

2
js/actions/api-aqlfunction.js
View File

@ -186,7 +186,7 @@ function post_api_aqlfunction (req, res) {
/// @startDocuBlock JSF_delete_api_aqlfunction
/// @brief remove an existing AQL user function
///
/// @RESTHEADER{DELETE /_api/aqlfunction/name, Remove existing AQL user function}
/// @RESTHEADER{DELETE /_api/aqlfunction/{name}, Remove existing AQL user function}
///
/// @RESTURLPARAMETERS
///

4
js/actions/api-cursor.js
View File

@ -379,7 +379,7 @@ function post_api_cursor(req, res) {
/// @startDocuBlock JSF_post_api_cursor_identifier
/// @brief return the next results from an existing cursor
///
/// @RESTHEADER{PUT /_api/cursor/cursor-identifier, Read next batch from cursor}
/// @RESTHEADER{PUT /_api/cursor/{cursor-identifier}, Read next batch from cursor}
///
/// @RESTURLPARAMETERS
///
@ -501,7 +501,7 @@ function put_api_cursor (req, res) {
/// @startDocuBlock JSF_post_api_cursor_delete
/// @brief dispose an existing cursor
///
/// @RESTHEADER{DELETE /_api/cursor/cursor-identifier, Delete cursor}
/// @RESTHEADER{DELETE /_api/cursor/{cursor-identifier}, Delete cursor}
///
/// @RESTURLPARAMETERS
///

2
js/actions/api-database.js
View File

@ -397,7 +397,7 @@ function post_api_database (req, res) {
/// @startDocuBlock JSF_get_api_database_delete
/// @brief drop an existing database
///
/// @RESTHEADER{DELETE /_api/database/database-name, Drop database}
/// @RESTHEADER{DELETE /_api/database/{database-name}, Drop database}
///
/// @RESTURLPARAMETERS
///

2
js/actions/api-edges.js
View File

@ -42,7 +42,7 @@ var API = "/_api/edges";
/// @startDocuBlock API_EDGE_READINOUTBOUND
/// @brief get edges
///
/// @RESTHEADER{GET /_api/edges/collection-id, Read in- or outbound edges}
/// @RESTHEADER{GET /_api/edges/{collection-id}, Read in- or outbound edges}
///
/// @RESTURLPARAMETERS
///

5
js/actions/api-graph.js
View File

@ -1223,13 +1223,16 @@ function post_graph_all_vertices (req, res, g) {
////////////////////////////////////////////////////////////////////////////////
/// @brief get neighbors of a vertex
///
/// @RESTHEADER{POST /_api/graph/`graph-name`/vertices/`vertice-name`,get vertices}
/// @RESTHEADER{POST /_api/graph/`graph-name`/vertices/`vertex-name`,get vertices}
///
/// @RESTURLPARAMETERS
///
/// @RESTURLPARAM{graph-name,string,required}
/// The name of the graph
///
/// @RESTURLPARAM{vertex-name,string,required}
/// The key of the vertex
///
/// @RESTBODYPARAM{graph,json,required}
/// The call expects a JSON hash array as body to filter the result:
///