What’s New

Organization owners can delete unused credit cards from payment methods.Changing Credit Card Information

Registry API updates:

Catalog pages and search results can now be sorted by the document title (info.title).

Parameter definitions in domains now display x- extensions and the pattern, min*, and max* attributes.

Registry API updates:

Updated Swagger Editor to v. 3.14.6 and Swagger UI to v. 3.36.2.

New Registry API operations to create and manage projects in organizations.

Updated Swagger UI to v. 3.36.1, which includes the following improvements:

Updated Swagger Editor to v. 3.14.5.

Updated Swagger Codegen to v. 3.0.23 for OpenAPI 3.0 and v. 2.4.17 for OpenAPI 2.0.

Faster search results. We’ve improved search performance so you will see results faster.

Full-text search. API Hub for Design now also searches the entire YAML contents of API definitions and domains. For example, you can search for definitions that contain specific paths, parameters, or schemas.

Partial word search. For example, book will find books, ebook, booking, and so on.

Search using boolean operators. You can combine the search terms using AND, OR, NOT. For example, upload OR submit will find definitions containing either word.

New Best Match sorting shows the search results ranked by relevance. This is now the default sort order for search results.

New Registry API operations to get and set the visibility (public or private) of APIs and domains:

GET /apis/{owner}/{api}/{version}/settings/private
PUT /apis/{owner}/{api}/{version}/settings/private

GET /domains/{owner}/{domain}/{version}/settings/private
PUT /domains/{owner}/{domain}/{version}/settings/private

Updated Swagger Codegen to v. 3.0.22 for OpenAPI 3.0 and v. 2.4.16 for OpenAPI 2.0.

Designers and consumers can now see their role on the organization catalog page:

Registry API updates:

The "create integration" operation (POST /apis/{owner}/{api}/{version}/integrations) supports additional integrations: Bitbucket Cloud, Bitbucket Server, and Azure DevOps Services.

The enabled field of integration configuration is now optional and defaults to true.

In APIs that use mocking, the mock is now automatically created for new versions of the API.API Auto Mocking

The Export > Download API > YAML Resolved and JSON Resolved commands now download the actual YAML or JSON file instead of a ZIP archive.

Interactive API documentation now displays vendor extensions (x- fields) in operations, parameters, and schemas.

New option for "try it out" requests: Credentials in CORS requests. This option becomes available when routing requests via browser and corresponds to Swagger UI’s withCredentials option. Set this option based on how CORS is configured on the API server:

Enable this option if the API server sends back the origin header, such as Access-Control-Allow-Origin: https://app.swaggerhub.com.

Disable this option if the API server sends the Access-Control-Allow-Origin: * response header. Note: If this option is disabled, CORS requests will not include browser cookies or the Authorization header.

New Registry API operation to add GitHub and GitLab integrations to API definitions:

POST /apis/{owner}/{api}/{version}/integrations

Webhooks are now carried over when you create a new version of an API.WebhooksCopy Integrations

New Registry API operations:

Added the Go and TypeScript Fetch client generators for OpenAPI 3.0.

Updated Swagger Codegen to v. 3.0.21 for OpenAPI 3.0 and v. 2.4.15 for OpenAPI 2.0.

Added Registry API operations to read, add, and manage comments in API definitions and domains.

The following operations have been deprecated in favor of the new ones:

GET /apis/{owner}/{api}/{version}/.comment
GET /domains/{owner}/{domain}/{version}/.comment

Integration with self-hosted GitHub Enterprise Servers. Your GitHub Enterprise Server must be accessible from the public Internet and allow connections from our IP addresses.GitHub Enterprise Server Sync

Catalog pages (My Hub, organization pages, and others) now have the "delete" button so that you can quickly delete APIs and domains you no longer need.

Click the image to enlarge it.

Improved syntax validation for domains.

Updated Swagger Editor to v. 3.11.7.

Updated Swagger UI to v. 3.30.0, which includes the following improvements:

Interactive API documentation now also displays the pattern, min*, and max* attributes for operation parameters.

Pulling API definitions from source control. If you store your OpenAPI definitions in a Git repository, you can now pull them from the repository into API Hub for Design. To be able to do this, you need to configure a source control integration in API Hub for Design with the target file set to an unresolved YAML or JSON definition. Such an integration will allow bi-directional synchronization (both push and pull) between API Hub for Design and the Git repository. For details, see Syncing OpenAPI Definitions Between Source Control and API Hub for Design.Sync API Definitions Between Source Control and API Hub for Design

Click the image to enlarge it.

Added C++ (Pistache, Restbed) server generators for OpenAPI 2.0.

Updated Swagger Codegen to v. 3.0.20 for OpenAPI 3.0 and v. 2.4.14 for OpenAPI 2.0.

Updated Swagger Editor to v. 3.11.6 which includes new syntax validations:

Updated Swagger UI to v. 3.28.0, which includes the following improvements:

Visual Editor improvements:Visual Editor for OpenAPI Definitions

Download resolved definitions via API Hub for Design Registry API by adding the ?resolved=true query parameter to the URL of your API’s YAML/JSON file.

Resolved YAML:

https://api.swaggerhub.com/apis/OWNER/API_NAME/VERSION/swagger.yaml?resolved=true

Resolved JSON:

https://api.swaggerhub.com/apis/OWNER/API_NAME/VERSION?resolved=true
https://api.swaggerhub.com/apis/OWNER/API_NAME/VERSION/swagger.json?resolved=true

Updated Swagger Editor to v. 3.9.0, which improves OpenAPI syntax validation:

Updated Swagger UI to v. 3.25.4, which includes the following improvements:

Added the Rust server generator for OpenAPI 2.0.

Improved syntax validation for OpenAPI 3.0 domains.

Support for OpenAPI 3.0.3: you can import API definitions that use openapi: 3.0.3.

AWS Lambda integration now supports newer versions of Node.js and Python. You can choose from:

New supported regions in AWS integrations: ap-east-1 and me-south-1.

Swagger Codegen was updated to v. 3.0.19 for OpenAPI 3.0 definitions and v. 2.4.13 for OpenAPI 2.0 definitions.

Commenting permissions for Consumers. Organizations have the new option to give Consumers and Designers permissions to comment on the organization’s APIs and domains. This allows Consumers to offer feedback on the API design and ask implementation questions as they consume the API.Comments

Click the image to enlarge it.

New Registry API operations to get and set the default version, publish and unpublish versions, get the published status.

The Basic Sync mode of source control integrations now allows custom branch names.

When you create a new version and choose to copy source control integrations, the branch for the copied integrations will be set to swaggerhub-<API-name>-<version>. You can change the branch name later if you want.

API Hub for Design IP addresses have been changed. If you have firewall rules that allow traffic from our IP addresses, make sure to update those rules.

Source control integrations are now carried over when you create a new version of an API.Copy Integrations

Click the image to enlarge it.

Added the Swift 5 client code generator for OpenAPI 3.0.

Updated Swagger Codegen to v. 3.0.18 for OpenAPI 3.0 and v. 2.4.12 for OpenAPI 2.0.

Improved browser tab titles for various API Hub for Design pages. The titles now better indicate what is in each tab, making it easier to work with multiple API Hub for Design pages open at the same time.

Click the image to enlarge it.

Updated Swagger Editor to v. 3.8.0, which adds a new validation for "enum values should conform to their schema’ss type".

Updated Swagger UI to v. 3.25.0, which adds support for the x-tokenName extension in OpenAPI 3.0 definitions.API Hub for Design Vendor Extensions

Updated dialog box styles.

Single sign-on support for organizations with multiple email domains.

Extended Designer permissions:

New Project option in Create, Import, Fork, and Save As dialogs allows adding newly created definitions to an existing project.

The Transfer Ownership command in the editor was replaced with Manage Owner & Project which also allows adding definitions to projects.

Catalog pages and the Info panel now also display the title (info.title) of APIs and domains.

Click the image to enlarge it.

Node.js server

Python client

See who created an API or domain. The API/domain Info panel now shows the username of the person who created the current version of the API or domain.

Click the image to enlarge it.

API listing pages now show both the error and warning badges for APIs that have both types of standardization issues.

Updated Swagger Editor to v. 3.7.1, which improves OpenAPI syntax validation:

Updated Swagger UI to v. 3.24.3.

Custom standardization rules. Organization owners can add custom rules to validate API definitions for compliance with the company’s design guidelines.Custom Rules for API Standardization

New code generators:

New search keywords, standardization:critical and standardization:warning, let you find APIs with standardization errors and warnings, respectively.Searching API Hub for DesignAPI Standardization

Updated Swagger Codegen to v. 3.0.14 for OpenAPI 3.0 and v. 2.4.10 for OpenAPI 2.0.

Updated Swagger Codegen to v. 3.0.13 for OpenAPI 3.0 and v. 2.4.9 for OpenAPI 2.0.

Minor UI updates.

Updated application colors.

The Navigation panel in Code Editor is now resizable.

Support for permalinks to API models. API model permalinks have the #/MODEL_NAME format, for example:Interactive API Documentation

https://app.swaggerhub.com/apis-docs/swagger-hub/registry-api/1.0.59#/User 

API Hub for Design sidebar now provides quick access to user settings, organization settings, and project settings via the  button.

Click the image to enlarge it.

Code Editor and Visual Editor now remember their editor and UI panel widths independently.

Updated Swagger Editor to v. 3.6.36.

Updated Swagger UI to v. 3.23.11.

OpenAPI 3.0 parameters with content are now displayed and can be used in "try it out".

Click the image to enlarge it.

Updated Swagger Editor to v. 3.6.34.

Updated Swagger UI to v. 3.23.8.

UI tweaks in Visual Editor.

Updated Swagger Editor to v. 3.6.33, which improves validation of tag uniqueness.

Updated Swagger UI to v. 3.23.5.

Updated Swagger Codegen to v. 3.0.11 for OpenAPI 3.0 and v. 2.4.8 for OpenAPI 2.0.

Support for multiple examples in parameters, request bodies, and responses in OpenAPI 3.0 definitions and domains.

Click the image to enlarge it.

Updated Swagger UI to v. 3.23.3.

Updated Swagger Editor to v. 3.6.31.

Integration with self-hosted Bitbucket Servers.Bitbucket Server Sync

Visual Editor now lets you edit API servers and server variables in OpenAPI 3.0 definitions.

Click the image to enlarge it.

Support for OpenAPI 3.0.2: you can import API definitions that use openapi: 3.0.2.

Organization members can now see a list of organization owners on the My Organizations screen.

Click the image to enlarge it.

Updated Swagger Codegen to v. 3.0.10 for OpenAPI 3.0 definitions and v. 2.4.7 for OpenAPI 2.0.

Increased the "try it out" timeout to 30 seconds for requests routed via API Hub for Design proxy.Interactive API Documentation

New OpenAPI 3.0 code generators: ASP.NET Core server, C# client, Python Flask server.

OpenAPI 3.0 support in Apigee Edge integration.

Azure API Management integration can now be authorized via Azure AD. The new approach replaces previously used "SharedAccessSignature" tokens that had to be re-generated manually every 30 days.

Click the image to enlarge it.

Support for auto-provisioning GitLab integration via the API Hub for Design Maven plugin.

Updated Swagger Codegen to v. 3.0.9 for OpenAPI 3.0 definitions and 2.4.6 for OpenAPI 2.0.

Added a link to this changelog to the  menu.

Single sign-on is now available to organizations on the Enterprise plan. API Hub for Design SaaS currently supports the following identity providers:

Please contact your account manager if you are interested in enabling single sign-on for your organization.

Updated Swagger Editor to v. 3.6.30.

Updated Swagger UI to v. 3.22.3.

Visual Editor now lets you manage tags and edit tag metadata.Visual Editor for OpenAPI Definitions

Updated Swagger Editor to v. 3.6.29 and Swagger UI to v. 3.22.2.

Visual Editor opens with the Navigation panel opened by default.

Updated Swagger Editor to v. 3.6.28, which improves error reporting for OpenAPI syntax errors.

OpenAPI 3.0 support in the Azure API Management integration.

New supported regions in the Amazon API Gateway Lambda Sync integration: us-east-2, eu-west-2, eu-west-3, eu-north-1, ap-south-1, cn-north-1, cn-northwest-1, ca-central-1.

Visual Editor now supports editing model descriptions.

Interactive Docs have a new option to ignore SSL certificate errors for "try it out" requests routed via API Hub for Design proxy. This allows sending requests to servers that use self-signed SSL certificates. The option can be found at the bottom of the Interactive Docs in the Editor.

Click the image to enlarge it.

Updated Swagger Codegen to v. 3.0.8 for OpenAPI 3.0 and v. 2.4.5 for OpenAPI 2.0.

Updated Swagger UI to v. 3.22.1.

Visual Editor has new API Info fields for externalDocs.

Organization owners can see member email addresses in the member list.

Account Settings have been rearranged into vertical tabs.

Support for auto-provisioning Azure DevOps Service integration via the API Hub for Design Maven plugin.

Visual Editor for API info and operation metadata. Use the Visual Editor to easily update operation summaries, descriptions, tags, and API information without having to remember the corresponding OpenAPI YAML markup. You can switch between the Code Editor and Visual Editor by using the sidebar buttons in the API Hub for Design editor.Visual Editor for OpenAPI Definitions

Click the image to enlarge it.

Integration with Azure DevOps Services (formerly Visual Studio Team Services, or VSTS). Use it to push your API definition or the generated client/server code to a specific repository in Azure DevOps Services. The integration is available for both OpenAPI 2.0 and OpenAPI 3.0 definitions.Azure DevOps Services Integration

Added safety measures to protect organization owners from accidentally deleting organizations with an active plan. Now, an organization's plan must be canceled before the organization can be deleted.

Updated Swagger Editor to 3.6.26, which improves autocompletion for OAS3 schema components.

Updated Swagger UI to 3.22.0, which includes support for GFM table syntax in OpenAPI 3.0 descriptions and improved styles for <pre> code blocks.

Docs Branding. Organizations can upload a logo for use in consumer-facing documentation. This custom logo will be displayed in all API docs and domain docs of the organization.Custom Branding for API Documentation

Click the image to enlarge it.

Support for auto-provisioning Bitbucket integration via the API Hub for Design Maven plugin.

Updated Swagger Codegen to v. 3.0.7 for OpenAPI 3.0 and v. 2.4.4 for OpenAPI 2.0.

Updated Swagger Editor to v. 3.6.25.

Lazy loading of external $refs. API Hub for Design editor and interactive documentation now load external $refs (such as domain references) only when they are required to render a specific operation. Loading happens, for example, when a user expands an operation in the API docs. This reduces the API load time and improves performance.Lazy Loading

Domains display additional OpenAPI 3.0 components: request bodies, headers, examples, links, and callbacks.

Support for auto-provisioning GitHub integration via the API Hub for Design Maven plugin.

Updated Swagger Editor to v. 3.6.24.

Updated Swagger UI to v. 3.21.0, which includes styling improvements and support for x-www-form-urlencoded request bodies without explicitly-defined properties.

OpenAPI 3.0 support for Domains. OAS3 Domains can include additional component types – request bodies, response headers, examples, links, and callbacks.

Updated Swagger Editor to v. 3.6.21, which improves OpenAPI 3.0 syntax validation.

Updated Swagger UI to v. 3.20.7.

Updated Swagger Codegen to v. 3.0.5 and 2.4.2.

OpenAPI 3.0 support in the Amazon API Gateway integration.

Request duration in "try it out" results.

Updated Swagger UI to v. 3.20.6.

Improved domain syntax validation.

Moved documentation generators to a separate Documentation submenu in the Export menu.

Added the View Documentation button in the editor to open the API documentation in a new browser tab.

Rearranged organization settings pages into vertical tabs.

Updated Swagger Editor to v. 3.6.20 and Swagger UI to v. 3.20.5, which include the following improvements:

API Hub for Design API improvement: Added the oas parameter to POST /apis/{owner}/{api} to specify the OpenAPI Specification version used in the uploaded definition.

Updated Swagger Editor to v. 3.6.19.

Updated Swagger UI to v. 3.20.4.

Updated OAS3 Swagger Codegen to v. 3.0.4.

Branding updates.

Added 8 new regions to the AWS API Gateway integration: us-east-2, ap-south-1, ap-northeast-3, ca-central-1, eu-west-2, eu-west-3, cn-north-1, cn-northwest-1.

Added new OpenAPI 2.0 code generators: php-symfony (server), skala-gatling and typescript-inversify (clients).

Updated Swagger Editor to 3.6.17.

Updated Swagger UI to 3.20.2, which adds rendering of OpenAPI 3.0 server descriptions.