Releases: Azure/api-management-developer-portal
2.27.0
Highlights
- Enhanced Authorization Support: We've expanded the API test console capabilities by adding support for multiple authorization servers, enabling more flexible and secure API testing environments.
- Admin UI Enhancements: The new admin UI has been fine-tuned with improvements and adjustments, addressing minor issues for better user experience. This includes a more efficient process for the deletion of multiple media files.
- UI and Accessibility Improvements: Further UI enhancements have been implemented across API Details, API definitions, and accessibility features, ensuring a seamless and inclusive user experience when interacting with APIs.
- Editor Display Fix: An issue within the editor that affected the display of images for services within a virtual network has been resolved, ensuring consistent visibility across various regions.
All changes
- 1f68f15 Fixed non-working anchors for definitions, made multiple complex schemas more readable (#2389)
- 9fe526d Fixed management API version mismatch (#2385)
- 1f68f15 Added UI interface for multiple auth servers (#2337)
- e8bc014 Upgrade dependency follow-redirects (#2401)
- fe35c31 Deleted markdown announcement (#2404)
- 51e5758 Fixed default home page menu text color (#2406)
- 019c451 Bump undici from 5.28.2 to 5.28.3 (#2410)
- 1baf9b4 Fixed: registered apiProducts widget correctly (#2411)
- 74b9886 Fixed validation behaviour (#2412)
- a44e8dd Updated API: products widget to use the dash naming convention (#2414)
- 5941570 Fixed API products widget editor registration (#2416)
- dc7e69e Improved logging around AAD B2C flows (#2402)
- 4a51397 Move default media files to regional storage (#2407)
- 4a51397 Alt tag for images in the Media modal (#2423)
- 4cb8563 Fixed: API not loaded the first time (#2424)
- 43f34bd aria-label attributes for fields with custom labels (#2427)
- 02a0c07 Fixed multiple media files deletion (#2434)
- cf9a32f Update issue templates (#2436)
- 36e8929 Fixed non-closing list of APIs dropdown widget (#2450)
- 234da42 Update package version to 2.27 (#2449)
- 2fea721 Update package-lock.json (#2451)
2.26.0
Highlights
We recently improved the API administrator user experience to boost productivity and enhance interactions with favorite features and tools. In this update, we have enabled the following changes:
- A new layout that allows easier management of the developer portal functionality.
- Ensure developer portal works great on all form factors and devices.
- Display separate views of the portal to users in different groups. For example, you might want to display certain pages only to groups that are associated with products, or to users that can access specific APIs.
- Redesigned the API and product details widgets to elevate the portal experience for visitors.
- Grouped helpful resources to support site management needs. These can be accessed through the Help and resources section of the menu.
We have also made several improvements in the API developer user experience in the portal including:
- Enhanced APIs and products page to better show descriptions and avoid truncation.
- Improved performance of the developer portal to enable optimized loading of subscriptions and API operations.
- Better user experience in the developer test console when authorization is used in the request
All changes
- d69668a Admin UI redesign (#2121)
- e3e9957 Pagination simplified for data API (#2304)
- d787bc6 Accessibility fixes (#2343)
- e1ad59f Nav link color fix (#2346)
- 82842ff Fixed: UTF-8 characters that have more than 1 byte get truncated by migrate scripts (#2348)
- 82842ff API operation-details - use correct protocol (#2357)
- 5cd2ddd APIs dropdown close fix and Product API widget target fix (#2352)
- 63fed3d Fixed Settings modal incorrect behaviour (#2361)
- 1271723 Packages update - custom widgets overrides default widget fix (#2363)
- acfa018 skipWorkspaces query param added to APIs & Products services (#2366)
- dff7932 Fixed error when changing OAuth flow (#2368)
- b43c5cb Fixed: custom HTML widget not rendering on published portals (#2370)
- 3e2d250 Validation fixes (#2374)
- b32da31 Fixed Link media functionality (#2377)
- 8abd865 Fixed: error when loading operations grouped by tags without apiId (#2376)
- 590ba34 Fixed: error when loading subscriptions without user signed in (#2375)
- 79a2972 iframe sandbox allowed tags fixed for safari (#2373)
- cffee03 Fixed subscription header always required (#2382)
- d613aef use of outdated custom widget scaffolder by npx fixed (#2383)
- a3f5cf6 Added role view dropdown (#2378)
- 8b3c6f9 Update to 2.26 version (#2380)
- 9f4d773 Disable reset password for signed in users (#2308)
- 0e1a8ea Fixed heavily truncated description for APIs and Products (#2386)
- 3ef57c1 Added mime type to media linking (#2390)
- 517f571 GitHub CI permissions change (#2393)
- 04befc3 Paperbits version bump (#2391)
- 51a55fb Fixed media empty permalink errors (#2395)
- 95d7ba7 Bumped paperbits version to sync with the managed (#2397)
2.25.0
Highlights
- Improvements and fixes on widgets, test console, Product APIs, API definitions, operation detail and subscription pages.
- Increased version of management API endpoints used and dependencies.
- Added Playwright framework for end-to-end tests.
All changes
- 2300463 Increase dev-portal version to 2.25.0 (#2365)
- 3d6cccd feat: add option to configure a default to expand all group tags (#2330)
- 5d754f2 Fixed Product APIs registration (#2324)
- b02619a Registered operationDetails widget (#2323)
- 73bb8aa Fixed nested definitions listing (#2315)
- 6e947bf Fix B2C signout (#2224)
- 762bcc9 Fixed typo in the method name. (#2307)
- db96030 Increase min version for management api (#2298)
- 68e1254 Added logic to decompress request body if it has gzip encoding header (#2297)
- d86cb77 Fixed Format and Readonly properties displaying (#2296)
- 3a67d03 Upgraded dependencies. (#2294)
- e393ad4 Fixed adding parameters for GraphQL APIs that have parameters (#2286)
- ea30ee9 operation-details - hide examples columns fix (#2289)
- 7d46bed Fix seach bar overlapping (#2276)
- e350f81 Playwright tests (#2254)
- d395754 Add navigation menu for default pages (#2257)
- a0c75d7 Updated widget registration model. (#2235)
- 255c87c fix typos and spelling errors (#2195)
- 9fe6440 Upgraded dependencies and default theme. (#2198)
- f299905 fixed regex that extracts resource name (#2205)
- 2805ab9 Subscription key improvements (#2212)
- c3a0eeb Remove not needed async and wait for the server listen event before test run (#2209)
- 518c428 Add dropdown for the case when there are multiple examples (#2208)
- c2d53d5 Removed duplicated styles (#2206)
New Contributors
Many thanks to all the new contributors.
- @SenpuDev made their first contribution in #2276
- @MichdeJong made their first contribution in #2224
- @MichaelJLiu made their first contribution in #2323
- @jan-mrm made their first contribution in #2330
2.24.0
Highlights
- Actions performed by visitors of the published portal, such as sign-in, retrieving a list of APIs, or requesting a subscription, are now served by API endpoints exposed under the developer portal hostname. Previously, they were served by the direct management API endpoints of the API Management service. This change applies only to managed portals. We will publish more information, API documentation, and client libraries after we complete improvements to the underlying API contracts, likely between August and October 2023.
- Developer portal now surfaces APIs and products managed in workspaces. This change applies only to managed portals.
All changes
- 7977733 Upgrade paperbits to 0.1.587 (#2204)
- 4cb0764 Increase dev-portal version to 2.24.0 (#2199)
- 53bfff2 Fixed scroll to operation (#2200)
- 435f7b8 Upgraded dependencies. (#2191)
- 2f6572a Added pagination for user subscriptions (#2189)
- 6df1119 Revert "Added developer portal type header for all requests (#2171)" (#2193)
- 9993be4 Replace deprecated methods from cred generation (#2192)
- f73c9b6 Made page content section stretch by default for all viewport sizes (#2190)
- ef4b854 Added developer portal type header for all requests (#2171)
- 655f8ef added "group by tag" toggle for api list dropdown widget; implemented logic for "default group by tag enabled" (#2180)
- 3869cf4 Provide proper error on GET request with body (#2138)
- 5e6df1a Fixed non-working images in API descriptions (#2188)
- e873140 Custom widgets - send location info of the main window to widgets (#2186)
- a1086a7 Fixed UI bugs for Subscriptions on the profile page (#2185)
- 0b43193 Re-enabled popup controls and snippets. (#2156)
- fe5c83c properly process unhandled error on logger error (#2148)
- 19271d1 prevent infinity loop on logging unhandled error (#2147)
- 7f3dd27 Update paperbits dependencies to 0.1.576 (#2141)
- 630aced Update liquid, trancate-html libs (#2140)
- 76d5918 Fix trailing slash issue (#2137)
- ef9ff61 Upgraded dependencies to fix several designer issues. (#2133)
2.23.0
This release includes many improvements and bug fixes.
Changes
- 23c45d0 Upgraded dependencies. (#2130)
- 69db90c Upgraded dependencies. (#2127)
- 8ce9465 Remove heading block that contains popup (#2126)
- a984002 Added negative lookahead to getResourceName regex (#2122)
- e985668 Fixed: product name disappears when changing subscription (#2120)
- 396ea23 Used custom dropdown from paperbits in widget editor (#2118)
- cdb86a7 Fixed several designer issues. (#2111)
- 6103542 Extend test widget functionality (#2109)
- 26904e3 Extend api list with two apis. Add randomizer (#2108)
- a468b81 E2E tests (#2061)
- 40d19b8 Upgraded dependencies. (#2084)
- c8867b0 Adding default domain to hostnames (#2051)
- 3845892 Added line breaks to parameter names on API details page (#2096)
- 9baaa04 sync graphql-language-service library (#2097)
- 2fbcb75 Display close account button for users signed in with delegation (#2073)
- 3e18b2d Added missing aria-labels (#2076)
- 12be6aa fixed report view with other country (#2075)
- f23b624 Fixed permalink validation issues. (#2071)
- 56e0fa5 Add unit test workflow (#2064)
- e5f5675 Fixed announcing correct state information for tab items (#2066)
- effbd87 decreased the apis schema refresh timeout from 60 to 5 min (#2065)
- 4af4744 Fixed required attribute displaying in complex schemas (#2060)
- bc35b86 Custom widgets iframes media & clipboard access allowed (#2050)
- cc428e4 Sign in & sign up messages corrected (#2049)
- 159c0ad Fixed URL concatenation for PKCE auth flow. (#2043)
- e8d0e23 Fix pipeline (#2040)
2.22.0
This release contains an issue with site rendering, we're investigating the problem. The regression has been fixed in the API Management backend.
Highlights
This release introduces the content access control feature for restricting the visibility of developer portal pages or sections within pages based on the user's identity. Content access control is available only in the managed portals and it will continue to roll out to all services throughout December. Learn more.
In addition to other improvements and fixes, this release contains the following enhancements to the API reference pages:
- Developer portal users can now collapse tag sections in the list of APIs or API operations grouped by tags. 986767f (#2003)
- You can now configure the API operation details tables to show examples in a dedicated column. 0939b62 (#2012)
- We redesigned the API version selector. f30cc70 (#2024)
Other changes
- cc1b8e0 Fixed issues with dependency libraries. (#2037)
- 3e7af5c Fixed Table widget editor issues. (#2027)
- 9ec70a4 Subscription Key is a required field now in the test console if API requires a Subscription (#2025)
- 579f823 Fixed: Sign in button visible after successful sign in (#2021)
- aa3a332 Added missing icon. (#2022)
- 4608b6e Bugfix - Custom widget URL hash sync in published portal (#1993)
- e066bac package-lock.json updated (#2014)
- 6e09ea8 Fixed Table view/Raw view visibility on high contrast theme (#1999)
- d85abf8 fixed readme and yaml (#2008)
- 652e4b7 Fixed issues with Text block and Map widget editors. (#2009)
- 7dc7404 operation-console aria-labels added (#1997)
2.21.0
Changes
- 1df8a84 Upgraded paperbits dependencies (#1994)
- 6567e23 Fixed: every form element has a label in List of APIs(tiles) editor (#1989)
- 52a9546 scrollbars color adjusted to improve accessibility (#1990)
- 9837cc8 Accessibility improvement - request body format accessibility improved (#1991)
- c719f2f Contributions update 2 (#1987)
- 0ae10ca Update CONTRIBUTIONS.md (#1986)
- 6982df6 Fixed the build script for FuncApp-based publisher example. (#1983)
- 502b1ee custom-widget - auto-sizing of the editor window fixed (#1977)
- fb057d4 Custom widgets - added time zone to "deployed" timestamp (#1942)
- 72c7fa6 Upgraded dependencies. Added Forms module. (#1922)
- d10f4af Fixed section styles. Made backendUrl warning dismissible. (#1978)
- fb62ef0 returnUrl open-redirect security bug fixed (#1975)
- c5b68e7 Added support for popups. (#1893)
- d60af57 Fixed handling of unknown status codes. Added default status text for 529 error. (#1971)
2.20.0
Changes
- f2ccec0 Fixing inconsistency between Sample request body select label and aria-label (#1962)
- 368b9a7 Fixed scrolling issue with GQL console (#1964)
- d812a1e Collapsibles refactor to use native details summary components (#1960)
- f4ad331 Sync hash between main window URL & custom widget iframes src (#1949)
- 0c4bb80 Added support for PKCE extension for Authorization code grant. (#1945)
- 474d3b8 Fixed authorization header remove logic (#1940)
2.19.1
This release contains improvements and bugfixes.
Changes
- f59530d Remove locales from search (#1937)
- b5141c9 Added handling for hash part of URL in case of server-side redirect. (#1935)
- 3ebd4a8 Fixed description error appearing on SOAP APIs (#1934)
- 1afb427 Added handling and telemetry for failed captcha initialization. (#1932)
- 6c8538e Fixed formatting response body (#1929)
- 51ec561 Custom widget development instructions - widget folder path fix (#1923)
- 4f38182 Improved luminosity ratio for focus indicators (#1916)
- 37c884e Fixed operation console error on response without content type header (#1921)
2.19.0
This release contains a series of improvements and bugfixes to API reference pages, test console, and other widgets and components of the developer portal.
Changes
- f7b3ef0 custom widgets df testing fixes (#1917)
- d2d7830 pointless spaces removed (#1915)
- 41aadce Custom widget scaffolding tool (#1910)
- 0c91e7c Revert "Upgraded paperbits dependencies (#1900)" (#1911)
- f417633 Fixed: ensure ARIA attributes are allowed for an element's role (#1906)
- 9bc9530 Unified Test console request and error handling (#1905)
- d8deb7f Remove response from error object (#1904)
- 8309436 Add exception trace to log (#1901)
- 952b008 Upgraded paperbits dependencies (#1900)
- 4b1df4b Fixed: show subscription keys only if they are active (#1886)
- 13055ae Added token as GitHub secret (#1899)
- 634f23f Fixed cached schemas for operations (#1898)
- 0d0f2b3 Replaced logging to console with error when mapping grant types. (#1897)
- 2514e77 Added suppression tags for cred scan false-positives. (#1895)
- 1c61c99 Fixed: remove/edit test console required headers (#1892)
- 9d96c0a Removed duplicated ids for group by tag (#1883)
- 2f351a2 Fixed: api-details page breaks for long display name (#1884)
- df7affd Fixed default release name format. (#1882)
- b45e399 Fixed the focus switch on test console opening. (#1879)
- 334b4d2 Description rendering for examples (#1876)