Version 0.98
[catagits/Catalyst-Action-REST.git] / lib / Catalyst / Action / DeserializeMultiPart.pm
index 8a882c3..9e37e57 100644 (file)
@@ -6,7 +6,7 @@ use namespace::autoclean;
 extends 'Catalyst::Action::Deserialize';
 use HTTP::Body;
 
-our $VERSION = '0.91';
+our $VERSION = '0.98';
 $VERSION = eval $VERSION;
 
 our $NO_HTTP_BODY_TYPES_INITIALIZATION;
@@ -32,7 +32,7 @@ __PACKAGE__->meta->make_immutable;
 
 =head1 NAME
 
-Catalyst::Action::DeserializeMultiPart - Deserialize Data in a Multi-Part Request
+Catalyst::Action::DeserializeMultiPart - Deserialize Data in a Multipart Request
 
 =head1 SYNOPSIS
 
@@ -46,7 +46,7 @@ Catalyst::Action::DeserializeMultiPart - Deserialize Data in a Multi-Part Reques
 
 =head1 DESCRIPTION
 
-This action will deserialize multi-part HTTP POST, PUT, OPTIONS and DELETE
+This action will deserialize multipart HTTP POST, PUT, OPTIONS and DELETE
 requests.  It is a simple extension of L<Catalyst::Action::Deserialize>
 with the exception that rather than using the entire request body (which
 may contain multiple sections), it will look for a single part in the request
@@ -77,7 +77,13 @@ the individual parts, L<HTTP::Body> must be told which content types
 to map to L<HTTP::Body::MultiPart>.  This module makes the assumption
 that you would like to have all C<multipart/mixed> requests parsed by
 L<HTTP::Body::MultiPart> module.  This is done by a package variable
-inside L<HTTP::Body>: C<$HTTP::Body::Types> (a HASH ref).  Feel free to
+inside L<HTTP::Body>: C<$HTTP::Body::Types> (a HASH ref).
+
+B<WARNING:> As this module modifies the behaviour of HTTP::Body globally,
+adding it to an application can have unintended consequences as multipart
+bodies will be parsed differently from before.
+
+Feel free to
 add other content-types to this hash if needed or if you would prefer
 that C<multipart/mixed> NOT be added to this hash, simply delete it
 after loading this module.