58 Commits

Author SHA1 Message Date
Sullivan SENECHAL
32de80f97f
Fix deprecated route options 2015-10-22 14:42:16 +02:00
William Durand
c71fa155d5
Introduce the concept of 'views'
Rewrite #619
2015-05-16 12:17:59 +02:00
William Durand
94ba751848
fix CS 2015-05-15 17:42:03 +02:00
Joshua Thijssen
6052643b9f
Initial setup on a multi-api documentation 2015-05-15 17:41:22 +02:00
lucasvanlierop
eaaa54bf11 Fixed checking HTTP method type 2014-09-29 16:17:36 +02:00
thenetexperts
e1c7e8a5bd adding optional color codes for tags annotation 2014-08-25 11:27:49 +02:00
Bez Hermoso
6f85aed33c Swagger support:
Unified data types [actualType and subType]
Updated tests.
JMS parsing fixes; updated {Validator,FormType}Parser, FOSRestHandler, and AbstractFormatter, and updated DataTypes enum.
Modified dataType checking.
Updated tests.
Updated DataTypes enum.
Quick fix and added doc comments.
CS fixes.
Refactored FormTypeParser to produce nested parameters. Updated tests accordingly.
Logical and CS fixes.
Sub-forms and more tests.
Logical and CS fixes.
Swagger support: created formatter.
Configuration and resourcePath logic update.
ApiDoc annotation update. Updated formatter and added tests.
Parameter formatting.
Added tests for SwaggerFormatter.
Added  option in annotation, and the corresponding logic for parsing the supplied values and processing them in the formatter.
Routing update.
Updated tests.
Removed unused dependency and updated doc comments.
Renamed 'responseModels' to 'responseMap'
Update the resource filtering and formatting of response messages.
Updated check for 200 response model.
Ignore data_class and always use form-type to avoid conflicts.
Fix: add 'type' even if '' is specified.
Refactored responseMap; added parsedResponseMap. Added tests and updated some.
Fix: add 'type' even if '' is specified.
Initial commit of command.
Finished logic for dumping files.
Updated doc comment; added license and added more meaningful class comment.

Array of models support.
2014-07-29 10:25:05 -07:00
William DURAND
0030ce6825 Merge pull request #358 from pborreli/typos 2014-06-27 10:22:56 +02:00
Pascal Borreli
dbc3fcbb73 Fixed typos 2014-06-27 10:22:36 +02:00
Even André Fiskvik
b4e874e2dc Add support for nullable option in RequestParam 2014-06-25 10:19:30 +02:00
William DURAND
b48650a9e0 Fix CS 2014-06-25 08:52:01 +02:00
Sandro Meier
dfd094371d Implement Tags for functions. 2014-05-27 13:33:50 +02:00
Richard Fullmer
dc8494bbdf Fix an properly document https option 2014-02-06 09:27:30 -08:00
William DURAND
87328e27f5 Merge pull request #206 from dothiv/master
Show authorized roles in key icon tooltip
2013-11-14 11:17:06 +01:00
William DURAND
d7fd929379 Fix CS 2013-11-14 10:33:57 +01:00
Konrad Podgórski
74d30d9e39 Option to set requirements and parameters directly from ApiDoc annotation
Sometimes required parameters are not used through routing but still they are mandatory. I wanted to have API with

resource.json?foo=bar&something=else

format, that was possible through QueryParam annotation or requirements in routing BUT!

There was no way to set dataType or description

This PR solves problem for me.

Side note: if you want to declare e.g. _format requirement through Annotation or any other param that is used in url ({foo} format) then it won't work. Because Bundle still overrides requirements and parameters after the constuctor in ApiDoc is called. This might be solved in separate PR by adding check if given requirements or parameters was already defined.
2013-10-15 15:28:54 +02:00
Florent DUBOST
56fdd4e64c Adding possibilty to name resource 2013-10-11 15:44:31 +02:00
William Durand
c2d36d9ef0 Merge pull request #221 from kmfk/documentation-in-handler
Modify the `documentation` property inside annotation handlers
2013-09-12 01:51:49 -07:00
Vincent CHALAMON
a1517543e8 Enable PHPDoc @link feature 2013-08-16 19:18:05 +02:00
keith kirk
f67dfb05db adds the ability to modify the documentation property inside custom extractor handlers 2013-07-25 13:47:54 -07:00
Nils Wisiol
f764773c89 authenticationRoles can be set to appear in the tooltip of the key icon for API calls that require authentication. 2013-06-24 14:27:22 +02:00
marapper
80b5162c83 Add @QueryParam default support 2013-05-06 10:04:13 +02:00
Anton Kasperovich
344ce0d3b7 Fix: BC with symfony 2.1
Commit #5cc7cf212d break compatibility with Symfony 2.1 (or lower),
because only in 2.2 added host support in routing.
2013-04-12 10:45:20 +03:00
Benjamin Laugueux
5cc7cf212d Added support for host parameter 2013-04-11 22:03:40 +02:00
Patryk Kala
3b6e9da91a Ability to mark function as deprecated 2013-03-31 20:35:46 +02:00
Florent DUBOST
772184cfa1 Add some tests for the cache annotation 2013-03-27 16:20:42 +01:00
Florent DUBOST
53b2537aef Add cache annotation extractor 2013-03-26 11:49:12 +01:00
William DURAND
2fd3f33ad8 Fix 8c9b8331d066269d48ca374280937be264767ee6
* tests
* CS
2013-03-17 16:40:39 +01:00
William DURAND
8c9b8331d0 Merge pull request #138 from drgomesp/section-grouping
Section grouping
2013-03-17 16:13:56 +01:00
William DURAND
43b8f89845 Merge pull request #123 from fvilpoix/authentication_attribute
adding 'authentication' attribute
2013-03-16 18:22:28 +01:00
Toni Van de Voorde
e0fb5c3afe Support multiple descriptions for a Status Code 2013-02-18 21:07:59 +01:00
drgomesp
1f6b7b4788 Set the default section to null and added conditional back 2013-02-14 13:52:20 -02:00
drgomesp
3aa6544159 Removed useless conditional 2013-02-14 13:42:23 -02:00
drgomesp
b7aa5dca72 #25 Added section property to the ApiDoc class 2013-02-13 17:08:00 -02:00
fvilpoix
0aa1619c5f adding 'authentication' attribute 2012-12-26 12:23:28 +01:00
Baldur Rensch
ef5cbd9b73 Added padlock icon for secure routes
This fixes #115
- Added an https property to the annotation
- Added glyphicon padlock icon
- Updated Templates
- Updated Unit tests
2012-12-10 10:21:04 -08:00
William DURAND
923043cb2a Improve doc, update README, "return" param becomes "output" to be more
consistent
2012-11-19 18:21:12 +01:00
FlorianLB
6b66edbcda RequestParam annotation create a parameter item 2012-11-14 23:59:06 +01:00
Baldur Rensch
cd45f4b146 Removed unused function 2012-11-13 08:04:04 -08:00
Baldur Rensch
742e53b99b Added status codes 2012-11-13 04:45:07 +00:00
Evan Villemez
504d5125f9 finished up, tests passing, fixed cs 2012-08-27 13:25:03 -04:00
Evan Villemez
2902ac3cbb working on apidoc return property 2012-08-27 12:56:19 -04:00
Evan Villemez
11efee0f65 tests passing 2012-07-24 16:14:11 -04:00
Evan Villemez
b9e8d61082 changed inputClass to input, refactored method and class names accordingly, fixed cs in several places 2012-07-23 15:44:37 -04:00
Evan Villemez
06e3a2256b added a ParserInterface, refactored how Parsers are registered in the ApiDocExtractor, changed formType to inputClass in ApiDocExtractor 2012-07-23 12:54:56 -04:00
William DURAND
cca97cf6af Refactoring
Move logic to extract data in the Extractor
Remove logic in the AbstractFormatter
Use ApiDoc class as data container
Update tests
Add test to prove the bug with FOSRestBundle annotations (\\d+ instead of \d+)
2012-07-20 01:32:16 +02:00
Jordi Boggiano
0868d39e9a Merge pull request #43 from willdurand/fix-13
Add support for FOSRest annotations. Fix #13
2012-07-18 03:29:41 -07:00
William DURAND
163d96a295 Add support for FOSRest annotations. Fix #13 2012-07-18 12:23:57 +02:00
Samuel Gordalina
2b02733ee9 Added ability to extract inline documentation from docblock 2012-07-13 13:44:11 +01:00
Christophe Coevoet
04b075736f Applied some php-cs-fixer magic 2012-05-23 00:42:59 +02:00