Improved API Portal Design
We completely refactored the design and look of our API Portal to be more modern, sleek, and intuitive. Take a look at the screenshots below to see the improved design. We also added generated response examples and ergonomic improvements when navigating between pages in the portal. See a full list of changes in the "Improvements and Fixes" section below.
![new design](/assets/images/light-dark-mode-1f0b07c7082793a59f2969d5cc05a0b7.png)
![docs dark](/assets/images/docs-dark-6a0ff40cf9a061517624a5fc7e300232.png)
![docs light](/assets/images/docs-light-fb38d314a27e1d1f810e5cae348e590a.png)
![docs dark](/assets/images/docs-2-dark-aea295593286163720b63471a8ec4717.png)
![docs light](/assets/images/docs-2-light-ec3e56d12860dca7e14a07a107e50b47.png)
![reference dark](/assets/images/reference-dark-0d89298a332142f6bcfbc1db6814847b.png)
![reference light](/assets/images/reference-light-92347b6ddc7dbdd9cda46b3fbd194b74.png)
![demo dark](/assets/images/demo-dark-a2e24a9f81a10f05565dff852247e739.png)
![demo light](/assets/images/demo-light-607cb0717dbc72d3e9f2813b244bd098.png)
Refactored SDK Documentation
We now allow you to brand your README.md
with a banner image using the new
readmeHeader
property in your konfig.yaml
file like so:
This generates READMEs with your image and title at the top of the file like so:
![README Header](/assets/images/ts-header-fb7b1b5d58f353b22f7da97c11ae3cc2.png)
We completely overhauled the generated documentation for Python and TypeScript to be easier to read and find what you're looking for.
![TOC](/assets/images/ts-toc-4c59183eb4d6fd3161db0ad377b3972d.png)
![TypeScript Usage](/assets/images/ts-usage-571f42b379e4a3de95e2fa6254b6b5d6.png)
![TypeScript Usage](/assets/images/ts-usage-571f42b379e4a3de95e2fa6254b6b5d6.png)
![Python Usage](/assets/images/python-usage-f008e5bf0894e2a12b7670c4874776b8.png)
![TypeScript Return](/assets/images/ts-return-c3cc96ef0024d3ed88487de9c777daf0.png)
![Python Return](/assets/images/python-return-05d9f27b350918510674178cc34c2d50.png)
We also plan to improve the generated documentation for other SDKs.
Improvements and Fixes
- API Portal now preserves scroll position when navigating between pages
- Clicking the logo in the top-left corner brings you back to homepage
- Implemented light/dark logo theme for API Portal
- Added
-x
to not start a mock server inkonfig test
- Fix table rendering width larger than viewport in API Portal
- Fix table from causing horizontal scroll on small screens
- Fixed handling of non-
Blob
type values in TypeScript SDK formultipart/form-data
- Handle
array
type schemas in request body for API Portal - Support
bash
,JavaScript
, and many more languages as code blocks in API Portal - Point top-level API Portal domain to documentation if documentation is configured
- Remove nested documentation in Python SDK
- Embed all documentation into neatly organized
README.md
for Python SDK - Removed nested documentation for TypeScript SDK
- Embed all documentation into neatly organized
README.md
for TypeScript SDK - Added ability to order endpoints in the API Reference page
- Fixed scrollbar blocking header on Windows for API Portal
- Fixed bug in
konfig fix
where fixing operation IDs fail becauseawait
wasn't used - Fix invalid links in top-level
README.md
in SDK repository - Show example values and schema in API Portal for operations