SwaggerHub Changelog

This page contains the release notes for features and updates to SwaggerHub SaaS platform.

For SwaggerHub On-Premise release notes, see this page.

June 8, 2020

• Visual Editor improvements:

  • Add new schemas (models) by clicking the “+” button next to the schema list in the Navigation:

    

  • Delete operations and models from the Navigation panel.

• Download resolved definitions via SwaggerHub 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:

  • Warn about ignored header parameters in OpenAPI 3.0 definitions and suggest how to define those headers instead.
  • Warn about unused security schemes.
  • Show an error if minItems > maxItems.
  • Validate schemas in OpenAPI 3.0 response components.

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

  • Display parameter format in OpenAPI 3.0 definitions.
  • Support for Basic authentication with an empty password.

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

May 26, 2020

• Added the Rust server generator for OpenAPI 2.0.

May 12, 2020

Pushing to source control has become easier. The SwaggerHub editor now provides the “Push” button to trigger source control integrations, which works separately from the “Save” action. This way, you can save the API definition changes incrementally and only push to the source control repository when ready to do so.

You can also provide a custom commit message when pushing the changes.

Note: Non-source control integrations – API Auto Mocking and Webhooks – are still triggered on save.

April 29, 2020

• Improved syntax validation for OpenAPI 3.0 domains.

April 14, 2020

• 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:

  • Node.js 12
  • Node.js 10
  • Python 3.8
  • Python 3.7
  • Python 3.6
  • Python 2.7

  Note: Node.js 4.3 was removed because it is no longer supported by Lambda. If you used this version, you will need to update your integrations to a newer version of Node.js.

• 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.

March 30, 2020

• 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.

  

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

• 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.

March 16, 2020

• SwaggerHub IP addresses have been changed. If you whitelist our IPs in your firewall, make sure to update your firewall rules.

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

  

March 9, 2020

• 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 SwaggerHub pages. The titles now better indicate what is in each tab, making it easier to work with multiple SwaggerHub pages open at the same time.

  

February 6, 2020

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

• Updated Swagger UI to v. 3.25.0, which adds support for the x-tokenName extension in OpenAPI 3.0 definitions.

• Updated dialog box styles.

January 23, 2020

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

• Extended Designer permissions:

  • Designers can transfer APIs and domains to organizations where they have Create permissions.
  • Designers can add APIs and domains to projects.

• 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.

  

January 8, 2020

• New code generators for OpenAPI 3.0:
  • Node.js server
  • Python client

December 9, 2019

• 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.

  Note: The “created by” information is only available for versions created after November 26, 2019.

  

• 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:

  • Added a check for mismatching letter case in path parameter names and the corresponding path segments (for example, if the path is /users/{ID}, but the parameter name is id).

  • Improved the warning about sibling keywords alongside $ref to suggest possible solutions.

• Updated Swagger UI to v. 3.24.3.

November 26, 2019

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

• New code generators:

  • Go server for OpenAPI 3.0
  • Swift 5 client for OpenAPI 2.0

• New search keywords, standardization:critical and standardization:warning, let you find APIs with standardization errors and warnings, respectively.

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

October 31, 2019

• Updated Swagger Codegen to v. 3.0.13 for OpenAPI 3.0 and v. 2.4.9 for OpenAPI 2.0.
• Minor UI updates.

October 16, 2019

• Updated application colors.
• The Navigation panel in Code Editor is now resizable.

September 30, 2019

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

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

• SwaggerHub sidebar now provides quick access to user settings, organization settings, and project settings via the button.

  

• 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.

September 16, 2019

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

  

• Updated Swagger Editor to v. 3.6.34.

• Updated Swagger UI to v. 3.23.8.

September 2, 2019

• 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.

August 22, 2019

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

  

• Updated Swagger UI to v. 3.23.3.

• Updated Swagger Editor to v. 3.6.31.

August 7, 2019

• Integration with self-hosted Bitbucket Servers.

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

  

July 22, 2019

• 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.

  

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

July 15, 2019

• Increased the “try it out” timeout to 30 seconds for requests routed via SwaggerHub proxy.

July 9, 2019

• 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.

  Note: Users who configured this integration for OpenAPI 2.0 APIs before July 9, 2019 need to re-authenticate the integration by clicking the Sign in with Microsoft button in the integration settings. Old tokens will continue to work until they expire.

  

• Support for auto-provisioning GitLab integration via the SwaggerHub 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.

June 24, 2019

• Single sign-on is now available to organizations on the Enterprise plan. SwaggerHub SaaS currently supports the following identity providers:
  • Azure Active Directory (Azure AD)
  • Okta
  • OneLogin
  • PingFederate 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.

June 10, 2019

• Visual Editor now lets you manage tags and edit tag metadata.
• Updated Swagger Editor to v. 3.6.29 and Swagger UI to v. 3.22.2.

May 29, 2019

• 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.

May 15, 2019

• 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 SwaggerHub 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.

  

• 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.

April 29, 2019

• 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 SwaggerHub Maven plugin.

April 15, 2019

• 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 SwaggerHub editor.

  

• 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.

• Added safety measures to protect organization owners from accidentally deleting organizations with an active plan. Now, an organization’s plan must be cancelled 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.

April 1, 2019

• 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.

  

• Support for auto-provisioning Bitbucket integration via the SwaggerHub 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.

March 19, 2019

• Lazy loading of external $refs. SwaggerHub 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.
  Note: Lazy loading affects how domain errors are surfaced in the API editor. Learn more.
• Domains display additional OpenAPI 3.0 components: request bodies, headers, examples, links, and callbacks.
• Support for auto-provisioning GitHub integration via the SwaggerHub 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.

March 4, 2019

• 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.

February 19, 2019

• 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.

February 5, 2019

• 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:
  • Displaying request body descriptions for OpenAPI 3.0 form data requests.
  • Markdown support in OpenAPI 3.0 form field descriptions.
  • Markdown support in response header descriptions.

January 21, 2019

• SwaggerHub 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.

January 8, 2019

• 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.