rspec_api_documentation-open_api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fab416f868a74ddb07866e0e7d17913c7c56f4697b1a35bb363f1c591641a42c
-  data.tar.gz: 5f0b5cfe8472d44f3e6d300f57f6c47cab1202a52ad9d8911e33ed969652ba04
+  metadata.gz: 8c7c05a5783d583a175dce72a50e2b20ee2bc267f0061607d1d27138c7796240
+  data.tar.gz: 2cdf8135cdb8db72ced74d6ca6d07a7feec63cf5d2ed6b338f6fd0a823d496ff
 SHA512:
-  metadata.gz: 44cba9fa46feace13862d58a5ba9062e2cdfae62fdc9012c1cde31eea31b87052b11a3154dea737027f4d8a9b452a88a521d562fd32ec4b5de5582d0b1c7af5f
-  data.tar.gz: 2c4c594c94e8e7539d9f8299b8be2bdd53626970607ef049aed6cfb905705714157f1785a747b45e41d81420d8e0f955995e12bb6010285b38099e71dad6c9c9
+  metadata.gz: c7eb930e06a697d4e9de7ca97edbc0a632782c76bfe562a80693f82c4ce77f0bf16ebe7ac61465e9190578c79139fa755509043b5d4999d9d9e4f290f446e87a
+  data.tar.gz: 38d23559d1035da50fd4ea9c9c3c75d3eff2d1044cb0ec0c4e6506a9e8d373d4e9678a2da4e71a8fa4793cc4c6e068121a1173fe667a592eed0079f2db2ac5c1

data/README.md

@@ -35,6 +35,33 @@ RspecApiDocumentation.configure do |config|
 end
 ```
 
+Change default host and servers spec using
+```
+RspecApiDocumentation.configure do |config| # These are defaults
+  config.open_api = {
+    "host": {
+      "version" => "1.0.0",
+      "title" => "Open API",
+      "description" => "Open API",
+      "contact" => {
+        "name" => "OpenAPI"
+      }
+    },
+    "servers": [
+      {
+        "url" => "http://localhost:{port}",
+        "description" => "Development server",
+        "variables" => {
+          "port" => {
+            "default" => "3000"
+          }
+        }
+      }
+    ]
+  }
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/rspec_api_documentation/open_api/version.rb

@@ -1,5 +1,5 @@
 module RspecApiDocumentation
   module OpenApi
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/rspec_api_documentation/writers/open_api_writer.rb

@@ -221,39 +221,8 @@ module RspecApiDocumentation
       def swagger
         @swagger ||= {
           "openapi" => "3.0.0",
-          "info" => {
-            "version" => "1.0.0",
-            "title" => "Cookpad Global Web API",
-            "description" => "Cookpad's global web API",
-            "contact" => {
-              "name" => "Aaditya Taparia",
-              "email" => "aaditya-taparia@gmail.com",
-              "url" => "https://github.com/aadityataparia"
-            }
-          },
-          "servers" => [
-            {
-              "url" => "http://localhost:{port}/{version}",
-              "description" => "Development server",
-              "variables" => {
-                "version" => {
-                  "default" => "v4"
-                },
-                "port" => {
-                  "default" => "3000"
-                }
-              }
-            },
-            {
-              "url" => "https://global-search-api-staging.ckpd.co/{version}",
-              "description" => "Staging server",
-              "variables" => {
-                "version" => {
-                  "default" => "v4"
-                }
-              }
-            }
-          ],
+          "info" => info,
+          "servers" => servers,
           "paths" => {},
           "components" => {
             "securitySchemes" => {
@@ -270,6 +239,31 @@ module RspecApiDocumentation
           }
         }
       end
+
+      def info
+        RspecApiDocumentation.configuration.open_api&["host"] || {
+          "version" => "1.0.0",
+          "title" => "Open API",
+          "description" => "Open API",
+          "contact" => {
+            "name" => "OpenAPI"
+          }
+        }
+      end
+
+      def servers
+        RspecApiDocumentation.configuration.open_api&["server"] || [
+          {
+            "url" => "http://localhost:{port}",
+            "description" => "Development server",
+            "variables" => {
+              "port" => {
+                "default" => "3000"
+              }
+            }
+          }
+        ]
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec_api_documentation-open_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Aaditya Taparia