Zero Rails Openapi Versions Save

Concise DSL for generating OpenAPI Specification 3 (OAS3) JSON documentation for Ruby application.

v2.0.0

5 years ago

v1.6.0

5 years ago

Changed

  1. issue #21 support additionalProperties. Thanks @barnaclebarnes
  2. issue #23 Uniqueness of operationId. Thanks @barnaclebarnes

Fixed

  1. issue #22 missing / in reference. Thanks @barnaclebarnes

v1.5.9

5 years ago

Changed

  1. singular example in schema #17
  2. define multiple components blocks in one class #18

v1.5.7

6 years ago

Changed

  1. issue #16 DSL in base_doc_class can not be generated.

Fixed

  1. issue #15 colorize was not required.
  2. securitySchemes defined by config DSL was not be generated.

v1.5.6

6 years ago

Changed

  1. Upgrade loofah and rails-html-sanitizer cause XSS vulnerability.
  2. Refactor and document DSL for Rspec (spec_dsl.rb).

v1.5.5

6 years ago

Added

  1. Callback Object has been supported. (issue #12 @austbot)

Changed

  1. mk's parameter eq is changed to get. (dssl.rb)

v1.5.4

6 years ago

Thanks to @austbot, fix - colorize fails at runtime.

v1.5.2

6 years ago

Added

  1. do_* can be passed common schema after (or before) by:.
  2. when this action can be accessed through multiple HTTP methods (but not set through match), it also matches and generate both HTTP methods.

Changed

  1. root_controller => base_doc_class.
  2. ctrl_path => ctrl_base.
  3. apis_tag => doc_tag.
  4. @_ctrl_infos => @doc_info, @_api_infos => @api_info, @_apis_dry_blocks => @zro_dry_blocks.
  5. OpenApi.paths_index => OpenApi.routes_index.
  6. get_actions_by_ctrl_path => get_actions_by_route_base.
  7. Config.dft_file_format => Config.file_format.
  8. Modify the description of the test case (remove should).
  9. deep_merge! instead of _fusion.
  10. ApiInfoObj => ApiInfo.

v1.5.3

6 years ago

Added

  1. Colorize output.

Changed

  1. Refactoring SchemaObj and remove preprocess.
  2. schema_hash => schema_info.
  3. Refactoring process_objs .. dsl/ files.

Fixed

  1. max lth and min lth is reversed.

v1.5.1

6 years ago

[1.5.1 - 100% Test Coverage] - 2017/12/21 - view diff

Completed the test code (250+ examples), and make it 100% coverage.

Feature

  1. type: [String, Integer ..] will generate an array, which's items would be a oneOf combined schema.

Fixed:

  1. desc will override dry's.
  2. type: something is passed to schema_hash, but not type.
  3. Should not skip the params inside block.
  4. body_ref invalid.
  5. schema length's order is reversed.
  6. Example Obj ref.

Added:

  1. Use simplecov.
  2. CodeClimate test hook.
  3. Test's support.
  4. Designed RSpec matchers have_keys and have_size.
  5. Designed a set of RSpec's DSL (DSSL) for testing.

Changed:

  1. WILL NOT do recognize_is_options_in.
  2. instance_eval => instance_exec in dsl.rb.
  3. Guard Clause for generate_docs and where schema could be defined.
  4. Change signature of server in api.
  5. Simplify recursives.
  6. enum: { 'desc' => :enum1 } => enum!: { 'desc' => :enum1 }