Merge pull request #1831 from fotos/support-security-in-desc-block

Support security in desc block

Author: dblock

CHANGELOG.md

@@ -7,6 +7,7 @@
 #### Fixes
 
 * Your contribution here.
+* [#1831](https://github.com/ruby-grape/grape/pull/1831): Support security in desc block - [@fotos](https://github.com/fotos).
 * [#1830](https://github.com/ruby-grape/grape/pull/1830): Restores self_sanity addresses #1829 - [@myxoh](https://github.com/myxoh).
 
 ### 1.2.1 (2018/11/28)

lib/grape/dsl/desc.rb

@@ -4,12 +4,12 @@ module Desc
       include Grape::DSL::Settings
 
       # Add a description to the next namespace or function.
-      # @option options :summary [String] summary for this endpoint
       # @param description [String] descriptive string for this endpoint
       #   or namespace
       # @param options [Hash] other properties you can set to describe the
       #   endpoint or namespace. Optional.
       # @option options :detail [String] additional detail about this endpoint
+      # @option options :summary [String] summary for this endpoint
       # @option options :params [Hash] param types and info. normally, you set
       #   these via the `params` dsl method.
       # @option options :entity [Grape::Entity] the entity returned upon a
@@ -24,6 +24,7 @@ module Desc
       # @option options :nickname [String] nickname of the endpoint
       # @option options :produces [Array[String]] a list of MIME types the endpoint produce
       # @option options :consumes [Array[String]] a list of MIME types the endpoint consume
+      # @option options :security [Array[Hash]] a list of security schemes
       # @option options :tags [Array[String]] a list of tags
       # @yield a block yielding an instance context with methods mapping to
       #   each of the above, except that :entity is also aliased as #success
@@ -100,6 +101,7 @@ def desc_container
             :nickname,
             :produces,
             :consumes,
+            :security,
             :tags
           )
 

spec/grape/dsl/desc_spec.rb

@@ -28,21 +28,24 @@ class Dummy
             entity: Object,
             http_codes: [[401, 'Unauthorized', 'Entities::Error']],
             named: 'My named route',
-            headers: [XAuthToken: {
-              description: 'Valdates your identity',
-              required: true
-            },
-                      XOptionalHeader: {
-                        description: 'Not really needed',
-                        required: false
-                      }],
+            headers: [
+              XAuthToken: {
+                description: 'Valdates your identity',
+                required: true
+              },
+              XOptionalHeader: {
+                description: 'Not really needed',
+                required: false
+              }
+            ],
             hidden: false,
             deprecated: false,
             is_array: true,
             nickname: 'nickname',
             produces: %w[array of mime_types],
             consumes: %w[array of mime_types],
-            tags: %w[tag1 tag2]
+            tags: %w[tag1 tag2],
+            security: %w[array of security schemes]
           }
 
           subject.desc 'The description' do
@@ -52,21 +55,24 @@ class Dummy
             success Object
             failure [[401, 'Unauthorized', 'Entities::Error']]
             named 'My named route'
-            headers [XAuthToken: {
-              description: 'Valdates your identity',
-              required: true
-            },
-                     XOptionalHeader: {
-                       description: 'Not really needed',
-                       required: false
-                     }]
+            headers [
+              XAuthToken: {
+                description: 'Valdates your identity',
+                required: true
+              },
+              XOptionalHeader: {
+                description: 'Not really needed',
+                required: false
+              }
+            ]
             hidden false
             deprecated false
             is_array true
             nickname 'nickname'
             produces %w[array of mime_types]
             consumes %w[array of mime_types]
             tags %w[tag1 tag2]
+            security %w[array of security schemes]
           end
 
           expect(subject.namespace_setting(:description)).to eq(expected_options)