1
0
Fork 0
Commit Graph

154 Commits

Author SHA1 Message Date
Simran Brucherseifer e4eeb57e30 Docs: Use standard Markdown notation for headlines and disable MarkdownPP 2016-12-06 02:41:58 +01:00
Wilfried Goesgens d2baa077d0 Fix the representation of the post bodys; thanks to @janavolkova9 for pointing out. 2016-08-01 12:25:37 +02:00
Simran Brucherseifer 963066e42d Replace more require('internal') by require('@arangodb') where possible 2016-07-27 14:44:17 +02:00
Simran Brucherseifer 4b6e84080b Swagger: change the way attribute types are written into the docs
Code in generateMdFiles.py seems to be not used and could probably be removed.
2016-07-18 13:37:48 +02:00
Simran Brucherseifer 90aaf2aed1 Match inline docublocks non-greedy and prevent name collisions by expecting a whitespace character after block name 2016-07-18 12:15:35 +02:00
Alan Plum 9375d49c8c
Nicer error docs 2016-06-17 20:02:24 +02:00
Wilfried Goesgens cf0203ceea Add linebreak in list items. 2016-06-13 18:41:12 +02:00
Wilfried Goesgens a38e61e1e5 Also output the names of errors. 2016-06-13 18:36:34 +02:00
Wilfried Goesgens 9684f192db Fix pasting of swagger documentation 2016-06-13 18:18:14 +02:00
Simran Brucherseifer 23e22f6f39 Rename Users documentation to Manual 2016-05-24 16:09:21 +02:00
Wilfried Goesgens 4506a1ee10 Fix RESTHEADER parts. 2016-05-23 17:06:27 +02:00
Wilfried Goesgens 0b4f5c1c8e Move template files into the general template directory. 2016-05-23 15:46:55 +02:00
Simran Brucherseifer 9645e164f6 Documentation building: also make other scripts aware of additional gitbooks 2016-05-02 20:29:47 +02:00
Frank Celler f6a833ac5d added generateSwagger 2016-03-17 14:40:09 +01:00
Frank Celler e0bb505dda fixed generateExample 2016-03-17 12:00:27 +01:00
Jan Steemann b1988c94b8 reduce variance in generated man pages 2016-02-25 13:48:50 +01:00
Frank Celler fb8965d4b7 fixed manual pages 2016-02-24 19:56:47 +01:00
Frank Celler 48e39567fc fixed man page generation 2016-02-23 21:28:14 +01:00
Wilfried Goesgens 5b5517b8ab Fix error message for exception. 2016-02-10 15:53:15 +01:00
Wilfried Goesgens d2f8021d8e make examples is history now. 2016-02-10 11:21:08 +01:00
Wilfried Goesgens 7da8a09e37 Fix traversing of DocuBlocks directory. 2016-01-12 19:04:55 +01:00
Wilfried Goesgens 5e5b0de5b2 Adjust directories to spider. 2016-01-12 18:23:12 +01:00
Wilfried Goesgens a963cfcf8a `make swagger` now runs on all files in the Documentation/DocuBlocks/Rest 2016-01-12 15:15:14 +01:00
Wilfried Goesgens 623eb02bec Accept linebreaks in the expectError() 2016-01-07 12:58:23 +01:00
Alan Plum 8853ede355 org/arangodb -> @arangodb 2015-12-15 15:51:44 +01:00
Wilfried Goesgens 8d31426eb3 Move python scripts into the scripts directory 2015-12-09 00:00:49 +01:00
Wilfried Goesgens 8f10c2b8a1 Generate markdown from the restdescritpion instead of html. 2015-12-08 23:47:18 +01:00
Jan Steemann b8b9956acc added extra edges handler 2015-12-03 13:11:03 +01:00
Jan Steemann c053c78e51 update swagger file locations 2015-12-03 13:08:43 +01:00
Wilfried Goesgens f4c68b9dd1 raise an exception if a RESTREPLYBODY is seen before RESTRETURNCODE 2015-10-01 20:09:08 +02:00
Wilfried Goesgens a9ea2122d5 Revert 9cd38eba44 again. 2015-09-24 14:09:14 +02:00
Wilfried Goesgens 9cd38eba44 Partially revert 6aabcb99c5 - this http interface is still required for blueprints. 2015-09-23 17:02:42 +02:00
Wilfried Goesgens 6aabcb99c5 Remove deprecated graph documentation. 2015-09-23 14:26:24 +02:00
Wilfried Goesgens 15b1d7cfd5 Migrate sub-structured replies to swagger2 preproc docu style 2015-09-18 17:02:53 +02:00
Wilfried Goesgens 90aab26866 Add html reply logger 2015-09-17 15:54:27 +02:00
Wilfried Goesgens a8e0818444 group the routes in the swagger api to get a leaner toplevel index 2015-09-17 15:53:19 +02:00
Wilfried Goesgens 70a2c74c1b Update RESTAPI documentation handling to work with the swagger 2 api
- use the structures from the swagger for post / reply structures
  - add missing documentation snippets to their respective places
  - fix syntax of documentation blocks
2015-09-16 16:35:13 +02:00
Wilfried Goesgens 176b150c46 Implement possibility to add reply grammers via the documentation. 2015-09-14 10:49:28 +02:00
Willi Goesgens 8d0d1491f8 Propper highlighting and escaping for examples. 2015-09-11 15:04:55 +02:00
Willi Goesgens 9090c83fe1 Add error checks:
- duplicate routes
  - invalid optionals
2015-09-11 11:24:46 +02:00
Willi Goesgens 211b2f083d Make parameter names <strong> 2015-09-10 16:46:28 +02:00
Willi Goesgens 9214ab08a1 - insert parameters into the place where we found it in the docu
- attempt to remove unneccessary br's
2015-09-10 16:22:46 +02:00
Willi Goesgens 116705c85c move the header of the Example into the example context header 2015-09-10 14:53:55 +02:00
Willi Goesgens a1f79533b9 make the required-node optional 2015-09-10 13:27:43 +02:00
Willi Goesgens 57111245f9 - no tempfiles, work directly on the source files
- better handling of sub-structured items
 - better error handling in case of structures are broken
2015-09-10 10:56:17 +02:00
Willi Goesgens e1ae661ae0 Work on multi-dimensional swagger post data 2015-09-09 17:40:51 +02:00
Willi Goesgens eb9e03f3f0 Upgrade the REST-API documentation to to swagger V2.0
Wrap lines in examples.
2015-09-09 15:21:18 +02:00
Willi Goesgens dce738ce9c Escape slashes for dos 2015-08-26 11:36:15 +02:00
Willi Goesgens deb1b6d4f1 use portability path dir separator 2015-08-25 18:08:55 +02:00
Willi Goesgens 2c099b8348 Add a js-scripted way to invoke the example generator - for now it needs a running arangod instance. 2015-08-25 17:56:25 +02:00