API Console Release Notes

Added documentation panel tests for security and types.

Added documentation panel tests for endpoints and methods.

Added request panel tests for query parameters.

Added basic visual tests.

The anypoint-web-components that use an API are available in FF.

Request panel fields are updated after credentials population event.

Annotations display correctly in partial models.

Empty headers are not removed from request editor if body was present in request.

Headers are updated in the model when input is changed.* Request with a file attachment in the body is sent.

Increase timeout for request test (921794bf)

Authorization in request panel (ce15b4eb)

Request panel tests (07f9a5f3)

Increase timeout (d988c6f3)

Increase timeout (10e49c5b)

Basic documentation panel tests (76200b0e)

Added support for populating parameters with custom domain properties in the request editor through the populate_annotated_fields event.

Added multiple component tests to request panel (Headers & Body, Authorization) and documentation.

Added --api-responses-method-padding-left and --api-responses-method-padding-right CSS variables.

Added listener for securitysettingsinfochanged to populate security settings fields in request panel.

Fixed visual bug in code selector divider in responses documentation.

Fixed bug where summary would not clear when changing AMF model to a library.

Removed force-resolutions package to avoid sub-dependency clashes.

Multiple new data- attributes across components enable testing.

Request URLs include optional query parameters.

XML examples correctly render application/xml bodies.

Header autocomplete opens on focus.

Selecting the previously selected item closes the drop-down menu.

The newly added force-resolutions dependency resolves specific component versions in sub-dependencies.

arc-response renders responses correctly.

The persistCache property prevents cache clearing in the request panel after an AMF property change.

API Console renders the description for named examples.

API Console correctly generates and shows nullable properties examples.

XML generated examples consider a defined XML name.

The response time has the correct number of digits after the decimal place.

Scalar types show generated examples without duplication.

Added oneOf types to the available types displayed in type documentation.

Added the option to disable required parameters in the request panel.

Media type names in the selector display correctly.

The Content-Type header is sent in the request correctly.

Application authorization flow is processed correctly.

Fixed bug where request panel was allowing user to encode payload multiple times, creating a breaking payload in most cases

Fixed bug with rendering examples when wrapped property was set

Fixed bug where tabs in Code Examples would flicker endlessly

Fixed bug where decimal numbers would always show as invalid in input

Added support for OAS 3 deprecated property

Added support for flattened AMF model

Added renderFullPaths property to render endpoints as their full paths, without indentation

rearrangeEndpoints now sorts endpoints alphabetically by path

Fixed OAuth grant type issue for OAS 2 APIs

Fixed bug where navigating between some endpoints caused incorrect URI parameters to appear

Fixed bug in enum array properties where the enums where not being rendered

Fixed missing application/xml media types in body

Fixed API-asset showing incomplete description of JSON-schema

Add Optional Content Type for File upload Multipart

When "Query Parameters" or "Query Strings" is added, it is not displayed in "Try it" panel

Missing server description in summary

Change toggle button to checkbox for "enable/disable header" option and other minor correction

Arrows in responses tabs were not rendering correctly

Toggling optional parameters was changing the values of the parameters

Convert multiline headers to single line when parsing

It is not possible to add a new Field in the multipart-payload-editor, it gets removed after adding it

Missing "anyOf" details for types

Union type examples of arrays not displaying as arrays

The title of a property, defined as a union of arrays, appears as "undefined"

Array type title appears as "undefined"

Wrong title for a property defined as an array of numbers

Code example curl shows undefined

Use description from Parameter over schema if available

Query parameter input value can hardly be seen

Example section showing extra spaces

Tabs flicker in Code Examples

Added multiple new CSS variables for further fine tuning of styling

"Show optional parameters" has been re-added

When adding multiple headers with the same name, the first instance would not reflect the correct value of the header

Example names are now ignored if they match the media type + a numerical iteration (e.g. application/json2)

Hide type name for inline types (if the type name is default)

Mintor styling fixes

Fix content-type header not being sent in requests

Add warning messages to body form items in request

Fix styling for request panel subheaders

Fix warning messages spacing in query parameters

Missing examples for parameters, types and headers

When a query parameter is defined as optional, the checkbox "Show optional parameters" is not displayed

Content type not being set on requests

Font labels for URI parameters and Query parameter sections are large and labels are indented

Content type being sent when sending requests

Warning messages overlapping with multiple required headers

Header schemas are now copied from original AMF model ones when switching between source and form editors

Fixed version URI parameter being replaced with API version

Fixed example generation with tracked elements for partial models

Fixed autocomplete not closing when clicking outside of overlay

Fixed headers being added/removed incorrectly

Disable copy button when there are no headers

For required fields that have no other restrictions, do not show as invalid. Instead, show an info message under the field

Added noOverview property to remove Overview items from navigation. If enabled, clicking on the endpoint name will select it, and the arrow will toggle the collapsible element

Added operationsOpened property to toggle all operations opened/closed

Added credentialsSource to optionally populate credentials in the request editor

Server selection for slotted servers was not changing the request URL

Copy button in Headers is now disabled if there are no headers

Response headers are hidden until deliberately shown

Response body was not being formatted

Response body was not being rendered with error responses

Re-add CSS variable to style form titles in request panel, and fix indenting in the titles

Show message object schema in documentation view for subscribe operations

Message schema was not being shown in api-method-documentation view

Boundary missing when content-type is multipart

Add PKCE OAuth flow in advanced settings in request panel. Enabled by default if declared in specificartion, can be enabled/disabled manually

Fixed bug where the Content-Type header inferred from the payload was not being added in the Request Panel

Fixed bug where client_secret was not being sent alongside thee rest of the information for the OAuth2 Password Grant

Fixed visual bug where channel and url were too compressed if channel was too long

anyOf in body payload now appears correctly

Changed an instance of "endpoints" to "channels" for AsyncAPIs

Do not prefix AsyncAPI url with http in summary view

Fixed operation label styling in summary and endpoint documentation views

Add styling to Publish and Subscribe operations in endpoint documentation

Fixed bug where changing the server would not immediately update the URL in the method documentation and endpoint documentation

Fixed bug where selecting Custom URI would make selector disappear if only one other server option was present

Bug UI bug where Summary and Endpoint views showed a small gray box where method would be

Fixed example generation bug for compact model where the value for a number would sometimes generate empty string instead of 0

Fixed bug where endpoints with closely related named may cause one of them to appear blank in navigation

Fixed bug where multiple, fully expressed endpoints which could be nested, would appear blank

Fixed bug in URL handling where, if the url did not have examples for a query param, an error would be thrown and nothing would render

api-request-panel does not return empty content if model does not belong to a WebAPI. This behavior is expected of whoever renders it

api-console and api-console-app check if AMF belongs to a non WebAPI, and hide the request panel & propagate the noTryIt accordingly

Fixed bug where baseUri on api-method-documentation was not propagating the change to api-url

Fixed regression in api-navigation that caused an error to happen when the first endpoint in a specification had a URI parameter in it

Annotation name is now rendered with the annotation

AsyncAPI 2.0

Required query parameters are now added to code snippets

Fixed bug with URL persisting after being removed from the spec

Fixed password grant type in Authorization where client secret was not being passed into the grant

Fixed bug where unordered endpoints would cause a endpoint path name to be shortened when it shouldn’t be

WCAG

Fixed bug example generation for partial models where some properties would not appear in rendered example if their values were empty strings, false boolean values or 0 integer values

Fixed bug in type documentation where enum array properties weren’t being rendered correctly

Fixed bug where the queryString node was defined on an operation, but the query parameters didn’t render in the try it panel

Fixed bug where XML example structures did not match the definition in the RAML type

Fixed bug where JSON schemas in RAML did not render completely

New css variable for text wrapping for navigation items

Changing RAML baseUri made query parameters section disappear

Duplicated examples in type documentation

Query string documentation was missing

Media types selector was missing when multiple media types defined in spec

Increase space between input and selectors and their labels

Table view was not displaying string examples

When setting no-auto-encoding annotation to URL elements, components were still being encoded

Client secret missing on request when authorizing for client_credentials authorizationGrants

Add rearrangeEndpoints property to api-documentation component, so it will be passed down to the api-summary if present

Pass down rearrangeEndpoints value to api-documentation as well

Add scrolling to response codes in documentation to be able to see all possible response code options

Example generation for partial models now accounts for arrays with only 1 item appearing as a single object in partial model

Fix issue where documentation pages were listed in navigation with its description content rather than its title

Implement oneOf, anyOf from OAS3

When a library is applied, documentation is blank for types

Server menu list width should fit dropdown width

URI in api-documentation and api-request-panel component does not update when servers in model change

Duplicate headers and headers from other methods shown in request panel

API Console do not understand readOnly fields when generating examples for OAS3 APIs

A property of type Object is rendered as a String

Library type documentation is blank

Missing response examples

Client Id and Client secret fields missing for client_credentials authorizationGrants

XML example with missing "e" at the end

Response body type not rendering

Examples generation after AMF model changes

Auto selection of a custom server when no servers are defined in an API

Support for the partial AMF model when querying for servers

api-request event listener is now registered on the request panel instead of the eventsTarget

Duplicated content-type header on the request editor

XSS via authorization URI

Authorization method styling issue

Restored support for partial model when getting servers

Additional model support when computing servers servers

Operation and endpoint servers override base servers when switching to Try It panel

Fix display of enum values for array type document

Added OAS' external documentation support in the navigation

OAS 3 support

Support for multi-server definitions

Custom servers

OAS multi-authorization

OAS links and callbacks

Support for no-auto-encoding annotation

fixed issues with multiple security scheme names in the navigation by adding name of the scheme to the type

upgrading AMF processor helper to better support OAS 3 features and build background for OAS 3 full support

upgraded lit-html and lit-element libraries to the latest version

upgraded dev dependencies

cleared dependencies

updated api-summary component with sanitization enabled for license URLs

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:

Redesigned base input controls. API console now uses own, material design based, basic UI input controls. It comes with 3 predefined styles:

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 the documentation or readme file for details.

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 custom element for embedding the console inside existing web application and api-console-app to create 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)

New headers for mocking service requests

Various fixed issues.

Updated AMF parser version and support for new model structure

Fixed examples rendering in the type documentation

Now type documentation renders generated JSON/XML schema when RAML’s mediaTypes / OAS' produces property is set

Examples now have default values for boolean, number, and null values when default value and example is missing

Bump parser to version v1.1.50

Fixed vulnerability issues.

Preview of ES6 modules version of API Console. This is an early preview, not targeted for production. Try it and give us your feedback.

Support for AMF data model instead of RAML parser allows to render a documentation for RAML and OAS specification and enables the console to read even more API types

Users can now define new properties (headers, query parameters) in the request editor that are not defined in the API spec.

API console now works with web components specification version 1. This allows to target all browsers with native support for web components spec and those with polyfill support.

Build process to create separate bundles for ES5 and ES6 enabled browsers so modern browsers can run the console with minimal required setup

Redesigned styling API to enable consumers to apply corporate theme using CSS variables

Build tools for the console now are based on AMF library to generate new data model

Redesign of the documentation part to deliver best in class documentation tool for APIs

Redesign of navigation for faster recognition of the API structure and to search for an endpoint

Added documentation for security schemes

Added code examples in the method documentation

Updated how union types are rendered - now it renders type name in the type selector instead of “Variant”

Feedback from our customers and the open source community was applied to this version resolving tens of issues regarding performance, stability and design

Fixing CORS extension banner behavior.

Support for AMF data model instead of RAML parser allows to render a documentation for RAML and OAS specification and enables the console to read even more API types

Users can now define new properties (headers, query parameters) in the request editor that are not defined in the API spec.

API console now works with web components specification version 1. This allows to target all browsers with native support for web components spec and those with polyfill support.

Build process to create separate bundles for ES5 and ES6 enabled browsers so modern browsers can run the console with minimal required setup

Redesigned styling API to enable consumers to apply corporate theme using CSS variables

Build tools for the console now are based on AMF library to generate new data model

Redesign of the documentation part to deliver best in class documentation tool for APIs

Redesign of navigation for faster recognition of the API structure and to search for an endpoint

Added documentation for security schemes

Added code examples in the method documentation

Updated how union types are rendered - now it renders type name in the type selector instead of “Variant”

Feedback from our customers and the open source community was applied to this version resolving tens of issues regarding performance, stability and design

Updated styles to enable theming

Added demo page with dark theme

It is fully functional

Has working demo pages

Documentation for the HTML component

Documentation for building application

Build tools (which is the reason of creating the release)

Build documentation

Styling documentation

Bump parser to version v1.1.48

Bug fixing

Forcing "marked" library update due to security vulnerability

Updating dev dependencies

Bumping version

Removing silent bower installation

Updating tests configuration

Fixing bower configuration

Bump parser to version v1.1.45

It is fully functional

Has working demo pages

Build tools (which is the reason of creating the release)

Build documentation

Bump parser to version v1.1.43

Bump parser to version v1.1.42

Bumped RAML Parser to version to 1.1.41.

Properties defined in the items facet were not displayed.

Values in optional headers were required to be specified.

Properties defined in response bodies for custom data types were not displayed in the console.

The error message “Cannot read property 'type' of undefined” appeared when a type was defined as an array and the array did not contain any elements.

Bumped RAML Parser to version to 1.1.40.

Because API Manager 1.x does not support digest authentication, the error message has been changed for Digest Authentication as follows: Digest Authentication is not supported in Try it.

When including a data type, the invalid error in IE Object doesn’t support property or method `include` appeared.

When selecting the Try It option, if the Request section is expanded and has the details, the Response section remained collapsed.

The problem declaring Arrays using defining items.

Partially blocked visibility of the tooltip for traits help.

A problem with the example defined for the query parameter.

Fixed an issue that caused a missing description and examples when using a security scheme.

Body extending from a type defined at a library is now displayed correctly.

Fixed the issue that required you to scroll to the right to see an example having many attibutes.

Fixed the issue causing API Console to throw "Custom Security Schemes are not supported in Try It”.

Fixed an issue related to using inline !include in query param rendering.

The description of types was not being displayed when defined using libraries.

Types were not displayed correctly at Types section.

Description of inner resources (those defined at sublevels) were not displayed.

API Console would not parse Raml files when using IE 11.

API Console was not rendered in IE.

Fixed an issue causing types defined in libraries to display incorrect information.

Fixed an issue preventing libraries from expanding and causing a display problem with the console library preview.

Bumped RAML Parser to version 1.1.24.

Added support for the file type to the Try It view.

Fixed an issue preventing the console from showing schemas that contain patterns that used |.

Fixed an issue preventing body parameters of type 'application/x-www-form-urlencoded' from being rendered in the Try It view.

Bumped the RAML Parser to version 1.1.24

Added showing the request URL in the Try It view even before you send out the request.

API Console was not accurately displaying enum values defined in a library.

Arrays defined using type expression shortcut were not displayed correctly.

The order of query parameters and types properties were not preserved when navigating to a resource.

API Console was not showing DataTypes examples when using inheritance.

API Console returned an Invalid Type error inside the TryIt panel when using RAML 1.0 array types.

API Console renders example information twice.

Parameter examples were not shown when defined in a response.

The description and examples of Pass Through security scheme were missing from API console.

Validation of uriParameters failed when using a custom type.

API Console did not entirely show examples when provided in type definitions (either for the entire type or single properties).

Rendering issues occurred when a type extends from another type declaration.

A validation issue occurred when the type is a number and has a related enum.

Bumped RAML Parser to version 1.1.20

Enhanced performance when rendering large projects.

Fixed an issue preventing API documentation from being displayed at the Portal due to incorrect url resolution after library expansion.

Fixed an issue preventing error feedback from being displayed (white page or greyed page was displayed instead, depending on implementation).

Fixed an issue that prevented response type and examples from being refreshed accurately when changing methods.

Fixed an issue causing multiple inheritance types to be incompletely rendered in the method response.

Bumped RAML Parser to version to 1.1.19

Added an improvement for rendering the root description of an API on the top of the page.

Add support for Pass Through to reflect the complete set of security schemes defined in RAML 1.0.

In the previous version, the error output was not correctly handled and had to be updated.

Several other smaller bug fixes.

Bumped JS parser version to 1.1.8.

Several other smaller improvements.