apia-open_api 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f5de7b599466adb38eeeb825b2688ca64460a5c10c517141775af93355d35f6
-  data.tar.gz: 285a0dfa241e201f1df2370553294cd7514b9ef339060a3f9b0ff5d3268a7064
+  metadata.gz: e088b172e1ebbabca8a2520ecb0958e3663bc36231a84f06191057500fb9ca60
+  data.tar.gz: ea8b66ea6a4bcd2fe9a8fb94c632034ae6166c49e9a22c75469fe5a8d93d9a2f
 SHA512:
-  metadata.gz: cce09e236df6739ae7d4480597d4dbe012c901bd3aa5e4ebc38f49c19915917997737f3b5d2bee4fc09ec82a9223842fb84793b7cf746994dc2f37dac7d115cb
-  data.tar.gz: e02b8c2ff50507d65cb45a0b67ab189782174e5c95dae20b29d11c671e3562e1c6dcf80c1950fad5276eff3cf4fdc6975b761ac81f3b8806379b225c6cec91e2
+  metadata.gz: 16d96e51f64037afe00b2b8dcddedfb0f1aa9f98d4bbb9effab44094b3db1d82aa4351cbab692002f36a60ee2727a16ebf7557f5a5e906bd4f6ae25590bc113d
+  data.tar.gz: 7e18b018812c02900b10b1948e27c9b631cd8099beab1c1f1880557b0c4b7d1173d6204a77c55a355f5bb9c1de20ff6925980e4c0ec8c1f2c649c38acfa3dfb9

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

@@ -99,15 +99,33 @@ module Apia
             end
           end
 
-          id = "#{@route.request_method}:#{result_parts.join('_')}"
-          if @path_ids.include?(id)
-            id = "#{@route.request_method}:#{@route.path}"
-          end
+          first_part = "#{@route.request_method}:"
+          id = "#{first_part}#{result_parts.join('_')}"
+
+          id = fallback_id(first_part) if @path_ids.include?(id)
           @path_ids << id
 
           id
         end
 
+        # IDs can clash if two paths are different, but generate the same ID.
+        # For example:
+        # - /dns_zones/:dns_zone
+        # - /dns/zones/:dns_zone
+        # When there is a duplicate we fallback to using the path, but as the path
+        # ID is used as the prefix for any $ref IDs, we need to make sure it's not
+        # too long. This is because there is a 100 character filename limit imposed
+        # by the rubygems gem builder.
+        def fallback_id(first_part)
+          last_part = @route.path
+          if last_part.length >= 50
+            last_part = last_part.split(/[_:\/]/).map do |word|
+              word[0]
+            end.join("_")
+          end
+          "#{first_part}#{last_part}"
+        end
+
       end
     end
   end

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

@@ -229,16 +229,29 @@ module Apia
           elsif definitions.length == 1
             "#{generate_id_from_definition(definitions.first)}Response"
           else
-            [
-              (definitions - api_authenticator_error_defs).map do |d|
-                generate_id_from_definition(d)
-              end.join,
-              http_status_code,
-              "Response"
-            ].flatten.join("_").camelize
+            generate_short_error_ref(http_status_code, definitions, api_authenticator_error_defs)
           end
         end
 
+        # When we have multiple errors for the same http status code, we need to generate a unique ID.
+        # By default we join all the error names together, with the http status code and camelize them.
+        # 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)
+          generated_ids = (definitions - api_authenticator_error_defs).map do |d|
+            generate_id_from_definition(d)
+          end.sort
+          if generated_ids.join.length > 80
+            sliced_ids = [generated_ids.first] + generated_ids[-2..]
+          end
+          [
+            (sliced_ids || generated_ids).join,
+            http_status_code,
+            "Error"
+          ].flatten.join("_").camelize
+        end
+
         def add_to_responses_components(http_status_code, definitions, id)
           return unless @spec.dig(:components, :components, id).nil?
 

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

@@ -144,9 +144,14 @@ module Apia
             schema[:properties][child.name.to_s] = generate_schema_ref(child)
           else
             child_path = @path.nil? ? nil : @path + [child]
+
+            # Nested partial fields in the response have the potential to generate
+            # very long IDs, so we truncate them to avoid hitting the 100 character
+            # filename limit imposed by the rubygems gem builder.
+            truncated_id = @id.match(/^(.*?)\d*?(Response|Part).*$/)[1]
             schema[:properties][child.name.to_s] = generate_schema_ref(
               child,
-              id: "#{@id}_#{child.name}".camelize,
+              id: "#{truncated_id}Part_#{child.name}".camelize,
               endpoint: @endpoint,
               path: child_path
             )

data/lib/apia/open_api/version.rb

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

metadata

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