28_introduce_rswag #35

Merged
philipp merged 46 commits from 28_introduce_rswag into develop 2023-01-05 13:45:47 +01:00
2 changed files with 66 additions and 23 deletions
Showing only changes of commit 102e0e7ed6 - Show all commits

View file

@ -7,34 +7,79 @@ describe 'Article Categories', type: :request do
get 'article categories' do get 'article categories' do
tags 'Category' tags 'Category'
produces 'application/json' produces 'application/json'
parameter name: :page, in: :query, schema: { '$ref' => '#/components/schemas/page' } parameter name: "page[number]", in: :query, type: :integer, required: false
parameter name: :per_page, in: :query, schema: { '$ref' => '#/components/schemas/per_page' } parameter name: "page[size]", in: :query, type: :integer, required: false
let(:api_scopes) { ['orders:read'] }
let!(:order_article) { create(:order, article_count: 1).order_articles.first } let!(:order_article) { create(:order, article_count: 1).order_articles.first }
let!(:stock_article) { create(:stock_article) } let!(:stock_article) { create(:stock_article) }
let!(:stock_order_article) { create(:stock_order, article_ids: [stock_article.id]).order_articles.first } let!(:stock_order_article) { create(:stock_order, article_ids: [stock_article.id]).order_articles.first }
response '200', 'success' do response '200', 'success' do
schema type: :object, properties: {
meta: {
'$ref' => '#/components/schemas/pagination'
},
article_categories: {
type: :array,
items: {
'$ref': '#/components/schemas/ArticleCategory'
}
}
}
let(:page) { { number: 1, size: 20 } }
run_test!
end
it_handles_invalid_token
end
end
path '/article_categories/{id}' do
get 'Retrieves an article category' do
tags 'Category'
produces 'application/json'
parameter name: :id, in: :path, type: :string
response '200', 'article category found' do
schema type: :object, properties: { schema type: :object, properties: {
article_categories: { article_categories: {
type: :array, type: :array,
items: { items: {
'$ref': '#/components/schemas/ArticleCategory' '$ref': '#/components/schemas/ArticleCategory'
} }
},
meta: {
'$ref': '#/components/schemas/Meta'
} }
} }
let(:id) { ArticleCategory.create(name: 'dairy').id }
let(:page) { 0 }
let(:per_page) { 20 }
run_test! run_test!
end end
it_handles_invalid_token_and_scope response '401', 'not logged in' do
schema type: :object, properties: {
article_categories: {
type: :array,
items: {
'$ref': '#/components/schemas/ArticleCategory'
}
}
}
let(:Authorization) { 'abc' }
let(:id) { ArticleCategory.create(name: 'dairy').id }
run_test!
end
response '404', 'article category not found' do
schema type: :object, properties: {
article_categories: {
type: :array,
items: {
'$ref': '#/components/schemas/ArticleCategory'
}
}
}
let(:id) { 'invalid' }
run_test!
end
end end
end end
end end

View file

@ -24,17 +24,15 @@ RSpec.configure do |config|
paths: {}, paths: {},
components: { components: {
schemas: { schemas: {
page: { pagination: {
type: :integer, type: :object,
description: 'page number', properties: {
minimum: 0, recordCount: { type: :integer },
default: 0 pageCount: { type: :integer },
currentPage: { type: :integer },
pageSize: { type: :integer }
}, },
per_page: { required: %w(recordCount pageCount currentPage pageSize)
type: :integer,
description: 'items per page',
minimum: 0,
default: 20
}, },
ArticleCategory: { ArticleCategory: {
type: :object, type: :object,