nelmio/api-doc-bundle 2.7.0

2.7.0 (2014-07-30)

on PHP Packagist

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