Zero-Rails_OpenApi 1.4.3 release!

[1.4.2 & 1.4.3] - 2017/12/11&13 - view diff

Feature

1. example method in components block.
2. Request Body (also Response):
   1. The same media-types will be fusion together.
      (This means you can write form separately.)
   2. Different media-types will not be replaced, all will be merged in content.
   3. Support flat statement form-data by data.

Fixed

1. generate_doc raise 'should not nil when merge' if settings[:components] not set.
2. @preprocessed not initialize warning.

Added

1. Schema option blankable.
2. Schema option alias in to enum.
3. Schema option pattern could be String for supporting Time Format.

Changed

1. form mandatory requirements pass data: { }.
2. Remove request_body's parameter desc to **options.
3. Remove aliases of response.

Zero-Rails_OpenApi 1.4.1 Release!

Feature

1. Pass a ActiveRecord class constant to the schema,
   it will automatically read the db schema to generate the component.

Fixed

1. Fix: Components defined in the controller overwrite the ones defined in the configuration.

Changed

1. Remove JBuilder automatic generator.
2. Refactoring based on CodeClimate.
3. Rename CtrlInfoObj to Components.

Added

1. Update README.
2. Add CHANGELOG.
3. doc_location can be configured.

Zero-Rails_OpenApi 1.4.0 Release!

Changes

1. Config.register_docs => Config.open_api_docs.
2. Config DSL api => open_api.
3. [IMPORTANT] DSL open_api => api.
4. Use module instance variables instead of global variables.
5. Is refactoring based on rubocop by hand.

New Feature

1. Support CombinedSchema, like one_of, any_of..
2. Authentication and Authorization DSL, for Defining Security Scheme and Applying Security.
3. The ability to identify multi-httpverbs.
4. Also support api :name, type: String.
   (You have to write this before api :name, String)
5. Support designated http method in api.
6. Fix controller's require question in generate_docs.
7. Support read files to get routes information. (Config.rails_routes_file)
8. The completion of the basic README.

View Diff

v1.3.3

1. Rewrote README.
2. order parameters.
3. examples for parameters.
4. Config DSl.

v1.3.2

1. Fix some bugs.
2. Sort the output.

v1.3.1

1. Refactoring based on bbatsov's and Airbnb's style guide, more readable.
2. Support response override by using override_response.
3. Separate apis_set into apis_tag and components.
4. Support simplify param DSL with do_* by: { } method.

v1.3.0

1. View files (Jbuilder ..) could be generated automatically by the template you specify.
2. Redesign Config module.
3. Let you decide to skip or use the parameters which define in api_dry.
4. Support auto generate responses type by reading schema of database(ActiveModel).

v1.2.0

1. More DRY support.
2. form 'for doing something', data: { }
3. Nested schema definition support in the type
4. Automatically generate description.
5. Fix some bugs.

v1.1.1

1. Fixed: Optimize the way to load application when initialize.
2. Feat: Support "write the DSL somewhere else" by using "ctrl_path".