2.7.0 (2014-07-30)

What's New?

This release contains numerous fixes and improvements as well as new shiny features.

The sandbox now supports different authentication schemes such as http + basic or bearer. The http_basic delivery has been kept for BC purpose but will be remove at some point. You should rather use the new type parameter:

# app/config/config.yml
nelmio_api_doc:
    sandbox:
        authentication:             # default is `~` (`null`), if set, the sandbox automatically
                                    # send authenticated requests using the configured `delivery`

            name: access_token      # access token name or query parameter name or header name

            delivery: http          # `query`, `http`, and `header` are supported

            # Required if http delivery is selected.
            type:     basic         # `basic`, `bearer` are supported

The sandbox now displays better input HTML elements depending on the type of each field. It is also possible to disable the "body formats" select box and links to the Symfony web profiler have been added.

For more information, please read the changelog below.

Changelog

• Added: new authentication configuration
• Added: parse JSM\Inline (#372)
• Added: if a description is not provided use form label
• Added: workaround for Firefox not sending LINK in uppercase what then is denied by nginx. More info: http://stackoverflow.com/questions/9645037/nginx-rejects-custom-http-methods-if-not-all-upper-case
• Added: default parameters in {JmsMetadata,Validator}Parser, and FOSRestHandler
• Added: unified data types [actualType and subType]
• Added: default values support for form types
• Added: support to properly handle file upload POST
• Added: support for different parameter types
• Added: file type to FormTypeParser
• Added: support for nullable option in RequestParam
• Added: configuration option to disable body formats
• Added: PostParserInterface to JmsMetadataParser to get ValidatorParser found children parsed
• Added: show web profiler link in sandbox
• Fixed: toggle click event
• Fixed: embedded collection of custom FormType Error
• Fixed: css for tags output
• Fixed: don't parse custom properties as classes
• Fixed: doubled parameters
• Fixed: in FormTypeParser, FormType constructor should be called when possible
• Fixed: missing array key checks
• Fixed: small bug introduced when adding 'new parameter'
• Fixed: wrong HTML structure a>div
• Fixed: wrong HTML structure ul>li
• Fixed: remove duplicate HTML ID
• Fixed: wrong HTML tag
• Updated: documentation, config reference

2.6.0 (2014-06-25)

What's New?

• The @ApiDoc annotation gets a new property named tags, which allow to tag a method (e.g. beta or in-development). You can configure either a single tag or an array of tags.
• Under the request_format configuration node, there is a new available node named request_formats, allowing you to register custom mime types for XML and JSON formats:

# app/config/config.yml
nelmio_api_doc:
    sandbox:
        request_format:
            formats:                            # default `json` and `xml`,
                json: application/json          # override to add custom formats or disable
                xml: application/xml            # default formats

Changelog

• Added: implement Tags for functions
• Added: request formats configuration
• Fixed: retrieval of the validation MetadataFactory
• Fixed: simplified the Travis configuration
• Fixed: pressing enter in the sandbox mode will now lead to submit the form
• Fixed: broken documentation with Validator Constraints in FOSRestBundle requirements (#357)
• Minor improvements (documentation, tests)

2.5.2 (2014-05-16)

• Fixed: only show sandbox config if enabled
• Fixed: ValidatorParser in Symfony 2.5
• Fixed: parse of input forms with options required
• Fixed: Form Parser improvements for date, datetime & choice form types (format & types)

2.5.1 (2014-03-12)

• Fixed: sandbox should not be disabled in https whenever a method is not marked as https explictly
• Fixed: modified RequestListenerTest so it does not use the Crawler, that currently does not work with HHVM
• Fixed: replace deprecated fork of dflydev's mardown library with the original one provided by Michel Fortin

Also, the bundle is now tested against PHP 5.6 and HHVM on Travis-CI.

2.5.0 (2014-02-11)

• Added: exclude_envs to ApiDoc annotation to exclude the documentation from the specified environments
• Fixed: fix https option
• Fixed: null host value in layout.html.twig
• Fixed: null secure value in method.html.twig
• Fixed: don't try to call class with custom handlers
• Fixed: typo in index.md documentation
• Fixed: HTTPS detection

2.4.0 (2013-11-14)

• Added: not blank format validation
• Added: CONTRIBUTING file
• Added: support "callback" on Choice Validator
• Added: support for embedded forms
• Added: option to set requirements and parameters directly from ApiDoc annotation
• Added: showing default values in sandbox
• Added: XML namespace and XSD
• Added: support for host in sandbox
• Changed: Composer minimum stability is not 'dev' anymore
• Changed: Move doc to its own folder
• Changed: move LICENSE to meta folder
• Changed: Requirements fields: requirement, dataType and description can be optional
• Changed: make form and validation extractors optional
• Fixed: tests + travis-ci config
• Fixed: set format according to Date, DateTime and Time annotations
• Fixed: incompatibility with Symfony2 2.1
• Fixed: keep order of loaders, fixes #265 build
• Fixed: issue #259