apia-open_api 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e088b172e1ebbabca8a2520ecb0958e3663bc36231a84f06191057500fb9ca60
-  data.tar.gz: ea8b66ea6a4bcd2fe9a8fb94c632034ae6166c49e9a22c75469fe5a8d93d9a2f
+  metadata.gz: f046cce05d4154ba36e9f52227306129ef092e75061db7a522b44ade60b252c0
+  data.tar.gz: 2c56c6cedf8281819ca4c6382159183cdcc0c550d27375410f7f39cfe4bb842a
 SHA512:
-  metadata.gz: 16d96e51f64037afe00b2b8dcddedfb0f1aa9f98d4bbb9effab44094b3db1d82aa4351cbab692002f36a60ee2727a16ebf7557f5a5e906bd4f6ae25590bc113d
-  data.tar.gz: 7e18b018812c02900b10b1948e27c9b631cd8099beab1c1f1880557b0c4b7d1173d6204a77c55a355f5bb9c1de20ff6925980e4c0ec8c1f2c649c38acfa3dfb9
+  metadata.gz: 9c60e070b4a683379b689fff7c95ba8a7aa6ea9f2902e13b68474190b2aac234feec2428c73871591b467af2ba17be21c2dcb6d8b2297014a88e1ec783311472
+  data.tar.gz: afce3695675df681249591575c3704161caa3dd66b91a67e89bc67e58b07d45d8d6445e0080f7264c2a0fb234f1a03f87eec97aeeba22e39bf873f991b38452b

data/README.md

@@ -2,17 +2,13 @@
 
 This gem can generate an [OpenAPI](https://www.openapis.org/) compatible schema from an API implemented using [Apia](https://github.com/krystal/apia).
 
-## Installation
+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.
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add apia-open_api
 
 ## Usage
 
@@ -85,7 +81,7 @@ You can also run `bin/console` for an interactive prompt that will allow you to
 
 ## Releasing a new version
 
-TODO: Write instructions for releasing a new version of the gem.
+[Release Please](https://github.com/googleapis/release-please) is configured. The [convential commits](https://www.conventionalcommits.org/en/v1.0.0/) format should be used and upon merging to main, Release Please will open a new PR following semver rules. When that Release Please PR is merged, a new version will be published to RubyGems.
 
 ## Contributing
 

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

@@ -211,7 +211,7 @@ module Apia
         end
 
         def generate_ref(namespace, http_status_code, definitions)
-          id = generate_id_for_error_ref(http_status_code, definitions)
+          id = generate_id_for_error_ref(namespace, http_status_code, definitions)
           if namespace == "responses"
             add_to_responses_components(http_status_code, definitions, id)
           else
@@ -220,16 +220,17 @@ module Apia
           { "$ref": "#/components/#{namespace}/#{id}" }
         end
 
-        def generate_id_for_error_ref(http_status_code, definitions)
+        def generate_id_for_error_ref(namespace, http_status_code, definitions)
+          suffix = namespace == "responses" ? "Response" : "Schema"
           api_authenticator_error_defs = api_authenticator_potential_errors.map(&:definition).select do |d|
             d.http_status_code.to_s == http_status_code.to_s
           end
           if api_authenticator_error_defs.any? && api_authenticator_error_defs == definitions
-            "APIAuthenticator#{http_status_code}Response"
+            "APIAuthenticator#{http_status_code}#{suffix}"
           elsif definitions.length == 1
-            "#{generate_id_from_definition(definitions.first)}Response"
+            "#{generate_id_from_definition(definitions.first)}#{suffix}"
           else
-            generate_short_error_ref(http_status_code, definitions, api_authenticator_error_defs)
+            generate_short_error_ref(suffix, http_status_code, definitions, api_authenticator_error_defs)
           end
         end
 
@@ -238,7 +239,7 @@ module Apia
         # If this is too long, we use only the first and last two error names. Error names are sorted
         # alphabetically, which should ensure we do not generate the same ID to represent different sets of errors.
         # The length is important because the rubygems gem builder imposes a 100 character limit on filenames.
-        def generate_short_error_ref(http_status_code, definitions, api_authenticator_error_defs)
+        def generate_short_error_ref(suffix, http_status_code, definitions, api_authenticator_error_defs)
           generated_ids = (definitions - api_authenticator_error_defs).map do |d|
             generate_id_from_definition(d)
           end.sort
@@ -248,7 +249,7 @@ module Apia
           [
             (sliced_ids || generated_ids).join,
             http_status_code,
-            "Error"
+            suffix.first(3)
           ].flatten.join("_").camelize
         end
 
@@ -282,16 +283,31 @@ module Apia
           component_schema
         end
 
+        # We want to declare the code in the error response as an enum, with only
+        # one possible value, as this makes it explicit to the client what the
+        # value will be.
+        #
+        # However, the code field is not defined as an Enum scalar within Apia,
+        # so we generate an Enum definition "on the fly" here.
+        #
+        # This means we can add a schema for the enum and a related $ref, which
+        # helps prompt client generators to generate an explicit enum type for the code.
+        # Otherwise if we generate the enum 'inline' in the response, some client generators
+        # will not generate an enum type for the code.
         def generate_schema_properties_for_definition(definition)
-          detail = generate_schema_ref(definition, id: generate_id_from_definition(definition))
+          id = generate_id_from_definition(definition)
+          detail_ref = generate_schema_ref(definition, id: id)
+
+          code_enum_id = "#{id}Enum"
+          code_enum_field_definition = Definitions::Field.new(:enum, id: code_enum_id)
+          code_enum_field_definition.type = Class.new(Apia::Enum) { value(definition.code) }
+          code_ref = generate_schema_ref(code_enum_field_definition, id: code_enum_id)
+
           {
             properties: {
-              code: {
-                type: "string",
-                enum: [definition.code]
-              },
+              code: code_ref,
               description: { type: "string" },
-              detail: detail
+              detail: detail_ref
             }
           }
         end

data/lib/apia/open_api/version.rb

@@ -3,7 +3,7 @@
 module Apia
   module OpenApi
 
-    VERSION = "0.1.2"
+    VERSION = "0.1.4"
 
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apia-open_api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Paul Sturgess
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-11 00:00:00.000000000 Z
+date: 2023-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport