Merge pull request #411 from Bugagazavr/add-options

Added support for OPTIONS endpoints
ruby-grape · May 6, 2016 · b7cdab9 · b7cdab9
2 parents 819fcc5 + d6ee3e9
commit b7cdab9
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@
 * [#406](https://github.com/ruby-grape/grape-swagger/pull/406): Force usage of entities for response definition [issue #385](https://github.com/ruby-grape/grape-swagger/issues/385) - [@LeFnord](https://github.com/LeFnord).
 * [#405](https://github.com/ruby-grape/grape-swagger/pull/405), [#403](https://github.com/ruby-grape/grape-swagger/issues/403): Added version support matrix - [@LeFnord](https://github.com/LeFnord).
 * [#408](https://github.com/ruby-grape/grape-swagger/pull/408): Added support for `HEAD` endpoints - [@Bugagazavr](https://github.com/Bugagazavr).
+* [#408](https://github.com/ruby-grape/grape-swagger/pull/411): Added support for `OPTIONS` endpoints - [@Bugagazavr](https://github.com/Bugagazavr).
 * [#407](https://github.com/ruby-grape/grape-swagger/issues/407): Added support for Grape 0.15.x - [@dblock](https://github.com/dblock).
 * Your contribution here.
 

diff --git a/lib/grape-swagger/doc_methods/status_codes.rb b/lib/grape-swagger/doc_methods/status_codes.rb
@@ -9,7 +9,8 @@ def get
             put: { code: 200, message: 'updated {item}' },
             patch: { code: 200, message: 'patched {item}' },
             delete: { code: 200, message: 'deleted {item}' },
-            head: { code: 200, message: 'head {item}' }
+            head: { code: 200, message: 'head {item}' },
+            options: { code: 200, message: 'option {item}' }
           }
         end
       end

diff --git a/spec/swagger_v2/simple_mounted_api_spec.rb b/spec/swagger_v2/simple_mounted_api_spec.rb
@@ -27,6 +27,10 @@ class SimpleMountedApi < Grape::API
         status 200
       end
 
+      options '/simple-options-test' do
+        status 200
+      end
+
       desc 'this gets something else',
            headers: {
              'XAuthToken' => { description: 'A required header.', required: true },
@@ -84,7 +88,14 @@ def app
         'swagger' => '2.0',
         'produces' => ['application/xml', 'application/json', 'application/octet-stream', 'text/plain'],
         'host' => 'example.org',
-        'tags' => [{ 'name' => 'simple', 'description' => 'Operations about simples' }, { 'name' => 'simple-test', 'description' => 'Operations about simple-tests' }, { 'name' => 'simple-head-test', 'description' => 'Operations about simple-head-tests' }, { 'name' => 'simple_with_headers', 'description' => 'Operations about simple_with_headers' }, { 'name' => 'items', 'description' => 'Operations about items' }, { 'name' => 'custom', 'description' => 'Operations about customs' }],
+        'tags' => [
+          { 'name' => 'simple', 'description' => 'Operations about simples' },
+          { 'name' => 'simple-test', 'description' => 'Operations about simple-tests' },
+          { 'name' => 'simple-head-test', 'description' => 'Operations about simple-head-tests' },
+          { 'name' => 'simple-options-test', 'description' => 'Operations about simple-options-tests' },
+          { 'name' => 'simple_with_headers', 'description' => 'Operations about simple_with_headers' },
+          { 'name' => 'items', 'description' => 'Operations about items' },
+          { 'name' => 'custom', 'description' => 'Operations about customs' }],
         'paths' => {
           '/simple' => {
             'get' => {
@@ -106,6 +117,12 @@ def app
               'responses' => { '200' => { 'description' => 'head SimpleHeadTest' } },
               'tags' => ['simple-head-test'],
               'operationId' => 'headSimpleHeadTest' } },
+          '/simple-options-test' => {
+            'options' => {
+              'produces' => ['application/json'],
+              'responses' => { '200' => { 'description' => 'option SimpleOptionsTest' } },
+              'tags' => ['simple-options-test'],
+              'operationId' => 'optionsSimpleOptionsTest' } },
           '/simple_with_headers' => {
             'get' => {
               'description' => 'this gets something else',
@@ -154,7 +171,14 @@ def app
         'swagger' => '2.0',
         'produces' => ['application/xml', 'application/json', 'application/octet-stream', 'text/plain'],
         'host' => 'example.org',
-        'tags' => [{ 'name' => 'simple', 'description' => 'Operations about simples' }, { 'name' => 'simple-test', 'description' => 'Operations about simple-tests' }, { 'name' => 'simple-head-test', 'description' => 'Operations about simple-head-tests' }, { 'name' => 'simple_with_headers', 'description' => 'Operations about simple_with_headers' }, { 'name' => 'items', 'description' => 'Operations about items' }, { 'name' => 'custom', 'description' => 'Operations about customs' }],
+        'tags' => [
+          { 'name' => 'simple', 'description' => 'Operations about simples' },
+          { 'name' => 'simple-test', 'description' => 'Operations about simple-tests' },
+          { 'name' => 'simple-head-test', 'description' => 'Operations about simple-head-tests' },
+          { 'name' => 'simple-options-test', 'description' => 'Operations about simple-options-tests' },
+          { 'name' => 'simple_with_headers', 'description' => 'Operations about simple_with_headers' },
+          { 'name' => 'items', 'description' => 'Operations about items' },
+          { 'name' => 'custom', 'description' => 'Operations about customs' }],
         'paths' => {
           '/simple' => {
             'get' => {
@@ -180,7 +204,14 @@ def app
           'swagger' => '2.0',
           'produces' => ['application/xml', 'application/json', 'application/octet-stream', 'text/plain'],
           'host' => 'example.org',
-          'tags' => [{ 'name' => 'simple', 'description' => 'Operations about simples' }, { 'name' => 'simple-test', 'description' => 'Operations about simple-tests' }, { 'name' => 'simple-head-test', 'description' => 'Operations about simple-head-tests' }, { 'name' => 'simple_with_headers', 'description' => 'Operations about simple_with_headers' }, { 'name' => 'items', 'description' => 'Operations about items' }, { 'name' => 'custom', 'description' => 'Operations about customs' }],
+          'tags' => [
+            { 'name' => 'simple', 'description' => 'Operations about simples' },
+            { 'name' => 'simple-test', 'description' => 'Operations about simple-tests' },
+            { 'name' => 'simple-head-test', 'description' => 'Operations about simple-head-tests' },
+            { 'name' => 'simple-options-test', 'description' => 'Operations about simple-options-tests' },
+            { 'name' => 'simple_with_headers', 'description' => 'Operations about simple_with_headers' },
+            { 'name' => 'items', 'description' => 'Operations about items' },
+            { 'name' => 'custom', 'description' => 'Operations about customs' }],
           'paths' => {
             '/simple-test' => {
               'get' => {