swagger_yard 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92fee53b6f39a4a44e733619571d5c051054df3e7721058b50d6f18654898d73
-  data.tar.gz: 93e2c4acd9fb8c523a39c916257e41a5c6426e5033439f814223d91397317606
+  metadata.gz: 503b5e749f9f3e40431798185264f5d830923d1117eaf19e53ffa4069b4db54e
+  data.tar.gz: 748debe18cb7958200d2e690ab7b6e0b36ef153bfcdb48c5283bb0687ba57246
 SHA512:
-  metadata.gz: 23e2f8c39bdaf2a8009dc7f78b4a8f589da25737fa4cb3e77ab89395abe84459a52106d85aa026b533bbefdfe646cfa9c7fc7d9ede512be5edd4e242ada164ba
-  data.tar.gz: b893eddf59099d0fc2cba25486d5e7b2073b2386d3e0805addf7f7d2b280ccdd165038cd5323ab5315ecd8ac7a5ad07b0b6541471c6c14f7ff5890309de313cf
+  metadata.gz: ace4ee34ecfa50bb06376789fed0770f52c7c58367452db1f701a69a29564c2a609c5d07b51d571c796f5820a80453f0382b81821bcb525bfa48cdf707195599
+  data.tar.gz: e7aa50665d8d8ef371414e885bce55986819be74fe782e4576b8d1c129539f7638c6c3767f85d56ec3ff8919c4d45d42d8162ae162514723b02de60d46e39614

data/README.md

@@ -32,6 +32,11 @@ Place configuration in a Rails initializer or suitable configuration file:
 
       # Where to find models (can be an array)
       config.model_path = ::Rails.root + 'app/decorators/**/*'
+
+      # Whether to include controller methods marked as private
+	  # (either with ruby `private` or YARD `# @visibility private`
+	  # Default: true
+	  config.include_private = true
     end
 
 Then start to annotate controllers and models as described below.
@@ -108,6 +113,18 @@ class Accounts::OwnershipsController < ActionController::Base
 end
 ```
 
+#### Private controllers/actions
+
+When you set `include_private = false` in the SwaggerYard configuration, you can mark action methods as private, so that they won't be documented, using `@visibility private` in comments.
+
+```ruby
+  ##
+  # @visibility private
+  def show
+  end
+```
+
+
 ### Model ###
 
 Each model to be exposed in the specification must have a `@model` tag. Model properties are specified with `@property` tags. JSON Schema `additionalProperties` can be specified with `@additional_properties <type>` where `<type>` is any type defined elsewhere, or simply `false` to denote a closed model (`additionalProperties: false`).

data/lib/swagger_yard/api_group.rb

@@ -49,6 +49,8 @@ module SwaggerYard
     end
 
     def add_yard_object(yard_object)
+      return self if yard_object.visibility == :private && !SwaggerYard.config.include_private
+
       case yard_object.type
       when :class # controller
         add_info(yard_object)

data/lib/swagger_yard/configuration.rb

@@ -6,6 +6,7 @@ module SwaggerYard
     attr_accessor :controller_path, :model_path
     attr_accessor :path_discovery_function
     attr_accessor :security_definitions
+    attr_accessor :include_private
 
     # openapi-compatible names
     alias openapi_version swagger_version
@@ -20,6 +21,7 @@ module SwaggerYard
       @description = "Configure description with SwaggerYard.config.description"
       @security_definitions = {}
       @external_schema = {}
+      @include_private = true
     end
 
     def external_schema(mappings = nil)

data/lib/swagger_yard/version.rb

@@ -1,3 +1,3 @@
 module SwaggerYard
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger_yard
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - chtrinh (Chris Trinh)
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-27 00:00:00.000000000 Z
+date: 2021-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard