From f0fba9c093e1790b4692eccff865dfb619677c41 Mon Sep 17 00:00:00 2001 From: Andrew Kofink Date: Mon, 8 Jun 2020 11:53:03 -0400 Subject: [PATCH] Update wording in gemspecs to include OpenAPI Fixes #333 Mentioning OpenAPI in the gemspec allows users on rubygems.org to find this gem easily. Those who are still looking for Swagger tools will also continue to find the gem, since I've mentioned that OpenAPI used to be called Swagger. Signed-off-by: Andrew Kofink --- rswag-api/rswag-api.gemspec | 4 ++-- rswag-specs/rswag-specs.gemspec | 4 ++-- rswag-ui/rswag-ui.gemspec | 4 ++-- rswag/rswag.gemspec | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/rswag-api/rswag-api.gemspec b/rswag-api/rswag-api.gemspec index e19a24a..850be0f 100644 --- a/rswag-api/rswag-api.gemspec +++ b/rswag-api/rswag-api.gemspec @@ -9,8 +9,8 @@ Gem::Specification.new do |s| s.authors = ['Richie Morris', 'Greg Myers', 'Jay Danielian'] s.email = ['domaindrivendev@gmail.com'] s.homepage = 'https://github.com/rswag/rswag' - s.summary = 'A Rails Engine that exposes Swagger files as JSON endpoints' - s.description = 'Open up your API to the phenomenal Swagger ecosystem by exposing Swagger files, that describe your service, as JSON endpoints' + s.summary = 'A Rails Engine that exposes OpenAPI (formerly called Swagger) files as JSON endpoints' + s.description = 'Open up your API to the phenomenal OpenAPI ecosystem by exposing OpenAPI files, that describe your service, as JSON endpoints. More about the OpenAPI initiative here: http://spec.openapis.org/' s.license = 'MIT' s.files = Dir['{lib}/**/*'] + ['MIT-LICENSE', 'Rakefile'] diff --git a/rswag-specs/rswag-specs.gemspec b/rswag-specs/rswag-specs.gemspec index 0f7dbc6..44f644b 100644 --- a/rswag-specs/rswag-specs.gemspec +++ b/rswag-specs/rswag-specs.gemspec @@ -9,8 +9,8 @@ Gem::Specification.new do |s| s.authors = ['Richie Morris', 'Greg Myers', 'Jay Danielian'] s.email = ['domaindrivendev@gmail.com'] s.homepage = 'https://github.com/rswag/rswag' - s.summary = 'A Swagger-based DSL for rspec-rails & accompanying rake task for generating Swagger files' - s.description = 'Simplify API integration testing with a succinct rspec DSL and generate Swagger files directly from your rspecs' + s.summary = 'An OpenAPI-based (formerly called Swagger) DSL for rspec-rails & accompanying rake task for generating OpenAPI specification files' + s.description = 'Simplify API integration testing with a succinct rspec DSL and generate OpenAPI specification files directly from your rspecs. More about the OpenAPI initiative here: http://spec.openapis.org/' s.license = 'MIT' s.files = Dir['{lib}/**/*'] + ['MIT-LICENSE', 'Rakefile'] diff --git a/rswag-ui/rswag-ui.gemspec b/rswag-ui/rswag-ui.gemspec index 97cf681..8643672 100644 --- a/rswag-ui/rswag-ui.gemspec +++ b/rswag-ui/rswag-ui.gemspec @@ -9,8 +9,8 @@ Gem::Specification.new do |s| s.authors = ['Richie Morris', 'Greg Myers', 'Jay Danielian'] s.email = ['domaindrivendev@gmail.com'] s.homepage = 'https://github.com/rswag/rswag' - s.summary = 'A Rails Engine that includes swagger-ui and powers it from configured Swagger endpoints' - s.description = 'Expose beautiful API documentation, powered by Swagger JSON endpoints, including a UI to explore and test operations' + s.summary = 'A Rails Engine that includes swagger-ui and powers it from configured OpenAPI (formerly named Swagger) endpoints' + s.description = 'Expose beautiful API documentation, powered by Swagger JSON endpoints, including a UI to explore and test operations. More about the OpenAPI initiative here: http://spec.openapis.org/' s.license = 'MIT' s.files = Dir.glob('{lib,node_modules}/**/*') + ['MIT-LICENSE', 'Rakefile' ] diff --git a/rswag/rswag.gemspec b/rswag/rswag.gemspec index edf341f..8a69f55 100644 --- a/rswag/rswag.gemspec +++ b/rswag/rswag.gemspec @@ -9,8 +9,8 @@ Gem::Specification.new do |s| s.authors = ['Richie Morris', 'Greg Myers', 'Jay Danielian'] s.email = ['domaindrivendev@gmail.com'] s.homepage = 'https://github.com/rswag/rswag' - s.summary = 'Swagger tooling for Rails APIs' - s.description = 'Generate beautiful API documentation, including a UI to explore and test operations, directly from your rspec integration tests' + s.summary = 'OpenAPI (formerly named Swagger) tooling for Rails APIs' + s.description = 'Generate beautiful API documentation, including a UI to explore and test operations, directly from your rspec integration tests. OpenAPI 2 and 3 supported. More about the OpenAPI initiative here: http://spec.openapis.org/' s.license = 'MIT' s.files = Dir['{lib}/**/*'] + [ 'MIT-LICENSE' ]