Document JSONAPI::Utils::Exceptions::InternalServerError

Author: tiagopog

lib/jsonapi/utils/exceptions/active_record.rb

@@ -27,7 +27,7 @@ def initialize(object, resource_klass, context)
           @formatted_key      = {}
         end
 
-        # Decorate errors from AR invalid objects.
+        # Decorate errors for AR invalid objects.
         #
         # @note That's the method used by formatters to build the response's error body.
         #

lib/jsonapi/utils/exceptions/internal_server_error.rb

@@ -2,10 +2,20 @@ module JSONAPI
   module Utils
     module Exceptions
       class InternalServerError < ::JSONAPI::Exceptions::Error
+        # HTTP status code
+        #
+        # @return [String]
+        #
+        # @api public
         def code
           '500'
         end
 
+        # Decorate errors for 500 responses.
+        #
+        # @return [Array]
+        #
+        # @api public
         def errors
           [JSONAPI::Error.new(
             code: code,