RetailCRM-Mirror/NelmioApiDocBundle
1
0
Fork 0
mirror of https://github.com/retailcrm/NelmioApiDocBundle.git synced 2025-02-02 15:51:48 +03:00
Code Issues Projects Releases Wiki Activity
1,033 Commits 9 Branches 28 Tags
Commit Graph

91 Commits

Author SHA1 Message Date
Alan Poulain
b9718f3400 Compatibility with Symfony 4.3 (#1524) 
* Use twig instead of templating

* Fix at least one suite test in Travis

* Use Twig namespace (Twig > 1.10 and TwigBundle > 2.2)
 2022-04-26 16:58:48 +03:00
Soltész Balázs
e2c3d7ce94
Make filters always be passed as query string parameters in sandbox requests. 2017-04-28 12:36:27 +02:00
Invis1ble
97c6b1e857 Fixed placeholder translations #889 2016-07-29 09:20:35 +03:00
mellzamora
f5e38a283a Fix error: 
Key "statusCodes" for array with keys "method, uri, description, documentation, filters, requirements, parsedResponseMap, https, authentication, authenticationRoles, deprecated, id" does not exist in NelmioApiDocBundle::method.html.twig at line 182.

Sample:

 /**
     * Retrieves the list of categories (paginated) based on criteria.
     *
     * @ApiDoc(
     *  resource=true,
     *  output={"class"="Sonata\DatagridBundle\Pager\PagerInterface", "groups"={"sonata_api_read"}}
     * )
     *
     *
     * @QueryParam(name="page", requirements="\d+", default="1", description="Page for category list pagination")
     * @QueryParam(name="count", requirements="\d+", default="10", description="Number of categories by page")
     * @QueryParam(name="enabled", requirements="0|1", nullable=true, strict=true, description="Enabled/Disabled categories filter")
     * @QueryParam(name="context", requirements="\S+", nullable=true, strict=true, description="Context of categories")
     *
     * @View(serializerGroups="sonata_api_read", serializerEnableMaxDepthChecks=true)
     *
     * @param ParamFetcherInterface $paramFetcher
     *
     * @return PagerInterface
     */
 2016-06-16 22:44:56 +08:00
Piotr Plenik
12c067154c fix format wrapping 2016-06-02 10:33:39 +02:00
miholeus
e141ffd291 added headers support 2016-05-19 14:28:32 +03:00
William Durand
b494d8e1ab Merge pull request #821 from tcz/sandbox_output_improvements 
Adding request body and curl command to sandbox
 2016-05-11 17:32:04 +02:00
William Durand
4660805291 Merge pull request #823 from ImmRanneft/master 
Little template fixes for sandbox
 2016-05-11 17:15:43 +02:00
William Durand
2d214fc934 Merge pull request #775 from DonPrus/master 
Fix problem with cyrillic chars in docs
 2016-04-21 17:38:04 +02:00
Tim Hovius
96cfab973c Added translation to description 
The labels of a field are usually always translated. But this does not happen in the documentation.
 2016-04-19 21:37:22 +02:00
ImmortaL
df10a4769c Little template fixes for sandbox 2016-03-18 21:23:22 +03:00
tcz
aef6a89329 Adding request body and curl command to sandbox 2016-03-17 16:09:47 +01:00
William Durand
cec5108133 Merge pull request #781 from AlmogBaku/feature/textareaField 
Add textarea type for sandbox
 2016-02-24 17:50:13 +01:00
Adam Prager
7919b24971 Use the response map in the html view 2016-01-26 04:36:38 +01:00
AlmogBaku
3bc98723fe Add textarea type for sandbox 2016-01-08 20:34:15 +02:00
Сомов Игорь Андреевич
8aa5e479d1 JSON UNICODE 2015-12-28 17:07:20 +03:00
William Durand
a0c0398ca9 Merge pull request #540 from rodrigorigotti/master 
Showing 'Documentation' tab makes no sense if the sandbox is disabled.
 2015-05-16 12:59:29 +02:00
William Durand
0a1cef77ad
cs 2015-03-06 11:19:08 +01:00
Rodrigo Rigotti
fa4b8f3805 Showing 'Documentation' tab makes no sense if the sandbox is disabled. 2014-11-05 10:32:48 -02:00
Jeremy Perret
e7d3c803bb Display select to choose http method in sandbox 2014-10-26 12:28:50 +01:00
thenetexperts
e1c7e8a5bd adding optional color codes for tags annotation 2014-08-25 11:27:49 +02:00
William Durand
c6741d5710 Merge pull request #369 from emmanuelballery/fixes_for_ff36 
Fixes HTML structures for FF36 (and maybe other old browsers)
 2014-06-27 10:24:27 +02:00
Jonathan Chan
ba5e2d1454 Fixed small bug introduced when adding 'new parameter' 2014-06-25 13:29:59 -04:00
William Durand
ea2201762d Merge pull request #345 from AlexeyKupershtokh/web-profiler 
Symfony web profiler integration
 2014-06-25 10:56:43 +02:00
Jonathan Chan
1cd77e2f14 added support to properly handle file upload POST 2014-06-25 10:25:45 +02:00
Jonathan Chan
210596eae9 adding support for different parameter types 2014-06-25 10:25:45 +02:00
Sandro Meier
dfd094371d Implement Tags for functions. 2014-05-27 13:33:50 +02:00
Marco Jantke
d7c70720b0 Pressing enter in the sandbox mode will now lead to submit the form. 2014-05-23 15:30:21 +02:00
Emmanuel BALLERY
0a42d1773c Fix wrong HTML structure a>div 2014-04-24 23:02:56 +02:00
Emmanuel BALLERY
c78466bbb9 Fix wrong HTML tag 2014-04-24 22:58:34 +02:00
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
Alexey Kupershtokh
11f163d589 Show web profiler link in sandbox 2014-03-11 07:07:35 +07:00
Loick Piera
414e87b58b Fix null secure value in method.html.twig 2014-02-06 15:06:43 +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
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
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
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
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
Vincent CHALAMON
a1517543e8 Enable PHPDoc @link feature 2013-08-16 19:18:05 +02: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
Pierre-Yves LEBECQ
13efea8975 Added support for the jms version annotations in formatters 2013-05-12 14:54:01 +02:00
marapper
fd860b43cd Icons as data URI 2013-05-07 22:52:18 +04: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
53b2537aef Add cache annotation extractor 2013-03-26 11:49:12 +01:00