openapi-ruby 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8dfe417a1a5864710883f37f364361850908925c15f4bde8c97a2cce5568040b
-  data.tar.gz: 1cae3cd37db70840d39afe38d49dabe7e136c3b5801d0485a0618cbd674c7427
+  metadata.gz: 398dab24d8afcf002fff3be85c3e47c2b83688904d2b3577e071ad790398caf0
+  data.tar.gz: 071ad3e3c2b9d15e6f4aa60fcf09f8fef2260f43e35e9c6a69af04071da2d6a6
 SHA512:
-  metadata.gz: 10c973884753f494a4917b88ca87ccdabdd408e06b365665a576cc0cf8940891f8656c8e657e9e873ca2b4c42dad4b6b172dfbe8a1e84203a192a16c6c8f1282
-  data.tar.gz: f41d3b6d56b26aaef013572733bf360a066abfb8cf1be4df4af0583cb23a685d0bc09d58c27b816229b7ae23b2dbd0a07d75e0a6ad211ad9e2d3b3ae7c6075d0
+  metadata.gz: 7745b15a5b56b12b9a7c2b24ddfe761d37faea4835114722960dbc575bd2ae386780284a2791a1b57d08374cad5a8f5079ff410cefcbedce521c719bc892ab81
+  data.tar.gz: a6baddb8b5850f6b273506f04fa9e8917338431c3d08ab698f710fa791b7c99e4f4ad5b861c298ca08b9b156342606ca760efb7720d7d1a735f6197faee4807d

data/lib/openapi_ruby/adapters/rspec.rb

@@ -84,8 +84,8 @@ module OpenapiRuby
           end
         end
 
-        def response(status_code, description, &block)
-          response_ctx = @operation.response(status_code, description)
+        def response(status_code, description, hidden: false, &block)
+          response_ctx = @operation.response(status_code, description, hidden: hidden)
           operation = @operation
 
           @example_group.context "response #{status_code} #{description}" do

data/lib/openapi_ruby/dsl/operation_context.rb

@@ -55,7 +55,16 @@ module OpenapiRuby
       end
 
       def request_body(attributes = {})
-        @request_body_definition = deep_stringify(attributes)
+        stringified = deep_stringify(attributes)
+
+        # Shorthand: if schema is provided without content, wrap it in
+        # content: { "application/json" => { schema: ... } }
+        if stringified["schema"] && !stringified["content"]
+          schema = stringified.delete("schema")
+          stringified["content"] = {"application/json" => {"schema" => schema}}
+        end
+
+        @request_body_definition = stringified
       end
 
       def request_body_example(value:, name: "example", summary: nil)
@@ -64,8 +73,8 @@ module OpenapiRuby
         @request_examples << entry
       end
 
-      def response(status_code, description, &block)
-        ctx = ResponseContext.new(status_code, description)
+      def response(status_code, description, hidden: false, &block)
+        ctx = ResponseContext.new(status_code, description, hidden: hidden)
         ctx.produces(*@produces_list) if @produces_list.any?
         ctx.instance_eval(&block) if block
         @responses[status_code.to_s] = ctx
@@ -84,6 +93,7 @@ module OpenapiRuby
 
         result["responses"] = {}
         @responses.each do |code, ctx|
+          next if ctx.hidden
           result["responses"][code] = ctx.to_openapi
         end
 

data/lib/openapi_ruby/dsl/response_context.rb

@@ -3,11 +3,12 @@
 module OpenapiRuby
   module DSL
     class ResponseContext
-      attr_reader :status_code, :description, :schema_definition, :headers, :examples, :links
+      attr_reader :status_code, :description, :schema_definition, :headers, :examples, :links, :hidden
 
-      def initialize(status_code, description)
+      def initialize(status_code, description, hidden: false)
         @status_code = status_code.to_s
         @description = description
+        @hidden = hidden
         @schema_definition = nil
         @headers = {}
         @examples = {}

data/lib/openapi_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiRuby
-  VERSION = "2.2.1"
+  VERSION = "2.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openapi-ruby
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Morten Hartvig