API Changelog

This page contains a log of all changes to the API and the versions that are related to each new addition.

🗂️ Versions Overview

VersionRelease DateChange Notes
0.1.0-beta2023-08-18View Notes
0.2.0-beta2024-04-23View Notes
0.3.0-beta2024-10-07View Notes
0.4.0-beta2024-12-07View Notes
v0.5.0-beta (Latest)2025-05-14View Notes

v0.5.0-beta (Latest)

⚠️ Beta notice: This version is in beta and may introduce breaking changes. Please review changes carefully before integrating.

🆕 What's New

  • HTML Content Support: The API now supports managing HtmlReference documents in addition to Markdown. This enables more flexibility in formatting and displaying portal content.
  • Page Content Format: A new field pageContentFormat allows you to specify whether content is written in MARKDOWN, HTML, or BOTH.
  • Product Visibility: A new boolean field hidden has been added to product metadata to control whether a product is displayed on the landing page.

🚨 Breaking Changes

  • Content Reference Schema: Markdown content references are now identified as MarkdownReference instead of MarkdownDocument. If you use content linking programmatically, this may require an update to your request structure.
  • Table of Contents Patch: The ability to change a table of contents entry's product via the PATCH operation has been removed.

v0.4.0-beta 

⚠️ Beta notice: This version is in beta and may introduce breaking changes. Use with caution.

🆕 What's New

No new features in this release.

🚨 Breaking Changes

v0.3.0-beta

⚠️ Beta notice: Use with caution; changes may not be backwards compatible.

🆕 What's New

🚨 Breaking Changes

v0.2.0-beta

⚠️ Beta notice: Use with caution; changes may not be backwards compatible.

🆕 What's New

  • Updated securitySchemes documentation for access permissions.
  • slug is now optional when creating table of contents entries.
  • Public OpenAPI specs are now available at /v1/openapi.json and /v1/openapi.yaml.
  • openapiRenderer now allows toggling between Elements and Swagger UI.
  • GET unpublished changes now includes detailed modification and a missing list.

🚨 Breaking Changes

  • Only organization owners can delete products (designers no longer have access).
  • PUT publish content now returns validation errors for missing/unfetchable APIs.
  • Endpoints renamed:

v0.1.0-beta

⚠️ Beta notice: Initial release. Expect breaking changes.

🆕 What's New

Initial launch of the SwaggerHub Portal API.

ResourceDescription
PortalsManage portal settings, branding, name, and domain. Configurable under general, branding, and landingPage.
ProductsMetadata and OpenAPI/Markdown documents bundled as products for users.
DocumentsMarkdown document storage and management.
SectionsOrganize APIs and documents into sections and ToCs.

🚨 Breaking Changes

This version introduces the initial contract and is subject to future breaking changes as the API matures.