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
Jan Steemann
82ba366eef
removed non-existing paths
2015-08-20 20:39:53 +02:00
Willi Goesgens
7014a94225
Use highlight.js for the examples
2015-08-17 11:50:35 +02:00
Willi Goesgens
068459c70c
move header of examples out of the python script, lint it.
2015-08-16 17:53:03 +02:00
Willi Goesgens
f07e146ad4
Handle combination of multiline and hidden lines
2015-08-14 14:59:27 +02:00
Willi Goesgens
f6767d1fbd
List skipped filenames as a bunch, not one per line.
2015-08-13 14:26:01 +02:00
Willi Goesgens
ab0c69df30
raise error if a broken URL was specified during creating the example.
2015-08-13 13:07:16 +02:00
Willi Goesgens
76dbe1b8cf
execute examples in their complete alphabetical order, regardles of whether they're OUTPUT or RUN
2015-08-11 14:13:53 +02:00
Willi Goesgens
a05e0fb246
Smarten example generator
2015-08-06 17:52:36 +02:00
Willi Goesgens
b412b4b4de
Enable filter to be regexes, so groups of examples can be built.
2015-08-06 15:38:53 +02:00
Willi Goesgens
c6521c0b92
accept blanks before auto-code blocks, so we can have indend blocks in markdown.
2015-08-05 10:22:26 +02:00
Willi Goesgens
021d01e4fe
Rework index documentation; add more executed examples.
2015-08-04 18:42:44 +02:00
Willi Goesgens
0222af45dc
New development mode: generate just one example so you can quicker revalidate the example you're working on.
2015-07-31 16:13:13 +02:00
Jan Steemann
237276c18d
fixed graph examples
2015-06-03 17:10:50 +02:00
Jan Steemann
6dd786fb3c
make temporary file name local
2015-05-06 18:34:03 +02:00
Jan Steemann
72f89c0a91
allow multiple source files per swagger target
2015-05-06 18:31:31 +02:00
Willi Goesgens
f252736a75
Escape html characters while putting examples into swagger templates.
2015-05-05 10:10:38 +02:00
Willi Goesgens
312972a4ec
Modify examples so they clean up after their run.
2015-05-04 17:22:25 +02:00
Willi Goesgens
09ca6253ae
Modify documentation sample generation script
...
- be more inteligent in .js, not so much 'paste it dumb in from python'
- catch errors and report them so the build process will abort
- keep the source filename of the snippet for smarter errormessages
- modularize python code into more functions
- write head & tail .js code from own functions.
2015-04-27 17:05:08 +02:00
Willi Goesgens
bbb7ebef79
Example generator:
...
- restructure generated code, so its a bit more readable
- catch errors, and if some were caught, throw all of them at the end causing make examples to abort.
2015-04-23 10:47:38 +02:00
Jan Steemann
92c8dc9429
fixed documentation
...
Conflicts:
Documentation/Scripts/generateSwaggerApi.py
2015-04-03 13:22:44 +02:00
Jan Steemann
e672d791b5
refactored cursor API, added export API
2015-03-30 18:03:42 +02:00
Jan Steemann
137537f915
issue #1245 : Small bug in Tools -> API (auto-created documentation)
2015-02-13 09:09:49 +01:00
Willi Goesgens
d96907d8da
Implement tastks REST api
...
- Implement REST api for tasks
- Implement wrappers in arangosh
- Add API-documentation
- move unittest from server to common
2014-11-11 12:39:09 +01:00
Jan Steemann
cf6fcb2fc1
linted python files, regenerated derived files
2014-10-29 23:56:20 +01:00
Thomas Schmidts
b1fb5478a7
Fixed wrong API docu for /job
2014-10-28 16:08:59 +01:00
Jan Steemann
275a17e2c4
exclude ahuacatl.js from examples
2014-10-22 10:36:35 +02:00
Thomas Schmidts
e434106051
Fixxed wrong Swagger output
2014-10-06 10:44:03 +02:00
Thomas Schmidts
ac4398ab7e
Changed Swagger for correct API look
2014-07-11 13:21:32 +02:00
Thomas Schmidts
e80b0d0c0a
Changed direction for user in swagger
2014-07-11 10:29:17 +02:00
Frank Celler
d9c9285cc5
release version 2.2.0-alpha3
...
Conflicts:
CHANGELOG
Makefile.in
VERSION
build.h
configure
configure.ac
js/apps/system/aardvark/api-docs.json
js/apps/system/aardvark/api-docs/aqlfunction.json
js/apps/system/aardvark/api-docs/batch.json
js/apps/system/aardvark/api-docs/collection.json
js/apps/system/aardvark/api-docs/cursor.json
js/apps/system/aardvark/api-docs/database.json
js/apps/system/aardvark/api-docs/document.json
js/apps/system/aardvark/api-docs/edge.json
js/apps/system/aardvark/api-docs/edges.json
js/apps/system/aardvark/api-docs/endpoint.json
js/apps/system/aardvark/api-docs/explain.json
js/apps/system/aardvark/api-docs/graph.json
js/apps/system/aardvark/api-docs/import.json
js/apps/system/aardvark/api-docs/index.json
js/apps/system/aardvark/api-docs/query.json
js/apps/system/aardvark/api-docs/replication.json
js/apps/system/aardvark/api-docs/simple.json
js/apps/system/aardvark/api-docs/system.json
js/apps/system/aardvark/api-docs/transaction.json
js/apps/system/aardvark/api-docs/traversal.json
js/apps/system/aardvark/api-docs/version.json
2014-06-25 12:17:30 +02:00
Thomas Schmidts
0d969e6814
Changes in the gitbook, also bug fixing in code
2014-06-24 14:28:30 +02:00
Frank Celler
af109c73ca
Merge branch 'devel' of github.com:triAGENS/ArangoDB into devel
...
Conflicts:
js/server/modules/org/arangodb/foxx/manager.js
2014-06-20 14:41:13 +02:00
Frank Celler
026e600c12
do not print undefined
2014-06-20 14:28:49 +02:00
Jan Steemann
7a9c7f5590
fixed Dutch
2014-06-18 21:15:04 +02:00
Frank Celler
5ea6286029
removed leading blanks
2014-06-18 19:14:34 +02:00
Frank Celler
25e694f8ab
added wildcards
2014-06-18 17:51:24 +02:00
Frank Celler
b0b7be5c28
added ~ and | markers
2014-06-06 17:48:04 +02:00
gschwab
e6a2328438
merged for revert
2014-06-04 17:19:34 +02:00
gschwab
036e29f45b
tabs replaced with spaces
2014-06-04 15:59:17 +02:00
Frank Celler
549368e166
fixed example generation process
2014-05-21 18:09:10 +02:00
Frank Celler
456d089deb
generateSwagger can now also parse MD files
...
Conflicts:
js/apps/system/aardvark/api-docs/batch.json
js/apps/system/aardvark/api-docs/collection.json
js/apps/system/aardvark/api-docs/cursor.json
js/apps/system/aardvark/api-docs/database.json
js/apps/system/aardvark/api-docs/document.json
js/apps/system/aardvark/api-docs/edge.json
js/apps/system/aardvark/api-docs/edges.json
js/apps/system/aardvark/api-docs/endpoint.json
js/apps/system/aardvark/api-docs/graph.json
js/apps/system/aardvark/api-docs/index.json
js/apps/system/aardvark/api-docs/job.json
js/apps/system/aardvark/api-docs/replication.json
js/apps/system/aardvark/api-docs/simple.json
js/apps/system/aardvark/api-docs/system.json
js/apps/system/aardvark/api-docs/traversal.json
js/apps/system/aardvark/api-docs/version.json
2014-03-26 23:09:07 +01:00
Jan Steemann
1500318dd4
fixed documentation errors
2014-01-27 14:50:17 +01:00
Frank Celler
bec2a0e9ef
fixed issue #741 : documentation improvement
...
Conflicts:
Documentation/RefManual/Actions.md
Documentation/UserManual/Foxx.md
Documentation/UserManual/UserManual.md
2014-01-23 23:14:48 +01:00
Jan Steemann
2e301f118d
issue #648 : /batch API is missing from Web Interface API Docummentation (Swagger)
2013-10-29 04:43:34 +01:00
Jan Steemann
7dc8ed7c47
issue #617 : Swagger API is missing '/_api/version'
2013-10-17 11:55:39 +02:00
Jan Steemann
bf771b1010
removed unused script
2013-10-15 09:18:22 +02:00
Jan Steemann
d47aab1950
allow /_api/logs only for the `_system` database
2013-10-07 14:23:48 +02:00
Jan Steemann
d6149c9a9a
added documentation for /_api/import
2013-10-02 14:22:25 +02:00
Jan Steemann
709198c340
updated docs for /_api/jobs
2013-09-28 00:44:03 +02:00
Jan Steemann
73f0405ead
added documentation for endpoints
2013-09-23 16:21:02 +02:00
Jan Steemann
369433f1e2
Merge branch 'devel' of https://github.com/triAGENS/ArangoDB into devel
...
Conflicts:
arangosh/Benchmark/BenchmarkThread.h
lib/SimpleHttpClient/SimpleHttpClient.cpp
2013-09-05 12:34:45 +02:00
Frank Celler
add0573f71
removed old links
2013-07-29 13:27:12 +02:00
Jan Steemann
d8325a1d15
added man page for foxx manager
2013-07-26 22:30:18 +02:00
Jan Steemann
051e898a8a
updated replication documentation
2013-07-25 14:13:53 +02:00
Jan Steemann
ba2bf46d10
auto-generate ArangoDB version
2013-07-25 11:15:06 +02:00
Jan Steemann
8a254ea230
replication API documentation
2013-07-24 17:37:16 +02:00
Jan Steemann
229d00695b
sort list of APIs
2013-07-24 15:29:15 +02:00