From 67075162035fa6089c44d00df09acb749a649da1 Mon Sep 17 00:00:00 2001 From: Maikel Linke Date: Thu, 23 Jan 2025 12:44:37 +1100 Subject: [PATCH] Automatically document responses for DFC API w/o tag --- engines/dfc_provider/spec/requests/addresses_spec.rb | 2 +- .../dfc_provider/spec/requests/affiliate_sales_data_spec.rb | 2 +- engines/dfc_provider/spec/requests/catalog_items_spec.rb | 3 +-- .../spec/requests/enterprise_groups/affiliated_by_spec.rb | 3 +-- engines/dfc_provider/spec/requests/enterprise_groups_spec.rb | 2 +- engines/dfc_provider/spec/requests/enterprises_spec.rb | 2 +- engines/dfc_provider/spec/requests/offers_spec.rb | 2 +- engines/dfc_provider/spec/requests/persons_spec.rb | 2 +- engines/dfc_provider/spec/requests/product_groups_spec.rb | 2 +- engines/dfc_provider/spec/requests/social_medias_spec.rb | 2 +- engines/dfc_provider/spec/requests/supplied_products_spec.rb | 2 +- spec/swagger_helper.rb | 2 +- 12 files changed, 12 insertions(+), 14 deletions(-) diff --git a/engines/dfc_provider/spec/requests/addresses_spec.rb b/engines/dfc_provider/spec/requests/addresses_spec.rb index 9e8693b03c..7c06914078 100644 --- a/engines/dfc_provider/spec/requests/addresses_spec.rb +++ b/engines/dfc_provider/spec/requests/addresses_spec.rb @@ -2,7 +2,7 @@ require_relative "../swagger_helper" -RSpec.describe "Addresses", type: :request, swagger_doc: "dfc.yaml", rswag_autodoc: true do +RSpec.describe "Addresses", type: :request, swagger_doc: "dfc.yaml" do let(:user) { create(:oidc_user) } let(:address) { create(:address, id: 40_000) } let(:result) { json_response } diff --git a/engines/dfc_provider/spec/requests/affiliate_sales_data_spec.rb b/engines/dfc_provider/spec/requests/affiliate_sales_data_spec.rb index e3ca35e8ad..6e736fbaae 100644 --- a/engines/dfc_provider/spec/requests/affiliate_sales_data_spec.rb +++ b/engines/dfc_provider/spec/requests/affiliate_sales_data_spec.rb @@ -2,7 +2,7 @@ require_relative "../swagger_helper" -RSpec.describe "AffiliateSalesData", swagger_doc: "dfc.yaml", rswag_autodoc: true do +RSpec.describe "AffiliateSalesData", swagger_doc: "dfc.yaml" do let(:user) { create(:oidc_user) } before { login_as user } diff --git a/engines/dfc_provider/spec/requests/catalog_items_spec.rb b/engines/dfc_provider/spec/requests/catalog_items_spec.rb index 03e1ba468a..a48f6c0eba 100644 --- a/engines/dfc_provider/spec/requests/catalog_items_spec.rb +++ b/engines/dfc_provider/spec/requests/catalog_items_spec.rb @@ -2,8 +2,7 @@ require_relative "../swagger_helper" -RSpec.describe "CatalogItems", type: :request, swagger_doc: "dfc.yaml", - rswag_autodoc: true do +RSpec.describe "CatalogItems", type: :request, swagger_doc: "dfc.yaml" do let(:user) { create(:oidc_user, id: 12_345) } let(:enterprise) { create( diff --git a/engines/dfc_provider/spec/requests/enterprise_groups/affiliated_by_spec.rb b/engines/dfc_provider/spec/requests/enterprise_groups/affiliated_by_spec.rb index fdee727fa8..e6ef549213 100644 --- a/engines/dfc_provider/spec/requests/enterprise_groups/affiliated_by_spec.rb +++ b/engines/dfc_provider/spec/requests/enterprise_groups/affiliated_by_spec.rb @@ -2,8 +2,7 @@ require_relative "../../swagger_helper" -RSpec.describe "EnterpriseGroups::AffiliatedBy", type: :request, swagger_doc: "dfc.yaml", - rswag_autodoc: true do +RSpec.describe "EnterpriseGroups::AffiliatedBy", type: :request, swagger_doc: "dfc.yaml" do let(:user) { create(:oidc_user, id: 12_345) } let(:group) { create( diff --git a/engines/dfc_provider/spec/requests/enterprise_groups_spec.rb b/engines/dfc_provider/spec/requests/enterprise_groups_spec.rb index 8b3f161893..4836a689f5 100644 --- a/engines/dfc_provider/spec/requests/enterprise_groups_spec.rb +++ b/engines/dfc_provider/spec/requests/enterprise_groups_spec.rb @@ -2,7 +2,7 @@ require_relative "../swagger_helper" -RSpec.describe "EnterpriseGroups", type: :request, swagger_doc: "dfc.yaml", rswag_autodoc: true do +RSpec.describe "EnterpriseGroups", type: :request, swagger_doc: "dfc.yaml" do let(:user) { create(:oidc_user, id: 12_345) } let(:group) { create( diff --git a/engines/dfc_provider/spec/requests/enterprises_spec.rb b/engines/dfc_provider/spec/requests/enterprises_spec.rb index 13c9f249be..254d04fc11 100644 --- a/engines/dfc_provider/spec/requests/enterprises_spec.rb +++ b/engines/dfc_provider/spec/requests/enterprises_spec.rb @@ -2,7 +2,7 @@ require_relative "../swagger_helper" -RSpec.describe "Enterprises", type: :request, swagger_doc: "dfc.yaml", rswag_autodoc: true do +RSpec.describe "Enterprises", type: :request, swagger_doc: "dfc.yaml" do let!(:user) { create(:oidc_user) } let!(:enterprise) do create( diff --git a/engines/dfc_provider/spec/requests/offers_spec.rb b/engines/dfc_provider/spec/requests/offers_spec.rb index 20c0780489..8e3ffe8dab 100644 --- a/engines/dfc_provider/spec/requests/offers_spec.rb +++ b/engines/dfc_provider/spec/requests/offers_spec.rb @@ -2,7 +2,7 @@ require_relative "../swagger_helper" -RSpec.describe "Offers", type: :request, swagger_doc: "dfc.yaml", rswag_autodoc: true do +RSpec.describe "Offers", type: :request, swagger_doc: "dfc.yaml" do let!(:user) { create(:oidc_user) } let!(:enterprise) { create(:distributor_enterprise, id: 10_000, owner: user) } let!(:product) { diff --git a/engines/dfc_provider/spec/requests/persons_spec.rb b/engines/dfc_provider/spec/requests/persons_spec.rb index a7ef52c0c4..c6379affd7 100644 --- a/engines/dfc_provider/spec/requests/persons_spec.rb +++ b/engines/dfc_provider/spec/requests/persons_spec.rb @@ -2,7 +2,7 @@ require_relative "../swagger_helper" -RSpec.describe "Persons", type: :request, swagger_doc: "dfc.yaml", rswag_autodoc: true do +RSpec.describe "Persons", type: :request, swagger_doc: "dfc.yaml" do let(:user) { create(:oidc_user, id: 10_000) } let(:other_user) { create(:oidc_user) } diff --git a/engines/dfc_provider/spec/requests/product_groups_spec.rb b/engines/dfc_provider/spec/requests/product_groups_spec.rb index b3d1f3dbff..56aab98377 100644 --- a/engines/dfc_provider/spec/requests/product_groups_spec.rb +++ b/engines/dfc_provider/spec/requests/product_groups_spec.rb @@ -2,7 +2,7 @@ require_relative "../swagger_helper" -RSpec.describe "ProductGroups", swagger_doc: "dfc.yaml", rswag_autodoc: true do +RSpec.describe "ProductGroups", swagger_doc: "dfc.yaml" do let!(:user) { create(:oidc_user) } let!(:enterprise) { create(:distributor_enterprise, id: 10_000, owner: user) } let!(:product) { diff --git a/engines/dfc_provider/spec/requests/social_medias_spec.rb b/engines/dfc_provider/spec/requests/social_medias_spec.rb index 71e7bfdbee..32c479f593 100644 --- a/engines/dfc_provider/spec/requests/social_medias_spec.rb +++ b/engines/dfc_provider/spec/requests/social_medias_spec.rb @@ -2,7 +2,7 @@ require_relative "../swagger_helper" -RSpec.describe "SocialMedias", type: :request, swagger_doc: "dfc.yaml", rswag_autodoc: true do +RSpec.describe "SocialMedias", type: :request, swagger_doc: "dfc.yaml" do let(:user) { create(:oidc_user) } let(:enterprise) do create( diff --git a/engines/dfc_provider/spec/requests/supplied_products_spec.rb b/engines/dfc_provider/spec/requests/supplied_products_spec.rb index b16c6bb6e5..2f7855d20d 100644 --- a/engines/dfc_provider/spec/requests/supplied_products_spec.rb +++ b/engines/dfc_provider/spec/requests/supplied_products_spec.rb @@ -2,7 +2,7 @@ require_relative "../swagger_helper" -RSpec.describe "SuppliedProducts", type: :request, swagger_doc: "dfc.yaml", rswag_autodoc: true do +RSpec.describe "SuppliedProducts", type: :request, swagger_doc: "dfc.yaml" do let!(:user) { create(:oidc_user) } let!(:enterprise) { create(:distributor_enterprise, id: 10_000, owner: user) } let!(:product) { diff --git a/spec/swagger_helper.rb b/spec/swagger_helper.rb index 1e44212f11..28dbd93d0d 100644 --- a/spec/swagger_helper.rb +++ b/spec/swagger_helper.rb @@ -74,7 +74,7 @@ RSpec.configure do |config| # Take example responses from Rswag specs for API documentation. # https://github.com/rswag/rswag#enable-auto-generation-examples-from-responses - config.after(:each, :rswag_autodoc) do |example| + config.after(:each, swagger_doc: "dfc.yaml") do |example| # Categories and group operations of the same API endpoint. example.metadata[:operation][:tags] ||= [self.class.top_level_description]