apia-open_api 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6621197f4a9535afae13e2a83de1fc5993290f379660e347afe989e94f3179ba
-  data.tar.gz: a932546d15d8302931a4c55d1fa4fa1e088b4f74ee7b227d0817de5f7b3f6dbb
+  metadata.gz: ce32b2c3d98cff03c533669e56c860dcda6b97a0deb554d423f8c208645ea87a
+  data.tar.gz: 9f9d5b952f2cc7141a0c207fa8d43c9d5d7a2a617dabb1819bb07e6a7decc691
 SHA512:
-  metadata.gz: d5bb084664b9a2729f8b0fb8408c8cd66eb6b8a637255582aba4c01cf5867eb2b88b5de5d1baba1eb4ebbece5f8d7353a7bedcbe68abe75036c7be9578a1a5c3
-  data.tar.gz: b99e2cc62ea871c657cbe523e1680d78f3341919b0a726d0fd6548635173a2064027c5c927d1a246be3120a508366e4627e4351c0040951d30a84694316fda3f
+  metadata.gz: 5b83929f1bc986f6ce7d8d736f30b76992868bd6442d72b9f8456d83537bc91b1b8d4297ad94655aaf86720d40468305215f2e28fcd61f63253ee9d24fc59874
+  data.tar.gz: 13c108fcb4596a5912781732192e4bac034c6dd7a441e951edff6b740515e188a3ee03ba73cb63c518f235bff5a57b09a0dd3a8f3dcff77f79ccfb81edfbb61c

data/Gemfile

@@ -5,7 +5,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in apia-open_api.gemspec
 gemspec
 
-gem "apia", "~> 3.5"
+gem "apia", "~> 3.7"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 gem "rubocop", "~> 1.21"

data/README.md

@@ -1,6 +1,6 @@
 # Apia OpenAPI Specification
 
-This gem can generate an [OpenAPI](https://www.openapis.org/) compatible schema from an API implemented using [Apia](https://github.com/krystal/apia).
+This gem can generate an [OpenAPI](https://www.openapis.org/) compatible schema from an API implemented using [Apia](https://github.com/apiaframework/apia).
 
 This gem is in the early phases of development and breaking changes may be introduced whilst the gem is in the 0.1.x version range.
 
@@ -12,7 +12,7 @@ Install the gem and add to the application's Gemfile by executing:
 
 ## Usage
 
-The schema can be mounted in much the same way as an [Apia API](https://github.com/krystal/apia) itself.
+The schema can be mounted in much the same way as an [Apia API](https://github.com/apiaframework/apia) itself.
 
 For example, for a Ruby on Rails application:
 
@@ -85,7 +85,7 @@ You can also run `bin/console` for an interactive prompt that will allow you to
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/krystal/apia-open_api.
+Bug reports and pull requests are welcome on GitHub at https://github.com/apiaframework/apia-open_api.
 
 ## License
 

data/apia-open_api.gemspec

@@ -8,13 +8,13 @@ Gem::Specification.new do |spec|
   spec.authors = ["Paul Sturgess"]
 
   spec.summary = "Apia OpenAPI spec generator"
-  spec.homepage = "https://github.com/krystal/apia-openapi"
+  spec.homepage = "https://github.com/apiaframework/apia-openapi"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.7.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/krystal/apia-openapi"
-  spec.metadata["changelog_uri"] = "https://github.com/krystal/apia-openapi/changelog.md"
+  spec.metadata["source_code_uri"] = "https://github.com/apiaframework/apia-openapi"
+  spec.metadata["changelog_uri"] = "https://github.com/apiaframework/apia-openapi/changelog.md"
 
   spec.metadata["rubygems_mfa_required"] = "false" # rubocop:disable Gemspec/RequireMFA (enabling MFA means we cannot auto publish via the CI)
 

data/lib/apia/open_api/objects/response.rb

@@ -36,6 +36,7 @@ module Apia
           @route_spec = route_spec
           @api_authenticator = api_authenticator
           @http_status = @endpoint.definition.http_status
+          @response_type = @endpoint.definition.response_type
         end
 
         def add_to_spec
@@ -46,9 +47,14 @@ module Apia
         private
 
         def add_sucessful_response_schema
-          content_schema = {
-            properties: generate_properties_for_successful_response
-          }
+          if @response_type == Apia::Response::PLAIN
+            content_schema = { type: "string" }
+          else
+            content_schema = {
+              properties: generate_properties_for_successful_response
+            }
+          end
+
           required_fields = @endpoint.definition.fields.select { |_, field| field.condition.nil? }
           content_schema[:required] = required_fields.keys if required_fields.any?
 
@@ -56,7 +62,7 @@ module Apia
             "#{@http_status}": {
               description: @endpoint.definition.description || "",
               content: {
-                "application/json": {
+                @response_type => {
                   schema: content_schema
                 }
               }

data/lib/apia/open_api/version.rb

@@ -3,7 +3,7 @@
 module Apia
   module OpenApi
 
-    VERSION = "0.1.6"
+    VERSION = "0.1.7"
 
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apia-open_api
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Paul Sturgess
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-08 00:00:00.000000000 Z
+date: 2024-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -47,13 +47,13 @@ files:
 - lib/apia/open_api/rack.rb
 - lib/apia/open_api/specification.rb
 - lib/apia/open_api/version.rb
-homepage: https://github.com/krystal/apia-openapi
+homepage: https://github.com/apiaframework/apia-openapi
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/krystal/apia-openapi
-  source_code_uri: https://github.com/krystal/apia-openapi
-  changelog_uri: https://github.com/krystal/apia-openapi/changelog.md
+  homepage_uri: https://github.com/apiaframework/apia-openapi
+  source_code_uri: https://github.com/apiaframework/apia-openapi
+  changelog_uri: https://github.com/apiaframework/apia-openapi/changelog.md
   rubygems_mfa_required: 'false'
 post_install_message: 
 rdoc_options: []