api-regulator 0.1.25 → 0.1.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bfac01d6824d8766853d5828ea9f0eddd0e72dd76fb6b97c7bf3927803f7df1
-  data.tar.gz: 87cb03abe3c0b824fd60192cae2a2e91d856b2781a07e6db17ff6de087e6d81d
+  metadata.gz: a9d490065a7ecefa7103daa60c7baaa858d36baf23f5f4458713307ed3f196d8
+  data.tar.gz: 12fca76002d7a1dfb68318c372d8248ccd3bcb49d37db02eff42743bb721345c
 SHA512:
-  metadata.gz: cb4c663aa47979a8199ecd58acd61676f266dd6cb03beed0158a6bc5a9060c8f5af19ce08821533627c9bce2ae6409a0be23ce820a0d11c2c242195b531d59c8
-  data.tar.gz: d75f1bfe1f0f045868fedc9782fabb57825d3815e85572bc0be24c3f62eab5d2db868710a73206a138b8f334477792fdd2cbc92ad74646bd8d0c205e71a15fdc
+  metadata.gz: 4890734557bcf61f41cc049cccf85faa09e8f9d8f76534efbba9409eb22e46bc6c030bee3c900029361f3418387c0762792120aa96af03061de046b35c979c4e
+  data.tar.gz: cb73bb660740be6f0c1efde659db26dbf576cf009f5fbe16f19d5ad10cf763b7e5aa443f1c6dfb5743e02b221c7a48077ddf7ff98797243632208cda4fe39835

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    api-regulator (0.1.25)
+    api-regulator (0.1.26)
       activemodel (~> 8.0)
       activesupport (~> 8.0)
 

data/lib/api_regulator/api.rb

@@ -1,6 +1,7 @@
 module ApiRegulator
   class Api
-    attr_reader :controller_class, :controller_path, :controller_name, :action_name, :description, :title, :params, :responses, :versions
+    attr_reader :controller_class, :controller_path, :controller_name, :action_name, :description,
+      :title, :params, :responses, :versions, :examples
 
     def initialize(controller_class, action_name, desc: nil, title: nil, versions: [], &block)
       @controller_class = controller_class
@@ -56,6 +57,12 @@ module ApiRegulator
       end
     end
 
+    def example(name, value, default: false)
+      @examples ||= {}
+      @examples[name] = { summary: "#{name} Example", value: value }
+      @default_example = value if default
+    end
+
     def path
       rails_route.path.spec.to_s
         .sub("(.:format)", "")   # Remove optional format

data/lib/api_regulator/open_api_generator.rb

@@ -75,7 +75,7 @@ module ApiRegulator
       params = api.params.select(&:body?)
       return {} if params.empty?
 
-      {
+      body = {
         required: true,
         content: {
           'application/json' => {
@@ -83,6 +83,9 @@ module ApiRegulator
           }
         }
       }
+
+      body[:content]['application/json'][:examples] = api.examples unless api.examples.blank?
+      body
     end
 
     def expand_nested_params(params)
@@ -137,8 +140,9 @@ module ApiRegulator
         generate_param_schema(param)
           .merge({
             name: param.name,
-            required: param.path? || param.required? || false
-          })
+            required: param.path? || param.required? || false,
+            examples: param.examples.presence
+          }).compact
       end
     end
 

data/lib/api_regulator/param.rb

@@ -12,6 +12,7 @@ module ApiRegulator
       @api = options.delete(:api)
       @allow_arbitrary_keys = options.delete(:allow_arbitrary_keys) || false
       @versions = Array(options.delete(:versions)).map(&:to_sym)
+      @examples = options.delete(:examples) || {}
 
       @children = []
       @options = options
@@ -151,5 +152,17 @@ module ApiRegulator
         type.to_s.downcase
       end
     end
+
+    def examples
+      return nil if @examples.blank?
+
+      @examples.each_with_object({}) do |(key, value), formatted_examples|
+        formatted_key = key.to_s.parameterize.underscore
+        formatted_examples[formatted_key] = {
+          summary: key.to_s,
+          value: value
+        }
+      end
+    end
   end
 end

data/lib/api_regulator/version.rb

@@ -1,3 +1,3 @@
 module ApiRegulator
-  VERSION = "0.1.25"
+  VERSION = "0.1.26"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-regulator
 version: !ruby/object:Gem::Version
-  version: 0.1.25
+  version: 0.1.26
 platform: ruby
 authors:
 - Geoff Massanek
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-07 00:00:00.000000000 Z
+date: 2025-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport