Skip to content

Latest commit

 

History

History
227 lines (183 loc) · 17 KB

CHANGELOG.md

File metadata and controls

227 lines (183 loc) · 17 KB
Raw

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

6.1.0 (2020-03-17)

Features

  • adding an option to set OAuth client ID / secret (391bba1)
  • adding experimental rearrangeEndpoints property (692c21f)

Bug Fixes

  • adding swagger match to API file search (75208a4)
  • fixed scrolling in APIC app (58610bd)
  • fixes APIC-291 - navigation animation when bootstraping (c564eff)
  • Fixes linking (fe17856)
  • fixing __amfChanged function by calling super class (34fb6aa)
  • fixing APIC-260 - CM editor rendered above opened nav drawer (4876283)
  • fixing click handler on the "back" button (7ca40a7)
  • fixing input width issue for multipart form (f15b029)
  • fixing recognizing swagger spec version (e34740d)
  • removing this.app from function call (f9cdf5d)

6.0.0 (2020-01-15)

  • Upgrade to final web components specification: replacing HTML imports with JavaScript modules
  • Replacing Polymer with super lightweight, almost native, LitElement. This triggers a series of changes:
    • All dash-case attributes are now "no-dash", lowercase, web style attributes. For example old redirect-uri is now redirecturi. This is true for all properties used as HTML attribute. Properties names are the same.
    • New templating engine. API Console now uses lit-html which is performant HTML templating system.
    • Build process will be completely different. It is not yet ready, stay tuned.
  • Redesigned base input controls. API console now uses own, material design based, basic UI input controls. It comes with 3 predefined styles:
    • Default - Material design filled style
    • Outlined - Material design outlined state controlled by outlined style
    • Anypoint - Compatibility layer with the Anypoint platform. Controlled by compatibility attribute
  • The request panel (aka try it) now only renders editors that corresponds to the API data model. This means that, for example, if headers are not defined for given operation then headers panel is not rendered.
  • Dropped support for tabs view for the editors in the request panel and they are stacked now.
  • Code mirror dependency requires some additional libraries that won't work inside JavaScript module. This means that those libraries have to be included into the web application before initializing the element. See Code Mirror changes section below
  • API Console is now WCAG compliant. All components used to build the console passed axe-core tests and therefore are fully accessible.
  • The application and the component are now split into separate components. Use api-console for embedding the console inside existing web application and api-console-app for creating stand alone application.
  • New demo pages. Preview the console with npm start command (run inside cloned repository) to see API console with various scenarios and configuration options.
  • Removed any reference to CSS mixins (the @apply function). All styling options are now defined via CSS variables. Any styles defined for previous version of API console won't work.
  • Minimised use of icons in favour of regular buttons with labels.
  • This release contains tones of bug fixes and improvements reported by the community and our customers ❤
  • The Chrome proxy extension banner is not rendered by default. Set allowExtensionBanner property to initialize the console with the extension support.
  • Added configuration option to set a static OAuth 2 client ID and secret for the application. This way it is easier to demo an API by providing demo client id.
  • Added markdown sanitization
  • Now XML schemas and examples are propertly rendered.
  • Huge XML schemas are now not syntax highlighted (above 10K characters) as it causes the browser to hang.
  • XML examples are now properly formatted and RAML type name is properly resolved (instead of <model> element)

Try this version of API console with your API and report an issue if anything is out of ordinary. We and the rest of the community will be grateful.

Known issues

  • OAS' API Key authorization is not supported.
  • RAML's queryString property is not supported in documentation and try it.
  • XML serialization sometimes includes unexpected elements (amf_inline_type_*)
  • Sometimes types are duplicated in navigation
  • When endpoints in the API spec are out of order the navigation renders them incorrectly
  • Complext annotations (multiple properties with values) are not correctly rendered
  • RAML's regexp propertires of a type are not supported
  • The console is unable to generate examples other that JSON/XML

Code Mirror changes

Note, the request panel won't run without this dependencies.

Code mirror is not ES6 ready. Their build contains AMD exports which is incompatible with native modules. Therefore the dependencies cannot be imported with the element but outside of it. The component requires the following scripts to be ready before it's initialized (especially body and headers editors):

<script src="node_modules/jsonlint/lib/jsonlint.js"></script>
<script src="node_modules/codemirror/lib/codemirror.js"></script>
<script src="node_modules/codemirror/addon/mode/loadmode.js"></script>
<script src="node_modules/codemirror/mode/meta.js"></script>
<!-- Some basic syntax highlighting -->
<script src="node_modules/codemirror/mode/javascript/javascript.js"></script>
<script src="node_modules/codemirror/mode/xml/xml.js"></script>
<script src="node_modules/codemirror/mode/htmlmixed/htmlmixed.js"></script>
<script src="node_modules/codemirror/addon/lint/lint.js"></script>
<script src="node_modules/codemirror/addon/lint/json-lint.js"></script>

CodeMirror's modes location. May be skipped if all possible modes are already included into the app.

<script>
/* global CodeMirror */
CodeMirror.modeURL = 'node_modules/codemirror/mode/%N/%N.js';
</script>

You may want to add this dependencies to your build configuration to include it into the bundle.

Dependencies for OAuth1 and Digest authorization methods

For the same reasons as for CodeMirror this dependencies are required for OAuth1 and Digest authorization panels to work.

<script src="node_modules/cryptojslib/components/core.js"></script>
<script src="node_modules/cryptojslib/rollups/sha1.js"></script>
<script src="node_modules/cryptojslib/components/enc-base64-min.js"></script>
<script src="node_modules/cryptojslib/rollups/md5.js"></script>
<script src="node_modules/cryptojslib/rollups/hmac-sha1.js"></script>
<script src="node_modules/jsrsasign/lib/jsrsasign-rsa-min.js"></script>

chore

  • chore: adding AMF v4 demo model for tests (3dd7512)
  • chore: adding ANypoiont and dark theme demo (3bf1592)
  • chore: adding application ready element (8fa2822)
  • chore: adding default valuer for allowHideOptional in app (aacad3a)
  • chore: adding demo build configuration (a87e416)
  • chore: adding demo server with API file upload (bea76e1)
  • chore: adding engine version for sonar scaner to fix reported issue (e73d381)
  • chore: adding issue related API (78acb8a)
  • chore: adding issue related API example (daabc15)
  • chore: adding path information to the hostory state (508fe6b)
  • chore: adding SE related demo API (7c3e926)
  • chore: adding ShadyCSS support (186c340)
  • chore: adding suppoprt for ie11 in demo pages (c711def)
  • chore: adding tests for the element (cc4731c)
  • chore: adding type check when setting up navigation drawer (09c2604)
  • chore: completing separation of the app from the element (86e6a20)
  • chore: continue splitting the app (fe4a515)
  • chore: fixing chrome extension support (3a700bb)
  • chore: fixing multiple issues and styling improvemenets (a5f4bdc)
  • chore: increasing memory limit for AMF parser process (88e6f06)
  • chore: removing old config files (dadb59a)
  • chore: removing old demo files (d82ed24)
  • chore: removing static port definition from server start (2c1b56a)
  • chore: removing unused argument (3ea9c50)
  • chore: removing unused packages (944a10e)
  • chore: removing web animations script from demo pages (d8f8a80)
  • chore: started building parting API (28e0acf)
  • chore: started upgrading the console to LitElemet (d517891)
  • chore: started working on separating views for the app and the element (a2f5304)
  • chore: strting working on parsing service (8d5d1e9)
  • chore: updating auth-methods, form-data-editor, multipart-payload-editor (ecb8b81)
  • chore: updating compatibility setting in the scripts (f18b22c)
  • chore: updating components for annotation rendering fix (16f6394)
  • chore: updating demo build process (4e1a69a)
  • chore: updating min width on request section (a791b33)
  • chore: updating navigation that supports a11y (6fa82a6)
  • chore: upgradig dependencies (ced4883)
  • chore: upgrading component to remove global icons (257eddb)
  • chore: upgrading components and fixing compatibility issues (2a0bafa)
  • chore: upgrading components for security updates (c6f3661)
  • chore: upgrading demo pages (871e27a)
  • chore: upgrading documentation (b04d8cd)
  • chore: upgrading npmignore file (f1b5b92)

docs

  • docs: adding APIC with API editor example (0019a94)
  • docs: adding docs link to readme file (d1ac619)
  • docs: adding error color to demo page (b33085a)
  • docs: adding navigation to the editor demo (0399313)
  • docs: fixinf spelling (f5b8f54)
  • docs: updating documentation (d56e49e)
  • docs: updating icons in the demo page (f7435d0)
  • docs: updating readme file (c53be32)
  • docs: updating readme file (dd3e292)
  • docs: updating README page (8b92019)
  • docs: updatoing readme file for the preview version (3112cf3)

feat

  • feat: adding an option to set OAuth client ID / secret (391bba1)
  • feat: adding experimental rearrangeEndpoints property (692c21f)

fix

  • fix: adding swagger match to API file search (75208a4)
  • fix: fixed scrolling in APIC app (58610bd)
  • fix: fixes APIC-291 - navigation animation when bootstraping (c564eff)
  • fix: fixing __amfChanged function by calling super class (34fb6aa)
  • fix: fixing APIC-260 - CM editor rendered above opened nav drawer (4876283)
  • fix: fixing click handler on the "back" button (7ca40a7)
  • fix: fixing input width issue for multipart form (f15b029)
  • fix: fixing recognizing swagger spec version (e34740d)
  • fix: removing this.app from function call (f9cdf5d)

refactor

  • refactor: removing noExtensionBanner and adding allowExtensionBanner (dda3263)
  • refactor: removing Exchange xAPI from demos. Main demo is Drive API (bc271b4)
  • refactor: removing support for app attribute (6444432)
  • refactor: upgrading to AMF 4 (f4b7b4a)

6.0.0-preview.1 (2019-03-01)

  • Started upgrading API console to ES6 module imports (ba26e54)

Update

  • Update: Started working on local build script (0345e56)

4.2.0 (2017-10-25)

  • Changed behavior of the baseUri property as described in #535
  • Added this changelog
  • Many bug fixes in the internal web components

4.1.0 (2017-08-17)

  • New: Support for sending files
  • New: Added demo page for adding distributed content into the console.
  • New: Added demo page for selecting an API version inside the console.
  • New: Added noAttribution option. Attribution is now part of the console instead of the builder.
  • Update: redesign of the "body" editor in the request editor
  • Fix: Console is not completing the path whit host and port when Base URI set relative #502
  • Fix: Title of the API is not fully displayed #519
  • Fix: Add ability to add custom content to the console element as a distributed child #520
  • Fix: How to enter application/x-www-form-urlencoded for a post body? #374
  • Fix: No feedback for file type #199
  • Update: Updated demo pages of the console. See demo folder for more information