178 Commits

Author SHA1 Message Date
Toni Van de Voorde
04c03e3e06 Sandbox should not be disabled in https whenever a method is not marked as
https explictly
2014-03-11 10:24:56 +01:00
William Durand
5bd455f955 Merge pull request #333 from richardfullmer/https
Fix and properly document the https option
2014-02-07 01:05:59 +01:00
Richard Fullmer
dc8494bbdf Fix an properly document https option 2014-02-06 09:27:30 -08:00
Loick Piera
b198e240ce Fix null host value in layout.html.twig 2014-02-06 15:12:26 +01:00
Loick Piera
414e87b58b Fix null secure value in method.html.twig 2014-02-06 15:06:43 +01:00
Ninir
4a9e99bddd Fixed typo in index.md documentation 2014-01-21 10:41:55 +01:00
jdeveloper
dea78901a0 Added exclude_envs to ApiDoc annotation to exclude the documentation from the specified environments 2014-01-20 13:24:41 +01:00
Max Romanovsky
dc4b4066a7 Misspelled authentication config parameter in docs 2014-01-13 14:53:28 +03:00
William DURAND
5e1bf1fbda [doc] fix sandbox doc 2014-01-10 11:29:52 +01:00
William DURAND
eca2eb6d80 Improve documentation (authentication/sandbox) 2014-01-10 11:20:22 +01:00
Simon Schick
912178dc88 Hide “_scheme” in the list of requirements per URL
+ disable sandbox if the scheme of the URL doesn’t match the scheme, the
documentation is opened in
2013-12-28 18:52:32 +01:00
William DURAND
627130637d Merge PR #288 from piotrantosik/feature/selectparsers 2013-12-28 18:42:51 +01:00
Piotr Antosik
3fdbfbed1c select used parsers 2013-12-28 18:41:59 +01:00
William Durand
cb8b0c6f90 Merge pull request #294 from marcj/outsource-classic-phpdoc
Outsourced the parsing of the classic phpDoc into a extra handler.
2013-12-10 16:58:18 -08:00
Marc J. Schmidt
ead8174192 Outsourced the parsing of the classic phpDoc into a extra handler.
This makes it possible to overwrite route-requirements/description through a own handler.
Otherwise it's impossible e.g. to overwrite a `@param string $page` annotation via a own handler.
2013-12-11 01:40:16 +01:00
Marc J. Schmidt
d7ef725613 Suppressed the auto-scrolling on click and fixed initial-jump issues.
For the initial auto-scrolling to the selected route in location.hash:
 - Fixed typo in the calculation of the offset-top position.
 - Fixed requesting the selected route that has special chars (e.g. "/content/{page}")
 - Fixed for refreshes with F5. It needs a setTimeout workaround to get that working in Webkit.
    It needs also in Firefox a other dom element to fire scrollTop at.

Fixed also some old .delegation calls, which are deprecated in jQuery 1.7.

Why suppressing auto-scrolling on click:
When clicking through all methods it's very annoying when the browser always jumps to the clicked method,
especially when you go through all methods from bottom to up. This jump is unexpected and disturbing.
2013-12-10 03:35:06 +01:00
William DURAND
3166640c5a Rework documentation, add reference config 2013-12-05 17:10:38 +01:00
William DURAND
e9439de94e Move doc to its own folder 2013-11-14 11:43:09 +01:00
William DURAND
e7b7c87113 Update README, move LICENSE to meta folder 2013-11-14 11:39:29 +01: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
f91a0868a8 Merge pull request #247 from domnikl/xsd
add XML namespace and XSD
2013-11-14 01:51:01 -08:00
William Durand
7ac9c1c1b6 Merge pull request #251 from Peekmo/patch-1
Showing default values in sandbox
2013-11-14 01:50:29 -08:00
William Durand
8e41122ca7 Merge pull request #268 from konradpodgorski/feature/optionalRequirementsFields
Optional requirements fields: requirement, dataType and description
2013-11-14 01:41:14 -08:00
Adrien SAMSON
f71ba12d48 Add support for host in sandbox 2013-11-13 17:04:49 +01:00
Konrad Podgórski
4a831c3a20 Requirements fields: requirement, dataType and description can be optional 2013-10-30 16:38:32 +01:00
Tobias Schultze
09e82fa6d3 make form and validation extractors optional 2013-10-28 19:12:43 +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
Axel Anceau
ebbbebfab6 Showing default values in sandbox
When a parameter "default" is set for a filter, or a parameter, the field will be fill with this value.
2013-10-03 14:17:48 +02:00
Dominik Liebler
7ba7ea4036 changed XSD elements to attributes 2013-09-23 13:46:32 +02:00
Dominik Liebler
7f8a4d4b59 added XML namespace and XSD 2013-09-21 23:35:53 +02:00
Kevin Saliou
23bc2b6f47 make api method headers anchor links so a speicif method can be refered to through its unique id 2013-09-06 13:42:19 +02:00
Cory
912906578a Fixing border to not be applied to children 2013-08-29 12:00:18 -04:00
Vincent CHALAMON
a1517543e8 Enable PHPDoc @link feature 2013-08-16 19:18:05 +02:00
William Durand
96b40b8a8c Merge pull request #210 from jhallbachner/validation2
Added Support for Validation Component (refactored)
2013-08-13 03:28:09 -07:00
Jordi Boggiano
475ecf349b Speed up toggling 2013-08-07 12:56:32 +02:00
Jordi Boggiano
d9607477ba Merge pull request #219 from jsampedro77/header-auth
Adds custom header Authentication method
2013-07-31 03:28:43 -07:00
Hugo Briand
c90bd7cce4 Increased input field width for sandbox forms to improve readability with long keys 2013-07-31 10:38:09 +02:00
jsampedro
7f2cff2ac5 Adds custom header Authentication method 2013-07-19 10:05:57 +02:00
lioshi
112f027b20 Add missed border-top pane for Sandbox form 2013-07-12 10:23:13 +02:00
Josh Hall-Bachner
5e1549a29d Built parse-merging into the ApiDocExtractor.
Wired up a "post-parse" pass to allow recursive parsing across multiple parsers.
2013-06-30 23:46:41 -07:00
Josh Hall-Bachner
0913157399 Added the initial structure for a Symfony Validation handler that is injected into the parsers. 2013-06-30 23:46:41 -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
François Terrier
9236e9471d using a simpler version 2013-06-20 15:05:02 +02:00
François Terrier
b4bb454518 html encode the url when it is written to the page 2013-06-20 14:29:58 +02:00
William Durand
01044bb7ac Merge pull request #198 from jhallbachner/json
Add BodyFormat Selector and Support Json-Encoded Api Requests In Sandbox
2013-06-18 06:46:45 -07:00
William Durand
0eb7ec27ec Merge pull request #152 from adriensamson/issue-147
Fix Illegal offset warning in FormTypeParser (closes #147)
2013-06-18 06:44:06 -07:00
Josh Hall-Bachner
c5beab777f Fixed parameter encoding for GET requests. 2013-06-14 16:15:43 -07:00
Lukas Kahwe Smith
bcecc03139 add missing link to the api doc overview 2013-06-13 12:05:01 +02:00
Josh Hall-Bachner
6ba548e21e Removed stray console.log 2013-06-05 19:20:12 -07:00
Josh Hall-Bachner
c237d65bad Added a helper method to enable deep encoding of nested parameters when encoding requests into JSON. 2013-06-05 18:51:01 -07:00