swagger_api 0.2.8 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e9c5b528e467eb55401a356909631108989fc40
-  data.tar.gz: 92af23449557c3b49e38035c29cb73d15e606863
+  metadata.gz: 1cb3bbfda85e560abdea01543ed17e09a12dbbf4
+  data.tar.gz: 56c66db2c4a70c2ee4b134ab7da33d431d1ba973
 SHA512:
-  metadata.gz: 32ec574e9661dbf0b676d8ec7478e4ae90411327f94f7fc4ae6930f2c5c61ebbeb5e9504806a43693d16c8eed4f730202ee07aff562cb1c8e7e16fbc89e3bdea
-  data.tar.gz: f3e679d6c7cd6deb5455ef270a8fdd317527d0c08bdfe1a95da55a8314955f2492390ceb8f984ab481ad8c30198204b67f5b9dd61401940225f210041c0b4327
+  metadata.gz: 940cf5e6d78cd653bfa1c9e43aab10f54ed88c32c573b4a6d39dafb76a3b3d6022855dea3e2726faafff02cd8dd8dc1cdee6308c8dfda1c77557b66e3a3e7403
+  data.tar.gz: ac3a1b68c7ea692fc6926dc8d1e34523980554850583a2b73cc26f7c2971165b6eeb4bc4a759cb6a018c24720bdfa99b98ff48c47838a79a70625aad9904e406

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    swagger_api (0.2.6)
+    swagger_api (0.2.8)
       active_attr
       rails (>= 5.0)
       rspec-rails
@@ -192,4 +192,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.16.1
+   1.16.2

data/README.md

@@ -23,8 +23,56 @@ Or install it yourself as:
 Create a swagger.yml and place it in you gem directory (see swagger.yml in root directory for an example)
 
     $ bundle exec rake swagger:api
-    
-This will create 
+
+This will create
+
+## Format of swagger.yml
+
+```yaml
+info:
+  version: 0.0.1
+  title: FooService
+  description: Controls the CRUD of Foo
+servers: # List of your API endpoints
+  test: # Rails.env
+    url: https://foo.example.com/api/foobar
+controllers:
+  # This first format is the simplest and uses just the schema and validators to define the api
+  - name: FooController # controller class
+    model: Foo # model class associated with controller
+    actions: # Optional: field to define which actions this endpoint responds to
+      # the following two fields (only, except) are mutually exclusive. Choose one.
+      only:
+      - index
+      - update
+      except:
+      - update
+    columns: # Optional field to specify which params the api responds to. When using this specify at least one of the optional subfields.
+      # You must include at least one of the following 4 fields
+
+      # The following two fields (only, except) are mutually exclusive. Choose one.
+      only:
+      - column2
+      - column3
+      except:
+      - column3
+
+      virtual: # Defines virtual attributes. These do not exist in the associated model but are used by the controller.
+      - name: virtual1
+        schema:
+          type: integer
+          format: intg64
+          minimum: 1 # this field is only for integer types
+
+      required: # Defines additional fields as required even if there is not a validator associated with the field
+      - column4
+      - virtual1
+
+  - name: CustomsController
+    # Custom api json. You can use this gem to generate the base files from an existing model/controller and then modify as needed.
+    custom_model_file: api/custom_model.json
+    custom_path_file: api/custom_paths.json
+```
 
 ## Development
 

data/lib/swagger_api/component_schema.rb

@@ -9,7 +9,7 @@ module SwaggerApi
     def create
       {
         required: required,
-        properties: properties,
+        properties: properties.merge(virtual_properties),
         type: 'object'
       }
     end
@@ -51,6 +51,12 @@ module SwaggerApi
       end.compact.to_h
     end
 
+    def virtual_properties
+      (controller.try(:columns).try(:virtual) || []).map do |property|
+        [property.name, property.schema.to_h]
+      end.to_h
+    end
+
     def column_should_skip(column_name)
       column_name.end_with?('_iv') || absence_attributes.include?(column_name)
     end

data/lib/swagger_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SwaggerApi
-  VERSION = '0.2.8'
+  VERSION = '0.2.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger_api
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.2.9
 platform: ruby
 authors:
 - Full Measure Education
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-11 00:00:00.000000000 Z
+date: 2018-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler