wip swagger spec article_categories

spec/requests/api/article_categories_spec.rb

@@ -7,34 +7,79 @@ describe 'Article Categories', type: :request do
     get 'article categories' do
       tags 'Category'
       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!(:stock_article) { create(:stock_article) }
       let!(:stock_order_article) { create(:stock_order, article_ids: [stock_article.id]).order_articles.first }
 
-
       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: {
           article_categories: {
             type: :array,
             items: {
               '$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!
       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

spec/swagger_helper.rb

@@ -24,17 +24,15 @@ RSpec.configure do |config|
       paths: {},
       components: {
         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: {
             type: :object,