media_types-serialization 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 262dba633b56ee02980cb04a7e768198451963a71885c50bc35fafb4744c7ecd
-  data.tar.gz: 29f99b4a875081f23e4fd583e9adf0a99cf9250c597c5c5d553d4da224540416
+  metadata.gz: 7c72aa611b03ba3537f1c12eb44b31596f58d21ba3fe0dd5596b8d37d613d132
+  data.tar.gz: '084a4733e9d015fe1816399772d3fcfaed898368507d9785df89bdb296b34171'
 SHA512:
-  metadata.gz: 61f10719fe7b7741323b119ede580f0ac2c003c77f28201d62c9c43a0149b415193974df028539cb2f47286dcfdeace81749740c9a9a228037d888fd47d0a2e9
-  data.tar.gz: 85578dcb19c073cacdd78714c4976dd3ebb1b87438e5e5036b82a3623dc8477a1a3e8c8ab6ea55aa79d50e71ec659e8c69029f7e037519610f97126f2f5949c7
+  metadata.gz: 67d43c2377d4ac849997886fa547d9b6c22ee7880eca6e1acfebd73db3cbe18a189823ca79bec0a009ab2feb83aa6b7d2d4a7e50ac44e9e0f37207fe4c07bb87
+  data.tar.gz: 2d9825fca6e6d77f84609b691d5dcd113424b41adf971efe87fe7bcd56220dd34a6aaec6a7ce905474131ed398e5fed8decf11f4e2209752b3a9cfbfbd80933f

data/.github/workflows/ci.yml

@@ -5,7 +5,7 @@ on:
     branches:
       - master
   push:
-    branches: 
+    branches:
       - master
       - depfu/*
       - release/*
@@ -16,12 +16,16 @@ jobs:
 
     runs-on: ubuntu-latest
 
+    strategy:
+      matrix:
+        ruby-version: [2.7.x, 2.6.x]
+
     steps:
     - uses: actions/checkout@v1
-    - name: Set up Ruby 2.6
+    - name: Set up Ruby ${{ matrix.ruby-version }}
       uses: actions/setup-ruby@v1
       with:
-        ruby-version: 2.6.x
+        ruby-version: ${{ matrix.ruby-version }}
     - name: Build and test with Rake
       run: |
         gem install bundler

data/.prettierrc

@@ -0,0 +1 @@
+{}

data/CHANGELOG.md

@@ -1,19 +1,43 @@
 # Changelog
 
+## 1.2.0
+
+- ✨ Add `view:` to `output_html` which renders a specific rails view.
+
+## 1.1.0
+
+- ✨ Add _allow_output_html_: Fallback to rails rendering.
+- ✨ Add _allow_output_docs_: Useful to add a documentation description to endpoints that you can normally only POST to.
+- ✨ Add _output_error_: Implements missing content-language support.
+- ✨ Add _scoped freeze_io! support_: Useful for gradual adoption of mediatypes on existing routes.
+- ✨ Add _alias variant reporting_: Allows reporting what the original matched media type was even when impersonating a different media type.
+- ✨ Improve README: small improvements to make it easier to adopt and upgrade existing codebase.
+- ✨ Reduce number of (external) dependencies
+- 🐛 Fix incorrect output on encoding errors.
+- 🐛 Fix message in various alias error messages.
+
+## 1.0.3
+
+- 🐛 Unvalidated serializers would put the view part of the identifier before the version. This was not in line with validated serializers.
+
+## 1.0.2
+
+- 🐛 Explicitly set all oj parameters when decoding as well.
+
 ## 1.0.1
 
- - 🐛 Explicitly set all oj and json parameters to ensure correct behavior with changed defaults.
- - 🐛 Fix serializer not deserializing as symbols.
+- 🐛 Explicitly set all oj and json parameters to ensure correct behavior with changed defaults.
+- 🐛 Fix serializer not deserializing as symbols.
 
 ## 1.0.0
 
 - ✨ Add support for input deserialization.
-- ✨ Added serializer DSL to be more in line with validation gem.
-- ✨ Added ability to make a serializer without a validator.
-- ✨ Added error serializer that emits [`application/problem+json`](https://tools.ietf.org/html/rfc7231).
-- ✨ Reduced number of dependencies.
+- ✨ Add serializer DSL to be more in line with validation gem.
+- ✨ Add ability to make a serializer without a validator.
+- ✨ Add error serializer that emits [`application/problem+json`](https://tools.ietf.org/html/rfc7231).
+- ✨ Reduce number of dependencies.
 - ✨ Validators no longer need to be registered to be used.
-- ✨ Added a [wiki where errors can be documented](https://docs.delftsolutions.nl). Feel free to make pages for your own namespaced errors.
+- ✨ Add a [wiki where errors can be documented](https://docs.delftsolutions.nl). Feel free to make pages for your own namespaced errors.
 - 💔 Serializer definition API has backwards incompatible changes.
 - 💔 API viewer is now no longer registered as html but accessible with the `?api_viewer=last` query parameter.
 - 💔 Validators can no longer be registered for use in `format do`.

data/CODE_OF_CONDUCT.md

@@ -14,21 +14,21 @@ orientation.
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
   address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Our Responsibilities

data/Gemfile.lock

@@ -1,134 +1,128 @@
 PATH
   remote: .
   specs:
-    media_types-serialization (1.0.1)
+    media_types-serialization (1.1.0)
       actionpack (>= 4.0.0)
       activesupport (>= 4.0.0)
-      http_headers-accept (>= 0.2.2, < 1.0.0)
-      http_headers-link (< 1.0.0)
       media_types (>= 2.0.0, < 3.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.2.4.2)
-      actionpack (= 5.2.4.2)
+    actioncable (5.2.6)
+      actionpack (= 5.2.6)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailer (5.2.4.2)
-      actionpack (= 5.2.4.2)
-      actionview (= 5.2.4.2)
-      activejob (= 5.2.4.2)
+    actionmailer (5.2.6)
+      actionpack (= 5.2.6)
+      actionview (= 5.2.6)
+      activejob (= 5.2.6)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.2.4.2)
-      actionview (= 5.2.4.2)
-      activesupport (= 5.2.4.2)
+    actionpack (5.2.6)
+      actionview (= 5.2.6)
+      activesupport (= 5.2.6)
       rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.4.2)
-      activesupport (= 5.2.4.2)
+    actionview (5.2.6)
+      activesupport (= 5.2.6)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.2.4.2)
-      activesupport (= 5.2.4.2)
+    activejob (5.2.6)
+      activesupport (= 5.2.6)
       globalid (>= 0.3.6)
-    activemodel (5.2.4.2)
-      activesupport (= 5.2.4.2)
-    activerecord (5.2.4.2)
-      activemodel (= 5.2.4.2)
-      activesupport (= 5.2.4.2)
+    activemodel (5.2.6)
+      activesupport (= 5.2.6)
+    activerecord (5.2.6)
+      activemodel (= 5.2.6)
+      activesupport (= 5.2.6)
       arel (>= 9.0)
-    activestorage (5.2.4.2)
-      actionpack (= 5.2.4.2)
-      activerecord (= 5.2.4.2)
-      marcel (~> 0.3.1)
-    activesupport (5.2.4.2)
+    activestorage (5.2.6)
+      actionpack (= 5.2.6)
+      activerecord (= 5.2.6)
+      marcel (~> 1.0.0)
+    activesupport (5.2.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     arel (9.0.0)
-    awesome_print (1.8.0)
+    awesome_print (1.9.2)
     builder (3.2.4)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.9)
     crass (1.0.6)
-    erubi (1.9.0)
+    erubi (1.10.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
-    http_headers-accept (0.2.2)
-      http_headers-utils (>= 0.2.0, < 1.0.0)
-    http_headers-link (0.2.1)
-      http_headers-utils (>= 0.2.0, < 1.0.0)
-    http_headers-utils (0.2.0)
-    i18n (1.8.2)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    loofah (2.5.0)
+    loofah (2.10.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    marcel (0.3.3)
-      mimemagic (~> 0.3.2)
+    marcel (1.0.1)
     media_types (2.0.1)
     method_source (1.0.0)
-    mimemagic (0.3.4)
-    mini_mime (1.0.2)
-    mini_portile2 (2.4.0)
-    minitest (5.14.0)
-    nio4r (2.5.2)
-    nokogiri (1.10.9)
-      mini_portile2 (~> 2.4.0)
-    oj (3.10.6)
-    rack (2.2.2)
+    mini_mime (1.1.0)
+    minitest (5.14.4)
+    nio4r (2.5.7)
+    nokogiri (1.11.7-x64-mingw32)
+      racc (~> 1.4)
+    nokogiri (1.11.7-x86_64-linux)
+      racc (~> 1.4)
+    oj (3.12.1)
+    racc (1.5.2)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (5.2.4.2)
-      actioncable (= 5.2.4.2)
-      actionmailer (= 5.2.4.2)
-      actionpack (= 5.2.4.2)
-      actionview (= 5.2.4.2)
-      activejob (= 5.2.4.2)
-      activemodel (= 5.2.4.2)
-      activerecord (= 5.2.4.2)
-      activestorage (= 5.2.4.2)
-      activesupport (= 5.2.4.2)
+    rails (5.2.6)
+      actioncable (= 5.2.6)
+      actionmailer (= 5.2.6)
+      actionpack (= 5.2.6)
+      actionview (= 5.2.6)
+      activejob (= 5.2.6)
+      activemodel (= 5.2.6)
+      activerecord (= 5.2.6)
+      activestorage (= 5.2.6)
+      activesupport (= 5.2.6)
       bundler (>= 1.3.0)
-      railties (= 5.2.4.2)
+      railties (= 5.2.6)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (5.2.4.2)
-      actionpack (= 5.2.4.2)
-      activesupport (= 5.2.4.2)
+    railties (5.2.6)
+      actionpack (= 5.2.6)
+      activesupport (= 5.2.6)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.19.0, < 2.0)
-    rake (13.0.1)
-    sprockets (4.0.0)
+    rake (13.0.6)
+    sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.2.1)
+    sprockets-rails (3.2.2)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    thor (1.0.1)
+    thor (1.1.0)
     thread_safe (0.3.6)
-    tzinfo (1.2.7)
+    tzinfo (1.2.9)
       thread_safe (~> 0.1)
-    websocket-driver (0.7.1)
+    websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.4)
+    websocket-extensions (0.1.5)
 
 PLATFORMS
-  ruby
+  x64-mingw32
+  x86_64-linux
 
 DEPENDENCIES
   awesome_print
@@ -140,4 +134,4 @@ DEPENDENCIES
   rake (~> 13.0)
 
 BUNDLED WITH
-   1.17.3
+   2.2.7

data/README.md

@@ -4,7 +4,7 @@
 [![Gem Version](https://badge.fury.io/rb/media_types-serialization.svg)](https://badge.fury.io/rb/media_types-serialization)
 [![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)
 
-`respond_to` on steroids. Add versioned serialization and deserialization to your rails projects.
+`respond_to` on steroids. Add [HATEOAS](https://docs.delftsolutions.nl/wiki/HATEOAS_API) compatible serialization and deserialization to your Rails projects.
 
 ## Installation
 
@@ -57,6 +57,60 @@ BookSerializer.serialize(book, 'vnd.acme.book.v1+json', context: nil)
 # => { "book": { "title": "Everything, abridged" } }
 ```
 
+### Controller integration
+
+You can integrate the serialization system in rails, giving you automatic [Content-Type negotiation](https://en.wikipedia.org/wiki/Content_negotiation) using the `Accept` header:
+
+```ruby
+require 'media_types/serialization'
+
+class BookController < ActionController::API
+  include MediaTypes::Serialization
+
+  allow_output_serializer(BookSerializer, only: %i[show])
+  freeze_io!
+
+  def show
+    book = Book.new
+    book.title = 'Everything, abridged'
+
+    render_media book
+  end
+end
+```
+
+While using the controller integration the context will always be set to the current controller. This allows you to construct urls.
+
+### Adding HATEOAS responses to existing routes
+
+When creating a mobile application it's often useful to allow the app to request a non-html representation of a specific url. If you have an existing route:
+
+```ruby
+class BookController < ApplicationController
+  def show
+    @book = Book.new
+
+    # Use view corresponding to the controller
+  end
+end
+```
+
+You can add a json representation as follows:
+
+```ruby
+class BookController < ApplicationController
+  allow_output_serializer(BookSerializer, only: %i[show])
+  allow_output_html
+  freeze_io!
+
+  def show
+    @book = Book.new
+
+    render_media @book
+  end
+end
+```
+
 ### Validations
 
 Right now the serializer does not validate incoming or outgoing information. This can cause issues when you accidentally emit non-conforming data that people start to depend on. To make sure you don't do that you can specify a [Media Type validator](https://github.com/SleeplessByte/media-types-ruby):
@@ -98,30 +152,6 @@ end
 
 For more information, see the [Media Types docs](https://github.com/SleeplessByte/media-types-ruby).
 
-### Controller integration
-
-You can integrate the serialization system in rails, giving you automatic [Content-Type negotiation](https://en.wikipedia.org/wiki/Content_negotiation) using the `Accept` header:
-
-```ruby
-require 'media_types/serialization'
-
-class BookController < ActionController::API
-  include MediaTypes::Serialization
-
-  allow_output_serializer(BookSerializer, only: %i[show])
-  freeze_io!
-      
-  def show 
-    book = Book.new
-    book.title = 'Everything, abridged'
-
-    render_media book
-  end
-end
-```
-
-While using the controller integration the context will always be set to the current controller. This allows you to construct urls.
-
 ### Versioning
 
 To help with supporting older versions, serializers have a [DSL](https://en.wikipedia.org/wiki/Domain-specific_language) to construct json objects:
@@ -149,7 +179,7 @@ BookSerializer.serialize(book, BookValidator.version(2), context: nil)
 
 ### Links
 
-When making [HATEOAS](https://en.wikipedia.org/wiki/HATEOAS) compliant applications it's very useful to include `Link` headers in your response so clients can use a `HEAD` request instead of having to fetch the entire resource. Serializers have convenience methods to help with this:
+When making [HATEOAS](https://docs.delftsolutions.nl/wiki/HATEOAS_API) compliant applications it's very useful to include `Link` headers in your response so clients can use a `HEAD` request instead of having to fetch the entire resource. Serializers have convenience methods to help with this:
 
 ```ruby
 class BookSerializer < MediaTypes::Serialization::Base
@@ -206,7 +236,7 @@ class BookSerializer < MediaTypes::Serialization::Base
   output view: :index, version: 3 do |arr, version, context|
     attribute :books do
       link :self, href: context.book_index_url
-      
+
       index arr, version: version
     end
   end
@@ -248,15 +278,15 @@ class BookSerializer < MediaTypes::Serialization::Base
   output view: :index, version: 3 do |arr, version, context|
     attribute :books do
       link :self, href: context.book_index_url
-      
+
       index arr, version: version
     end
   end
-  
+
   output view: :collection, version: 3 do |arr, version, context|
     attribute :books do
       link :self, href: context.book_collection_url
-      
+
       collection arr, version: version
     end
   end
@@ -309,8 +339,8 @@ class BookController < ActionController::API
   allow_output_serializer(BookSerializer, only: %i[show])
   allow_input_serializer(BookSerializer, only: %i[create])
   freeze_io!
-      
-  def show 
+
+  def show
     book = Book.new
     book.title = 'Everything, abridged'
 
@@ -318,7 +348,7 @@ class BookController < ActionController::API
   end
 
   def create
-    json = deserialize(request, context: self) # does validation for us
+    json = deserialize(request) # does validation for us
     puts json
   end
 end
@@ -355,8 +385,8 @@ class BookController < ActionController::API
   allow_output_serializer(BookSerializer, only: %i[show])
   allow_input_serializer(BookSerializer, only: %i[create])
   freeze_io!
-      
-  def show 
+
+  def show
     book = Book.new
     book.title = 'Everything, abridged'
 
@@ -364,7 +394,7 @@ class BookController < ActionController::API
   end
 
   def create
-    book = deserialize(request, context: self)
+    book = deserialize(request)
     book.save!
 
     render media: serialize_media(book), content_type request.format.to_s
@@ -385,7 +415,7 @@ class BookSerializer < MediaTypes::Serialization::Base
   output_raw view: :raw, version: 3 do |obj, version, context|
     hidden do
       # Make sure links are only set in the headers, not in the body.
-      
+
       link :self, href: context.book_url(obj)
     end
 
@@ -454,14 +484,12 @@ class BookController < ActionController::API
   include MediaTypes::Serialization
 
   allow_api_viewer
-  
-  allow_output_serializer(MediaTypes::ApiViewer)
 
   allow_output_serializer(BookSerializer, only: %i[show])
   allow_input_serializer(BookSerializer, only: %i[create])
   freeze_io!
-      
-  def show 
+
+  def show
     book = Book.new
     book.title = 'Everything, abridged'
 
@@ -469,7 +497,7 @@ class BookController < ActionController::API
   end
 
   def create
-    json = deserialize(request, context: self) # does validation for us
+    json = deserialize(request) # does validation for us
     puts json
   end
 end
@@ -489,14 +517,14 @@ class BookSerializer < MediaTypes::Serialization::Base
       attribute :description, obj.description if version >= 2
     end
   end
-  
+
   output_raw view: :html do |obj, context|
     render_view 'book/show', context: context, assigns: {
       title: obj.title,
       description: obj.description
     }
   end
-  
+
   output_alias 'text/html', view: :html
 end
 ```
@@ -518,11 +546,11 @@ class BookController < ActionController::API
 
   freeze_io!
 
-  # ...   
+  # ...
 end
 ```
 
-The exception you specified will be rescued by the controller and will be displayed to the user along with a link to the shared wiki page for that error type. Feel free to add instructions there on how clients should solve this problem. You can find more information at: http://docs.delftsolutions.nl/wiki/Error
+The exception you specified will be rescued by the controller and will be displayed to the user along with a link to the shared wiki page for that error type. Feel free to add instructions there on how clients should solve this problem. You can find more information at: [https://docs.delftsolutions.nl/wiki/Error](https://docs.delftsolutions.nl/wiki/Error)
 If you want to override this url you can use the `p.url(href)` function.
 
 By default the `message` property of the error is used to fill the `details` field. You can override this by using the `p.override_details(description, lang:)` function.
@@ -531,9 +559,7 @@ Custom attributes can be added using the `p.attribute(name, value)` function.
 
 ### Related
 
-- [`MediaTypes`](https://github.com/SleeplessByte/media-types-ruby): :gem: Library to create media type definitions, schemes and validations
-- [`MediaTypes::Deserialization`](https://github.com/XPBytes/media_types-deserialization): :cyclone: Add media types supported deserialization using your favourite parser, and media type validation.
-- [`MediaTypes::Validation`](https://github.com/XPBytes/media_types-validation): :heavy_exclamation_mark: Response validations according to a media-type
+- [`MediaTypes`](https://github.com/SleeplessByte/media-types-ruby): :gem: Library to create media type validators.
 
 ## API
 
@@ -565,14 +591,18 @@ The block should return an object to convert into JSON.
 
 This has the same behavior as `output` but should return a string instead of an object. Output is not validated.
 
-#### `output_alias( media_type_identifier, view: )`
+#### `output_alias( media_type_identifier, view:, hide_variant: false )`
+
+Defines a legacy mapping. This will make the deserializer parse the media type `media_type_identifier` as if it was version `nil` of the specified view. If view is undefined it will use the output serializer without a view defined.
 
-Defines a legacy mapping. This will make the deserializer parse the media type `media_type_identifier` as if it was version 1 of the specified view. If view is undefined it will use the output serializer without a view defined.
+Response will have a content type equal to `[media_type_identifier]; variant=[mapped_media_type_identifier]`. If `hide_variant:` is true, the content type emitted will only be `[media_type_identifier]`.
 
-#### `output_alias_optional( media_type_identifier, view: )`
+#### `output_alias_optional( media_type_identifier, view:, hide_variant: false )`
 
 Has the same behavior as `output_alias` but can be used by multiple serializers. The serializer that is loaded last in the controller 'wins' control over this media type identifier. If any of the serializers have an `output_alias` defined with the same media type identifier that one will win instead.
 
+Response will have a content type equal to `[media_type_identifier]; variant=[mapped_media_type_identifier]`. If `hide_variant:` is true, the content type emitted will only be `[media_type_identifier]`.
+
 #### `input( view:, version:, versions: ) do |obj, version, context|`
 
 Defines a deserialization block. Either version or versions can be set. View should be a symbol or unset.
@@ -658,6 +688,20 @@ Configure the controller to allow the client to request responses emitted by the
 
 Accepts the same filters as `before_action`.
 
+#### `allow_output_html( as: nil, view: nil, layout: nil, **filters )`
+
+Allows falling back to the default Rails view rendering when the client asks for the media type in the `as:` parameter or `text/html` if `as:` is unset.
+
+The `Content-Type` of the response will be `text/html` if the `as:` parameter is unset. If the `as:` parameter is set, it will include it in the variant parameter: `text/html; variant=application/vnd.xpbytes.borderless`.
+
+Accepts the same filters as `before_action`. You can set the template to use using the `view:` parameter.
+
+#### `allow_output_docs( description, **filters )`
+
+Outputs the specified description as help information.
+
+Accepts the same filters as `before_action`.
+
 #### `allow_input_serializer( serializer, views: nil, **filters )`
 
 Configure the controller to allow the client to send bodies with a `Content-Type` that can be deserialized using the specified serializer. Optionally allows you to specify which views to allow by passing an array in the views parameter.
@@ -692,7 +736,7 @@ Clears the list of serializers used to render the error when the client supplies
 
 Enables rendering the api viewer when adding the `api_viewer=last` query parameter to the url.
 
-#### `freeze_io!`
+#### `freeze_io!(**filter_opts)`
 
 Registers serialization and deserialization in the controller. This function must be called before using the controller.
 
@@ -742,6 +786,7 @@ Does the same as `deserialize( request )` but gives the client an error page if
 Returns the serializer class that will handle the given request.
 
 ## Customization
+
 The easiest way to customize the look and feel of the built in pages is to provide your own logo and background in an initializer:
 
 ```ruby