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

v0.7.0-beta (Latest)

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

🆕 What's New

• Portal Footer feature: The API supports editing and managing Portal Footer as part of Portal Settings. To add or update footer for your Portal use PATCH Patch portal endpoint, the property is also returned in the successful response. Optional footer property was added to GET Get portals and GET Get portal endpoints responses.
• Published Content Get: Async API is now indexed for search. New optional fields corresponding to Async API 2.x.x and 3.0.0 properties were added to search results for products and portals, and the optional property asyncChannelName was removed. Request parameter q now has the length limit set to 255. 
• Published Sections Get & Template Preview Sections Get: New optional properties asyncApiMessages and asyncApiServers were added to the responses. 

v0.6.0-beta

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

🆕 What's New

• Product Template feature: The API supports creating, editing and managing Templates. Now when you create a new product, you can do it from scratch or use a template.
• GraphQL: Creating table of contents entry's with linked GraphQL API is now supported. A new value GRAPH_QL has been added to ContentType enum.

🚨 Breaking Changes

• Published Content Get: ENDPOINTS type of search results for products and portals was renamed to OPERATION

v0.5.0-beta

⚠️ 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

• POST Create product: now requires a type property (use "type":"new").

v0.3.0-beta

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

🆕 What's New

• credentialsEnabled and routing options added to POST Create portal.
• Enum value Inter added in Patch portal.

🚨 Breaking Changes

• Add table of contents entry now requires type.
• Default openapiRenderer changed to TOGGLE in Create portal.

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:
  • POST /sections → Create section
  • POST /products → Create product

v0.1.0-beta

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

🆕 What's New

Initial launch of the SwaggerHub Portal API.

🚨 Breaking Changes

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