Add support for "nullable" in OpenAPI 3.0, closes #106

Author: Jan Henning Thorsen

Changes

@@ -2,10 +2,11 @@ Revision history for perl distribution Mojolicious-Plugin-OpenAPI
 
 2.12 Not Released
  - Fix HEAD requests #105
- - Bump JSON::Validator to 3.06
+ - Add support for "nullable" in OpenAPI 3.0 #106
  - Improved handling of Accept header in OpenAPI v3 #104
    Can now handle wildcards, such as application/* and */*, even though not
    defined in the specification.
+ - Bump JSON::Validator to 3.06
 
 2.11 2019-01-26T11:37:15+0900
  - Fix allowing regular requests with "openapi_cors_allowed_origins" #103

lib/JSON/Validator/OpenAPI/Mojolicious.pm

@@ -296,6 +296,10 @@ sub _set_request_data {
   }
 }
 
+sub _to_list {
+  return ref $_[0] eq 'ARRAY' ? @{$_[0]} : $_[0] ? ($_[0]) : ();
+}
+
 sub _validate_request_body {
   my ($self, $c, $body_schema) = @_;
   my $ct = $c->req->headers->content_type // '';
@@ -387,19 +391,32 @@ sub _validate_type_file {
 }
 
 sub _validate_type_object {
-  return shift->SUPER::_validate_type_object(@_) unless $_[0]->{validate_input};
-
   my ($self, $data, $path, $schema) = @_;
-  my $properties    = $schema->{properties} || {};
-  my $discriminator = $schema->{discriminator};
-  my (%ro, @e);
+  return shift->SUPER::_validate_type_object(@_) unless ref $data eq 'HASH';
+
+  # Support "nullable" in v3
+  # "nullable" is the same as "type":["null", ...], which is supported by many
+  # tools, even though not officially supported by OpenAPI.
+  my %properties = %{$schema->{properties} || {}};
+  local $schema->{properties} = \%properties;
+  if ($self->version eq '3') {
+    for my $key (keys %properties) {
+      next unless $properties{$key}{nullable};
+      $properties{$key} = {%{$properties{$key}}};
+      $properties{$key}{type} = ['null', _to_list($properties{$key}{type})];
+    }
+  }
 
-  for my $p (keys %$properties) {
-    next unless $properties->{$p}{readOnly};
+  return shift->SUPER::_validate_type_object(@_) unless $self->{validate_input};
+
+  my (@e, %ro);
+  for my $p (keys %properties) {
+    next unless $properties{$p}{readOnly};
     push @e, JSON::Validator::E("$path/$p", "Read-only.") if exists $data->{$p};
     $ro{$p} = 1;
   }
 
+  my $discriminator = $schema->{discriminator};
   if ($discriminator and !$self->{inside_discriminator}) {
     my $name = $data->{$discriminator}
       or return JSON::Validator::E($path, "Discriminator $discriminator has no value.");

t/v3-nullable.t

@@ -0,0 +1,72 @@
+use Mojo::Base -strict;
+use Test::Mojo;
+use Test::More;
+
+use Mojolicious::Lite;
+
+plan skip_all => $@ unless eval 'use YAML::XS 0.67;1';
+
+my %data = (id => 42);
+get '/nullable-data' => sub {
+  my $c = shift->openapi->valid_input or return;
+  $c->render(openapi => \%data);
+  },
+  'withNullable';
+
+plugin OpenAPI => {url => 'data:///nullable.json', schema => 'v3'};
+
+my $t = Test::Mojo->new;
+$t->get_ok('/nullable-data')->status_is(500);
+
+$data{name} = undef;
+$t->get_ok('/nullable-data')->status_is(200);
+
+$data{name} = 'batgirl';
+$t->get_ok('/nullable-data')->status_is(200);
+
+done_testing;
+
+__DATA__
+@@ nullable.json
+{
+  "openapi": "3.0.0",
+  "info": {
+    "license": {
+      "name": "MIT"
+    },
+    "title": "Swagger Petstore",
+    "version": "1.0.0"
+  },
+  "servers": [
+    { "url": "http://petstore.swagger.io/v1" }
+  ],
+  "paths": {
+    "/nullable-data": {
+      "get": {
+        "operationId": "withNullable",
+        "summary": "Dummy",
+        "responses": {
+          "200": {
+            "description": "type:[null, string, ...] does the same",
+            "content": {
+              "application/json": {
+                "schema": { "$ref": "#/components/schemas/WithNullable" }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "WithNullable": {
+        "required": [ "id", "name" ],
+        "properties": {
+          "id": { "type": "integer", "format": "int64" },
+          "name": { "type": "string", "nullable": true }
+        }
+      }
+    }
+  }
+}

t/v3.t

@@ -68,7 +68,6 @@ $t->post_ok('/pets', {Cookie => 'debug=1'}, json => {id => 1, name => 'Supercow'
 
 $t->post_ok('/pets', form => {id => 1, name => 'Supercow'})->status_is(201)->content_is('');
 
-
 done_testing;
 
 __DATA__