1
0
Fork 0
Commit Graph

32 Commits

Author SHA1 Message Date
Simran 5552081df0
Bug fix/fix swagger datatype (#9603)
* Bug fix/fix swagger datatype (#9045)

* remove http so https arangos will work

* verify that query parameters are proper swagger data types, fix offending documentation files

* return the actual type - not the list of available ones

* check formats

* there is no uint64 in swagger

* Fresh Swagger
2019-07-30 13:40:02 +02:00
Wilfried Goesgens 1c0460dcd9 Doc - Remove Swagger schemes (HTTP) to fix it for HTTPS (#9044) 2019-05-20 16:10:04 +02:00
Simran 4c9f488cbe Doc - Deprecation notes 3.4 (#6405) (#7033) 2018-10-23 22:49:55 +02:00
Michael Hackstein 6d99916f84
Documentation3 4/gharial documentation improvements (#6783)
* Ported the improved gharial documentation devel -> 3.4

* Added fix to swagger generator script

* Added missing dots at end of sentences

* MOre dots at end of sentences

* Removed empty lines

* Fixed missing edge_definition remove documentation

* Fixed a typo
2018-10-11 15:18:24 +02:00
Wilfried Goesgens bf32c4e7e1 Doc - add duplicate check in the build script (#5897) 2018-07-18 19:01:07 +02:00
Simran 7bb64a0c5f Doc - Improve Swagger presentation of example code (#5841) 2018-07-11 19:29:22 +02:00
Wilfried Goesgens c4b0ccb56f Doc - fix restheader (#5209) 2018-04-27 13:15:42 +02:00
Wilfried Goesgens 13a179304e Doc - Fixes duplicate text in the HTTP doc - Part 1 (#5153)
Fixes the condition when blocks end, so we can pick blocks with empty lines in them
2018-04-20 12:56:14 +02:00
Manuel B 78f6d0c807 Doc - fix lgtm.com alerts (#4959) 2018-03-27 17:31:13 +01:00
Manuel B ffe11c652a Doc - check for no new line after restdescription (#4883) 2018-03-19 20:40:09 +01:00
Wilfried Goesgens 8297fd38b8 Doc - Fix doc build attempt 2 (#4744) 2018-03-02 15:02:42 +01:00
sleto-it 0ba532b16a
Doc - Replication Refactor - Part 1 (#4555)
Next steps after DC2DC and Cluster doc improvements:

- We refactor replication sections and make more intuitive separation between Master/Slave and the new Active Failover in 3.3
- We create corresponding sections for Master/Slave and Active Failover in the Administration and Deployment chapters, as well as in the Scalability chapter, where these "modes" are introduced
- We touch and improve the "Architecture" chapter as well, where some architecture info have to be placed
- We reorg the TOC having in more "logical" order:
-- Deployment
-- Administration
-- Security
-- Monitoring
-- Troubleshooting
- We adds parts in the TOC
- We add toc per pages, using page-toc plugin
- We also put close together "Scalability" and "Architecture" chapters, preliminary steps of further improvements / aggregation
- We improve swagger

Internal Ref:
- https://github.com/arangodb/planning/issues/1692
- https://github.com/arangodb/planning/issues/1655
- https://github.com/arangodb/planning/issues/1858
- https://github.com/arangodb/planning/issues/973 (partial fix)
- https://github.com/arangodb/planning/issues/1498 (partial fix)
2018-02-28 12:23:19 +01:00
Wilfried Goesgens 0b03d08c02 Documentation/fix swagger (#4622) 2018-02-19 18:54:15 +01:00
Simran 0e0b467a45 Doc - Adds toc plugin (#4577)
Internal Ref: arangodb/planning#1053
2018-02-13 19:04:32 +01:00
Wilfried Goesgens 619155a62d Feature/aqlfunction to cpp (#4573) 2018-02-13 11:50:49 +01:00
Heiko 947771b757 updated swagger to current version: 3.9.0 (#4285) 2018-01-16 00:25:15 +01:00
Jan e04991ca13 add a few missing options for the HTTP API, some general documentation cleanup (#2549) 2017-06-12 18:18:15 +02:00
Alan Plum 5d017d733c Improve Foxx cluster resilience (#2479)
* Improve Foxx cluster resilience

Fixes #2083
Fixes #2384
Fixes #2408
Addresses #1892

* Port old Foxx API

* Implement single-file services

* Add console.errorStack/warnStack/infoStack helpers

* Simplify serviceInfo validation

* Extract github/upload logic into Aardvark and old FM API
* Move generator logic into Aardvark
* Move zip/js buffer logic into FM core

* Add Foxxmanager tests

* Send empty response when no README

* Disambiguate script arg format

Historically we allow passing an array of positional arguments or an arbitrary first argument.
This is surprising behaviour, so we should just always treat the value as a first argument.

* Rebuild bundle in development mode

* Nicer HTTP docs formatting

* Create Foxx HTTP docs

* Simplify service upload handling

* Remove inline swagger docs

* Implement public download route

* Consistency

* Rebuild aardvark

* Move bundle route into /_api/foxx/_local

* Rebuild Swagger API docs

* Add changes to CHANGELOG

* More docs
2017-05-16 17:41:29 +02:00
Frank Celler 0c0936be71 added a newline before generated text 2016-10-14 11:30:43 +02:00
Wilfried Goesgens f7907950d2 Fix swagger generation as reported by @baslr 2016-10-04 12:08:35 +02:00
Wilfried Goesgens 9ae7bb032f Fix indention of sub-structs 2016-09-19 16:34:41 +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
Wilfried Goesgens 2390ebbfeb Escape backslashes in the code in case s.b. wants a verbatim \n 2016-06-13 18:17:27 +02:00
Wilfried Goesgens 3433767eb9 better format the text inbewteen examples - use markdown. 2016-06-09 17:44:22 +02:00
Jan Steemann e77a571fc4 better error messages 2016-06-07 15:48:11 +02:00
Frank Celler cd79a514d3 fixed path 2016-05-11 15:47:33 +02:00
Frank Celler fe62ce6a1a added error message 2016-05-03 14:24:49 +02:00
Max Neunhoeffer 724d37e7d3 Fix generateSwagger script. 2016-05-02 15:53:13 +02:00
Frank Celler b31004e590 removed C_FILE and fixed /// handling 2016-05-02 15:53:13 +02:00
Max Neunhoeffer a92998e54c Improve file and error handling of generateSwagger.py 2016-05-02 15:53:13 +02:00
Frank Celler 8162cf83b9 fixed paths 2016-03-17 14:51:13 +01:00
Frank Celler f6a833ac5d added generateSwagger 2016-03-17 14:40:09 +01:00