sober_swag 0.21.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9dce6daadaff9f7ddb1530ecf5fa69693454a29f04da849eec9bea8969166bc
-  data.tar.gz: a6cd16e93640b2d9c27fab081c3551d8498643044a6ebf9cab8100b51d8d916d
+  metadata.gz: da1c1c2df36ccecf700e4d3ecf104c1324f9fa35b4588b4a040238f2513bf4b8
+  data.tar.gz: 3d22562035e1d8e93b11876fc82f6a23b1d26e95952d988423559d555adf680a
 SHA512:
-  metadata.gz: fb2dcb7bee3b89e643b3e5d2d1e3d5b7034161ae563de59909120a3f4c817a8f14ab88d5d1968efb2b914b068cf0370d41f9094bbec7ae8ef96a87dfe3ad64fd
-  data.tar.gz: bfc9bfe3b4e93dca2a774e416496d430dfa63185acc82db780cc4f26d7eec1ff2a6db0f10103fd962243ab46b9799b8e6536dd94cc07758b5f52ea07af71df67
+  metadata.gz: 3a486a7b09b631d567f509c94b3b161350de61971f148ba24f707e117fa6915e6d7be99c6782ff07662da44edc3edb56ebb1691ac0fe8e819fc138dca4513ac9
+  data.tar.gz: e4447e3a951d0867c76a6bbd30a49da136d9406d00dfe0c5e0632574746a59fa72b936eb736c573de33bfe01e1d36d36771561fed7b9a6b00be43dcaa0c82653

data/.rubocop.yml

@@ -7,6 +7,7 @@ AllCops:
     - 'bin/bundle'
     - 'example/bin/bundle'
     - 'vendor/bundle/**/*'
+    - 'bin/console'
 
 Layout/LineLength:
   Max: 160

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## [v0.22.0] 2021-12-21
+
+- Added `SoberSwag::Reporting`, which is basically a v2 of the gem!
+  Docs for this can be found in [docs/reporting.md].
+
 ## [v0.21.0] 2021-09-02
 
 - Added a new method of serializing views based on hash lookups, improving performance

data/bin/console

@@ -9,11 +9,6 @@ Bio = SoberSwag.input_object do
   attribute :gender, SoberSwag::Types::String.enum('male', 'female') | SoberSwag::Types::String
 end
 
-Person = SoberSwag.input_object do
-  attribute :name, SoberSwag::Types::String
-  attribute? :bio, Bio.optional
-end
-
 MultiFloorLocation = SoberSwag.input_object do
   attribute :building, SoberSwag::Types::String.enum('science', 'mathematics', 'literature')
   attribute :floor, SoberSwag::Types::String
@@ -25,12 +20,37 @@ SingleFloorLocation = SoberSwag.input_object do
   attribute :room, SoberSwag::Types::Integer
 end
 
-SchoolClass = SoberSwag.input_object do
-  attribute :prof, Person.meta(description: 'The person who teaches this class.')
-  attribute :students, SoberSwag::Types::Array.of(Person)
-  attribute :location, (SingleFloorLocation | MultiFloorLocation).meta(description: 'What building and room this is in')
+SortDirections = SoberSwag::Types::CommaArray.of(SoberSwag::Types::String.enum('created_at', 'updated_at', '-created_at', '-updated_at'))
+
+# test
+class Whatever < SoberSwag::Reporting::Input::Struct
+  attribute :first_name, SoberSwag::Reporting::Input::Text.new
+  attribute :last_name, SoberSwag::Reporting::Input::Text.new
+  attribute? :father, SoberSwag::Reporting::Input::Null.new | SoberSwag::Reporting::Input::Defer.new(proc { Whatever }), description: 'if the father is in our db, will be present'
+  attribute? :mother, SoberSwag::Reporting::Input::Null.new | SoberSwag::Reporting::Input::Defer.new(proc { Whatever }), description: 'if the mother is in our db, will be present'
 end
 
-SortDirections = SoberSwag::Types::CommaArray.of(SoberSwag::Types::String.enum('created_at', 'updated_at', '-created_at', '-updated_at'))
+# Kinda neat thing
+class Otherwised < Whatever
+  attribute :ident, SoberSwag::Reporting::Input::Text.new.with_pattern(/^[A-Za-z0-9]+$/)
+end
+
+ArrayOfPeople = Otherwised.or(Whatever).list
+
+##
+# Output for a person
+class OutputPerson < SoberSwag::Reporting::Output::Struct
+  field :first_name, SoberSwag::Reporting::Output::Text.new
+  field :last_name, SoberSwag::Reporting::Output::Text.new
+  define_view :detail do
+    field :initials, SoberSwag::Reporting::Output::Text.new do |obj|
+      [obj.first_name, obj.last_name].map { |e| e[0..0] }.map { |e| "#{e}." }.join(' ')
+    end
+  end
+end
+
+Person = Struct.new(:first_name, :last_name)
+
+OutputPerson.view(:base)
 
 Pry.start

data/docs/reporting.md

@@ -0,0 +1,190 @@
+# SoberSwag Reporting
+
+`SoberSwag::Reporting` is a new module that provides a more *composable* interface of sober swag types.
+Unlike the base version, it is *not* based on `dry-types`, instead using a simpler scheme.
+It also allows for modeling of more complex type domains, and more reusable types.
+
+The module is called `SoberSwag::Reporting` because it *reports* what happened on failure.
+Consider trying to parse a struct with a first and last name, both of which need to be non-empty strings.
+If I give it this input:
+
+```json
+{
+  "first_name": 10,
+  "last_name": ""
+}
+```
+
+I will get back a report, which can tell me:
+
+```json
+{
+  "$.first_name": ["must be a string"],
+  "$.last_name": ["does not match pattern (.+)"]
+}
+```
+
+As you can see, we get a dictionary of JSON-path values to errors.
+
+More interestingly, you can use serializers in "reporting mode," which will *verify* that you're actually serializing what you said you would.
+If you mess up, it'll give you a report of where the errors were.
+This is intended to be used to make writing specs easier: to check that your serializer gives the right types, just use it in reporting mode and check the value!
+
+## Basic Design
+
+SoberSwag's reporting module is designed from the ground up to be *node-based*.
+Everything conforms to a common interface.
+For reporting *inputs*, all values:
+
+- Have a method `call` which converts an input to the desired format, or a report if there was an error
+- Have a method `call!` which converts an input to the desired format, or raises an exception if there was an error
+- Have a method `swagger_schema` which converts the node to its swagger schema.
+
+
+For reporting *outputs*, all values:
+
+- Have a method `call` which serializes out a value
+- Have a method `serialize_report` which serializes in "reporting mode," IE, it will return a report if serialization happened improperly
+- Have a method `views` which returns a *set of applicable views*.
+  This is used to implement a serializer with many alternatives.
+  These views *propagate* correctly.
+  So if you have views `[:base, :detail]` on a serializer for a person, a serializer for an array of people will have the same views.
+- Have a method `view` which takes in an argument, and returns a serializer specialized to that view.
+- Have a method `swagger_schema` which converts the node to its swagger schema
+
+From there, everything is done via composition.
+Nodes delegate to other nodes to provide functionality like "wrap this type in a common reference" and "validate that this string matches this regexp."
+Currently, the only validator built-in is matching a regexp or being a member of an enum, but we may add more in the future.
+You can also use `.mapped` to do custom validation:
+
+```ruby
+NotTheStringBob = SoberSwag::Reporting::Input.text.mapped do |text|
+  if text == "Bob"
+    Report::Value.new(['was the string bob I specifically told you not to be the string bob'])
+  else
+    text
+  end
+end
+```
+
+## Input Structs
+
+SoberSwag's reporting mode includes a class called `SoberSwag::Reporting::Input::Struct`.
+It can be used to model *struct inputs*, IE, inputs that have some properties and are represented by JSON objects.
+
+These structs behave much like Ruby structs, and implement inheritance *correctly*.
+This means that the following works:
+
+```ruby
+class Person < SoberSwag::Reporting::Input::Struct
+  attribute :first_name, SoberSwag::Reporting::Input.text
+  attribute :last_name, SoberSwag::Reporting::Input.text
+end
+
+class GradedPerson < Person
+  attribute :grade, SoberSwag::Reporting::Input.text.enum('A', 'B', 'C', 'D', 'F')
+end
+```
+
+## Output Structs
+
+SoberSwag's Reporting Output Structs work much the same way.
+You can define *fields* on them, which they will serialize.
+You can use them to define how to serialize an object, like so:
+
+```ruby
+class PersonOutput < SoberSwag::Output::Struct
+  field :first_name, SoberSwag::Reporting::Output.text
+  field :last_name, SoberSwag::Reporting::Output.text
+
+  field :grade, SoberSwag::Reporting::Output.text.nilable do
+    if object_to_serialize.respond_to?(:grade)
+      object_to_serialize.grade
+    else
+      nil
+    end
+  end
+
+  field :has_grade, SoberSwag::Reporting::Output.bool do
+    grade.nil? # fields are defined as *methods* on the output struct
+  end
+end
+```
+
+Output Structs can also have *views*.
+Views can be nested only once - if you use a serializer with views as the key of an object, we will *always* use the base view.
+This prevents some weirdness with the non-reporting SoberSwag serializers, where views could technically be read by child objects in some circumstances as they were only passed in the `view` key.
+A view will *always inherit all attributes of the parent object, regardless of order.*
+
+```ruby
+class AlternativePersonOutput < SoberSwag::Output::Struct
+  field :first_name, SoberSwag::Reporting::Output.text
+
+  view :with_grade do
+    field :grade, SoberSwag::Reporting::Output.text.nilable do
+      if object_to_serialize.respond_to?(:grade)
+        object_to_serialize.grade
+      else
+        nil
+      end
+    end
+  end
+
+  field :last_name, SoberSwag::Reporting::Output.text
+end
+
+AlternativePersonOutput.views # => Set.new(:base, :with_grade)
+AlternativePersonOutput.view(:with_grade).serialize(my_person) # includes the last_name field
+```
+
+View relationships are modeled with *composition*.
+This leads to slightly more natural to read swagger schemas.
+
+## Dictionary Types
+
+SoberSwag's reporting outputs allow defining a *dictionary* of key-value types.
+This lets you represent an object like this in your schema:
+
+```json
+{
+  "name": "Advanced Time Travel",
+  "student_grades": {
+    "student_id_1": "F",
+    "student_id_2": "F"
+  }
+}
+```
+
+This type would probably be represented by:
+
+```ruby
+class Classroom < SoberSwag::Reporting::Input::Struct
+  attribute :name, SoberSwag::Reporting::Input.text
+  attribute :student_grades, SoberSwag::Reporting::Input::Dictionary.of(
+    SoberSwag::Reporting::Input.text.enum('A', 'B', 'C', 'D', 'F')
+  )
+end
+```
+
+## Referenced Types
+
+If you have a type you use a lot, and you want to refer to it by a common name, you can describe it like so:
+
+```ruby
+GradeEnum = SoberSwag::Reporting::Input.text.enum('A', 'B', 'C', 'D', 'F').referenced('GradeEnum')
+```
+
+This will now be represented as a Reference type in generated swagger.
+
+## Things not present
+
+There are basically two things to keep in mind when upgrading to `SoberSwag::Reporting`.
+
+1. There is no longer a `default` for a type.
+   This is because that was really hard to model in Swagger, and can be better served via use of `.mapped` and `.optional`.
+   We may add this back eventually.
+2. Serializers no longer take an arbitrary `options` key.
+   Instead, view management is now *explicit*.
+   This is because it was too tempting to pass data to serialize in the options key, which is against the point of the serializers.
+
+

data/example/Gemfile

@@ -8,7 +8,7 @@ gem 'actionpack', '>= 6.0.3.2'
 # Use sqlite3 as the database for Active Record
 gem 'sqlite3', '~> 1.4'
 # Use Puma as the app server
-gem 'puma', '~> 5.3'
+gem 'puma', '~> 5.4'
 # Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
 # gem 'jbuilder', '~> 2.7'
 # Use Active Model has_secure_password
@@ -34,7 +34,7 @@ group :development, :test do
 end
 
 group :development do
-  gem 'listen', '>= 3.0.5', '< 3.7'
+  gem 'listen', '>= 3.0.5', '< 3.8'
   # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
   gem 'spring'
   gem 'spring-watcher-listen', '~> 2.0.0'

data/example/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    sober_swag (0.19.0)
+    sober_swag (0.21.0)
       activesupport
       dry-struct (~> 1.0)
       dry-types (~> 1.2)
@@ -9,164 +9,155 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.0.3.2)
-      actionpack (= 6.0.3.2)
+    actioncable (6.0.4.1)
+      actionpack (= 6.0.4.1)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.0.3.2)
-      actionpack (= 6.0.3.2)
-      activejob (= 6.0.3.2)
-      activerecord (= 6.0.3.2)
-      activestorage (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
+    actionmailbox (6.0.4.1)
+      actionpack (= 6.0.4.1)
+      activejob (= 6.0.4.1)
+      activerecord (= 6.0.4.1)
+      activestorage (= 6.0.4.1)
+      activesupport (= 6.0.4.1)
       mail (>= 2.7.1)
-    actionmailer (6.0.3.2)
-      actionpack (= 6.0.3.2)
-      actionview (= 6.0.3.2)
-      activejob (= 6.0.3.2)
+    actionmailer (6.0.4.1)
+      actionpack (= 6.0.4.1)
+      actionview (= 6.0.4.1)
+      activejob (= 6.0.4.1)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.0.3.2)
-      actionview (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
+    actionpack (6.0.4.1)
+      actionview (= 6.0.4.1)
+      activesupport (= 6.0.4.1)
       rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.0.3.2)
-      actionpack (= 6.0.3.2)
-      activerecord (= 6.0.3.2)
-      activestorage (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
+    actiontext (6.0.4.1)
+      actionpack (= 6.0.4.1)
+      activerecord (= 6.0.4.1)
+      activestorage (= 6.0.4.1)
+      activesupport (= 6.0.4.1)
       nokogiri (>= 1.8.5)
-    actionview (6.0.3.2)
-      activesupport (= 6.0.3.2)
+    actionview (6.0.4.1)
+      activesupport (= 6.0.4.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.3.2)
-      activesupport (= 6.0.3.2)
+    activejob (6.0.4.1)
+      activesupport (= 6.0.4.1)
       globalid (>= 0.3.6)
-    activemodel (6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activerecord (6.0.3.2)
-      activemodel (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activestorage (6.0.3.2)
-      actionpack (= 6.0.3.2)
-      activejob (= 6.0.3.2)
-      activerecord (= 6.0.3.2)
-      marcel (~> 0.3.1)
-    activesupport (6.0.3.2)
+    activemodel (6.0.4.1)
+      activesupport (= 6.0.4.1)
+    activerecord (6.0.4.1)
+      activemodel (= 6.0.4.1)
+      activesupport (= 6.0.4.1)
+    activestorage (6.0.4.1)
+      actionpack (= 6.0.4.1)
+      activejob (= 6.0.4.1)
+      activerecord (= 6.0.4.1)
+      marcel (~> 1.0.0)
+    activesupport (6.0.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2, >= 2.2.2)
-    bootsnap (1.7.5)
+    bootsnap (1.9.3)
       msgpack (~> 1.0)
     builder (3.2.4)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     crass (1.0.6)
     diff-lcs (1.4.4)
-    dry-configurable (0.11.6)
+    dry-configurable (0.13.0)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.4, >= 0.4.7)
-      dry-equalizer (~> 0.2)
-    dry-container (0.7.2)
+      dry-core (~> 0.6)
+    dry-container (0.9.0)
       concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.4.9)
+      dry-configurable (~> 0.13, >= 0.13.0)
+    dry-core (0.7.1)
       concurrent-ruby (~> 1.0)
-    dry-equalizer (0.3.0)
-    dry-inflector (0.2.0)
-    dry-logic (1.0.6)
+    dry-inflector (0.2.1)
+    dry-logic (1.2.0)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.2)
-      dry-equalizer (~> 0.2)
-    dry-struct (1.3.0)
-      dry-core (~> 0.4, >= 0.4.4)
-      dry-equalizer (~> 0.3)
-      dry-types (~> 1.3)
+      dry-core (~> 0.5, >= 0.5)
+    dry-struct (1.4.0)
+      dry-core (~> 0.5, >= 0.5)
+      dry-types (~> 1.5)
       ice_nine (~> 0.11)
-    dry-types (1.4.0)
+    dry-types (1.5.1)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.3)
-      dry-core (~> 0.4, >= 0.4.4)
-      dry-equalizer (~> 0.3)
+      dry-core (~> 0.5, >= 0.5)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 1.0, >= 1.0.2)
     dry-types-rails (0.3.4)
       dry-types (>= 0.8.1)
       rails (>= 3)
     erubi (1.10.0)
-    ffi (1.15.3)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
-    i18n (1.8.9)
+    ffi (1.15.4)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.8.11)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
-    listen (3.6.0)
+    listen (3.7.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    loofah (2.9.0)
+    loofah (2.12.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.2)
     method_source (1.0.0)
-    mimemagic (0.3.10)
-      nokogiri (~> 1)
-      rake
-    mini_mime (1.0.2)
-    mini_portile2 (2.5.1)
+    mini_mime (1.1.2)
+    mini_portile2 (2.6.1)
     minitest (5.14.4)
     msgpack (1.4.2)
-    nio4r (2.5.7)
-    nokogiri (1.11.5)
-      mini_portile2 (~> 2.5.0)
+    nio4r (2.5.8)
+    nokogiri (1.12.5)
+      mini_portile2 (~> 2.6.1)
       racc (~> 1.4)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    puma (5.3.2)
+    puma (5.5.2)
       nio4r (~> 2.0)
-    racc (1.5.2)
+    racc (1.6.0)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.0.3.2)
-      actioncable (= 6.0.3.2)
-      actionmailbox (= 6.0.3.2)
-      actionmailer (= 6.0.3.2)
-      actionpack (= 6.0.3.2)
-      actiontext (= 6.0.3.2)
-      actionview (= 6.0.3.2)
-      activejob (= 6.0.3.2)
-      activemodel (= 6.0.3.2)
-      activerecord (= 6.0.3.2)
-      activestorage (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
+    rails (6.0.4.1)
+      actioncable (= 6.0.4.1)
+      actionmailbox (= 6.0.4.1)
+      actionmailer (= 6.0.4.1)
+      actionpack (= 6.0.4.1)
+      actiontext (= 6.0.4.1)
+      actionview (= 6.0.4.1)
+      activejob (= 6.0.4.1)
+      activemodel (= 6.0.4.1)
+      activerecord (= 6.0.4.1)
+      activestorage (= 6.0.4.1)
+      activesupport (= 6.0.4.1)
       bundler (>= 1.3.0)
-      railties (= 6.0.3.2)
+      railties (= 6.0.4.1)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
+    rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
-    railties (6.0.3.2)
-      actionpack (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
+    railties (6.0.4.1)
+      actionpack (= 6.0.4.1)
+      activesupport (= 6.0.4.1)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.20.3, < 2.0)
-    rake (13.0.3)
+    rake (13.0.6)
     rb-fsevent (0.11.0)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
@@ -178,7 +169,7 @@ GEM
     rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-rails (5.0.1)
+    rspec-rails (5.0.2)
       actionpack (>= 5.2)
       activesupport (>= 5.2)
       railties (>= 5.2)
@@ -186,7 +177,7 @@ GEM
       rspec-expectations (~> 3.10)
       rspec-mocks (~> 3.10)
       rspec-support (~> 3.10)
-    rspec-support (3.10.2)
+    rspec-support (3.10.3)
     spring (2.1.1)
     spring-watcher-listen (2.0.1)
       listen (>= 2.7, < 4.0)
@@ -194,19 +185,19 @@ GEM
     sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.2.1)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
+    sprockets-rails (3.4.1)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
       sprockets (>= 3.0.0)
     sqlite3 (1.4.2)
     thor (1.1.0)
     thread_safe (0.3.6)
     tzinfo (1.2.9)
       thread_safe (~> 0.1)
-    websocket-driver (0.7.3)
+    websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   ruby
@@ -216,9 +207,9 @@ DEPENDENCIES
   bootsnap (>= 1.4.2)
   byebug
   dry-types-rails
-  listen (>= 3.0.5, < 3.7)
+  listen (>= 3.0.5, < 3.8)
   pry
-  puma (~> 5.3)
+  puma (~> 5.4)
   rails (~> 6.0.2, >= 6.0.2.2)
   rspec-rails
   sober_swag!

data/example/app/controllers/application_controller.rb

@@ -4,4 +4,8 @@ class ApplicationController < ActionController::API
   rescue_from Dry::Struct::Error do
     head :bad_request
   end
+
+  rescue_from SoberSwag::Reporting::Report::Error do |error|
+    render json: error.report.path_hash, status: :bad_request
+  end
 end