October 22, 2017


OpenAPI Support

OpenAPI 3.0

  • New Features

    • New RepreZen Project Wizard now allows you to create new OpenAPI v3 specs complete with GenTargets.

    • Directly from the Dashboard: OpenAPI v3 specs can be created directly from the dashboard.
    • Code assist for callbacks. Added code assist for callbacks to new contexts.
    • Customizable code templates. Users can customize existing OAS3 code templates, or define new templates, using the new Code Templates preferences page. This feature already existed for Swagger-OpenAPI v2 and is now supported for OpenAPI v3.
  • Improvements
    • More accurate validation of the operationRef property in Link Object. Now raises a validation.
    • Validate securitySchemeName scope values. Values for the securitySchemeName property of the Security Requirement object now validated.
    • Improved validation of the 'required' property in Schema Objects. Only properties that actually exist in the schema are allowed to be used as “required”.
    • Improved validation for Schema#type. Null value is not allowed, but “null” (quoted) is OK.
  • Bug Fixes
    • Live Doc View rendering error. Live doc view no longer gives rendering error if spec contains examples.
    • Duplicates in required property lists in Swagger models generated from RAPID-ML when running multiple GenTargets at once.
    • References to path items were not treated correctly. Fixed bugs in the $ref references to pathItems containing parameters.
    • Validation accuracy: More accurate validation of object type of the operationId property in Link Object. Only operation elements are allowed now.
    • Code assist for response code creates invalid value. Code assist now provides HTTP status codes with descriptions.
    • Code template for schema for with required property inserted at wrong indent level.

OpenAPI 2.0

  • New Features
  • Improvements
  • Bug Fixes
    • Swagger UI v3 GenTemplate no longer adds extraneous methods under the default tag for Swagger v2 models. 

OpenAPI 2.0 & 3.0

  • New Features
  • Improvements
    • Code assist proposals. Code assist now provides more descriptive proposals for user-named  elements such as schema, parameters, links, callbacks, and other components. And named schema definitions can now use schema templates.
    • Hyperlink navigation on Link#operationId and Link#operationRef:
      • Ctrl+click (Command+click on Mac) on Link#operationId or Link#operationRef navigates to the referenced operation definition. 
      • Ctrl+click (Command+click on Mac) on Operation#securityScheme navigates to the referenced security scheme definition.
    • Code assist provides HTTP Status codes with descriptions.
    • KaiZen Editor now validates external references to ensure that they resolve to an object of the expected type.
    • Code assist for media types. Code assist provide a selection of most commonly used media types.
    • Rebranding: As a part of rebranding SwagEdit to KaiZen OpenAPI Editor we replaced all GUI items including error messages with KaiZen OpenAPI Editor.
    • Improved validation and code assist for parameter#in. Validation now checks for valid values and code assist offers valid values.
  • Bug Fixes
    • Dependency on KaiZen OpenAPI Parser (KZOP) was stated incorrectly. This allowed incompatible later releases of that project to be used. A specific version is now required until such time as the KZOP project adopts semantic versioning so that version ranges can be used.

RAPID-ML Support

  • New Features
    • New Node.js code generator (GenTemplate) added.
  • Improvements
    • Data structures can now extend structures from imported models using fully qualified names, including model aliases.
    • Live Swagger-UI View shows more details.
    • Link Descriptor code template names fixed and now easier to find.
  • Bug Fixes


  • New Features
  • Improvements
    • Difference highlighting. Was black on black :-( Now grey on black :-)
  • Bug Fixes
    • Large projects cause performance problems. Projects with thousands of files (e.g. node modules) no longer cause performance problems. (Fixed algorithm for determining content of GenTargets menu depending on current Project view selection.)
    • Fixed installation failure when API Studio was installed into an Eclipse IDE that already has KaiZen OpenAPI Editor.