Flex Gateway新着情報
Governance新着情報
Monitoring API ManagerAPI Console automatically generates documentation for an API project. An interactive component, API Console shows information about your REST APIs and their methods, and enables you to test the methods by sending requests. API Console is embedded in multiple MuleSoft platform products including API Designer, Exchange, and Studio.
February 9, 2024
Issue Resolution | ID |
---|---|
Imported schemas and XML examples now display in the Documentation panel. |
W-14846319 |
In Design Center and Exchange, Swaqgger JSON now displays valid examples in the response. |
W-14874965 |
January 15, 2024
Issue Resolution | ID |
---|---|
Design Center now generates JSON with nested objects for OAS 3.0. |
W-14278539 |
AsyncAPI examples now appear in the API Console. |
W-14588829 |
XML examples now show in REST APIs for OAS. |
W-14651311 |
November 11, 2023
Issue Resolution | ID |
---|---|
Header names are no longer showing in code examples. |
W-14454298 |
When editing an example, the mocking service URL no longer changes and causes the request to fail. |
W-14071465 |
The example names are no longer missing when defining the XML schema definition. |
W-12646073 |
October 23, 2023
Issue Resolution | ID |
---|---|
The example for an API is no longer missing. |
W-14102462 |
An unexpected Content type header is no longer added to a GET request when a POST request was sent previously during the same browser session. |
W-13959789 |
September 25, 2023
Issue Resolution | ID |
---|---|
The cookie authentication value is now sent in the Cookies header. |
W-13832170 |
The Authorization scopes in the Security section now updates between endpoints. |
W-14015302 |
August 28, 2023
Issue Resolution | ID |
---|---|
The child property no longer displays mandatory fields. |
W-13772034 |
The query parameters are now rendering properly and the parameter value box is no longer hidden. |
W-13813608 |
A new error message now displays for error code 0. |
W-13957966 |
July 31, 2023
Issue Resolution | ID |
---|---|
A field error no longer overlaps with other inputs. |
W-13463891 |
Query parameters now list all options. |
W-13599882 |
July 3, 2023
Issue Resolution | ID |
---|---|
The oauth-popup.html no longer causes an access vulnerability. |
W-1358830 |
The |
W-13547158 |
All fields no longer display as required. |
W-13536254 |
Fields are now rending in the request panel. |
W-13524893 |
The content for schema types now displays in the API specification. |
W-13207777 |
An error no longer displays when the |
W-13079436 |
June 5, 2023
Issue Resolution | ID |
---|---|
The URL protocol is no longer missing when making a request. |
W-112688568 |
May 12, 2023
Issue Resolution | ID |
---|---|
When an OAS API specification scheme is not defined, HTTPS is now the default for the URL protocol. |
W-12598786 |
For AsyncAPIs, the Kafka key element and its datatype now display in the documentation panel. |
W-12528949 |
April 24, 2023
Issue Resolution | ID |
---|---|
For AsyncAPIs, the Kafka key element and its datatype now display in the documentation panel. |
W-12528949 |
March 27, 2023
Issue Resolution | ID |
---|---|
OAuth 2.0 token generation now populates after the request. |
W-12119152 |
DIN fonts are now deprecated. |
W-12726752 |
February 17
Issue Resolution | ID |
---|---|
Data type values now display correctly in the documentation panel. |
W-12137562 |
The request access token is now working as expected with the OAuth 2.0 implicit flow. |
W-12227877 |
Types now render as expected in the documentation panel when called from other libraries. |
W-12276910 |
Properties are no longer missing in generated examples when merging |
W-1248170 |
The value for |
W-12428173 |
February 1, 2023
Issue Resolution | ID |
---|---|
Boundary is no longer missing in multipart content-type headers. |
W-12465439 |
January 6, 2023
Issue Resolution | ID |
---|---|
Information is no longer missing when merging |
W-12142859 |
The mocking service now receives the correct |
W-12146715 |
The information for the |
W-12183115 |
December 19, 2022
Issue Resolution | ID |
---|---|
The documentation for type is no longer missing when properties are defined as |
W-12065773 |
November 17, 2022
Issue Resolution |
ID |
The custom query parameters are no longer reset when the server value is set in the Request panel. |
W-12030452 |
October 28. 2022
Issue Resolution |
ID |
The request URL now populates correctly. |
W-11386481 |
The example for string arrays now generate correctly. |
W-11798608 |
The example for enum types in parameters section are no longer missing. |
W-11836777 |
The correct value now displays for the header when making requests. |
W-11843862 |
The |
W-11858334 |
You now can allow the OAuth2 Token requests to be prevented. |
W-11921592 |
The names for security fields now display correctly. |
W-11939928 |
October 11, 2022
Issue Resolution |
ID |
Parameters are now sent on request. |
W-11517665 |
September 16, 2022
For an AsyncAPI with multiple messages for an operation, you can now choose a message from the drop-down menu.
August 26, 2022
Issue |
ID |
Optional headers are now shown in the Documentation panel. |
W-11429833 |
The input fields in the Try it panel now display properly. |
W-11486959 |
The input fields in the Try it panel no longer display as missing information once rendered. |
W-11486967 |
The labels of multiple API keys now render correctly in the Documentation panel and in the Request panel. |
W-11541233 |
August 5, 2022
Issue |
ID |
In OpenAPI, deprecated endpoints are now displaying in the documentation panel. |
W-11383870 |
Examples in OAS 3.0.0 for content-type application/xml are now displaying tags with a prefix. |
W-11423667 |
July 15, 2022
Issue |
ID |
An array now displays an element in the API documentation preview. |
W-11117349 |
The miniItems and maxItems information is now displaying in the data type documentation. |
W-11209734 |
June 24, 2022
Issue |
ID |
All messages render correctly when there are multiple AsyncAPI messages. |
W-11105366 |
XML responses render correctly in the response viewer. |
W-11196904 |
Operation headers for AsyncAPIs render correctly. |
W-11308473 |
May 27, 2022
Issue |
ID |
Namespace is no longer missing from the body example. |
W-11084386 |
May 19, 2022
Issue |
ID |
Request responses for images, SVG, and XML no longer cause an XSS vulnerability. |
W-11031948 |
May 6, 2022
Issue |
ID |
When navigating to the method documentation, the console browser no longer displays an error. |
W-10914362 |
To increase accessibility, this release adds alt text for icons in the request panel. |
W-11083487 |
April 18, 2022
Issue |
ID |
The API server description no longer causes an XSS vulnerability. |
W-10881270 |
April 7, 2022
Issue |
ID |
This release removes non-inclusive language. |
W-10921614 |
XML name can now override type name. |
W-10743611 |
OAuth 2.0 token request events now dispatch properly. |
W-10749540 |
The properties of the data type |
W-10928298 |
When the |
W-10839261 |
February 25, 2022
A long XML schema example is not duplicated.
Saving response does not generate an empty .HAR file.
Headers are reset when navigating to another operation without headers.
Adding a new custom header changes focus to the newly added field properly. * Icon for saving .HAR response is no longer missing.
An array response collapse button displays properly.
January 28, 2022
Added request body description to documentation.
Added test for overwriting Content-Type
header with multipart
body.
Added functional tests for flattened model.
Added test for sending request with a file attachment as body.
January 10, 2022
Added documentation support for allOf types in OAS 3.0 APIs.
Added functional tests for responses.
Added functional tests for AsyncAPIs.
Added functional tests for OAS 3.0 APIs.
Set up visual tests to run as part of GitHub actions.
The request panel renders correctly.
Multipart body has the correct type stored internally when initializing.
OAuth scopes renders correctly.
December 20, 2021
Populating credentials after removing a header does not throw an error.
Modifying a header does not clear the previous changes after populating credentials.
November 30, 2021
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.
August 27, 2021
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.
July 12, 2021
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
June 25, 2021
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
May 14, 2021
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
April 23, 2021
"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
March 25, 2021
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
March 25, 2021
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
March 9, 2021
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
January 7, 2021
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
December 3, 2020
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
November 30, 2020
Annotation name is now rendered with the annotation
AsyncAPI 2.0
Support for non HTTP protocols in documentation
api-request-panel
is hidden when present model is from an AsyncAPI
Endpoints
renamed to Channels
Operation URL is displayed differently for non-HTTP protocols
Example and snippets are hidden for non-HTTP protocols
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
Navigation collapse/expand was not being properly read by screen reader
Query parameters input box was not associated with any form label
Code Examples and Body collapse/expand were not being properly read by screen reader
Server selector dropdown was not properly associated with form label
September 28, 2020
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
August 31, 2020
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
July 21, 2020
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
July 7, 2020
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
May 27, 2020
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
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
March 31, 2020
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
January 16, 2020
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 is completely different. See documentation at https://docs.api-console.io.
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
attribute
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 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)
May 29, 2019
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
January 15, 2019
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”
January 11, 2019
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”
April 21, 2018
This release includes the following enhancement and resolves a number of issues:
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.
February 24, 2018
This release includes the following enhancements and resolves a number of issues:
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.
January 13, 2018
This release resolves a number of issues.
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.
November 4, 2017
This release introduces improvements and bug fixes.
Bump JS RAML Parser to v1.1.31
August 26, 2017
This release focuses on a few RAML 1.0-related improvements and bug fixes.
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.
Bumped RAML Parser to version to 1.1.29
July 15, 2017
This release focuses on a few RAML 1.0-related improvements and bug fixes.
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.
June 17, 2017
This release focuses on a few RAML 1.0 related improvements and bug fixes.
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.
June 3, 2017
This release focuses on a few RAML 1.0 related improvements and bug fixes.
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.
April 8, 2017
This release focuses on minor bug fixes.
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.
March 11, 2017
This release includes a JS parser update.
Bumped JS parser version to 1.1.14.
December 3, 2016
This release includes several fixes for rendering information as well as fixes for issues around RAML 1.0.