Automatically document responses for DFC API w/o tag

This commit is contained in:
Maikel Linke
2025-01-23 12:44:37 +11:00
parent 42b6ecbf31
commit 6707516203
12 changed files with 12 additions and 14 deletions

View File

@@ -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 }

View File

@@ -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 }

View File

@@ -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(

View File

@@ -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(

View File

@@ -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(

View File

@@ -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(

View File

@@ -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) {

View File

@@ -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) }

View File

@@ -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) {

View File

@@ -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(

View File

@@ -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) {

View File

@@ -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]