Skip to main content
Swagger
All documentation pages

Version 2.14

2.14 - May 22, 2026

Caution

Action required - CPU architecture requirement change

Swagger Codegen has been rebuilt on a new base image (Red Hat UBI 10), leading to stricter CPU requirements. Before upgrading, verify that all Kubernetes nodes running the Codegen workload meet the following minimum requirement: a CPU with x86-64-v3 (also referred to as x86_64-v3) microarchitecture support.

Most Intel Haswell (4th gen, 2013+) and AMD Excavator/Zen CPUs support x86-64-v3. For nodes using older hardware, the Codegen container fails to start after the upgrade. Contact SmartBear Support if unsure whether your environment is affected.

Caution

Database end-of-life notice

The following database versions have reached end of life and are removed from the supported versions list and preflight checks in this release:

  • MongoDB 5.0 - EOL for more than 18 months

  • PostgreSQL 13 - EOL for more than 6 months

Instances running on these versions will continue to operate. However, SmartBear no longer validates compatibility and recommends upgrading your external databases to a supported version as soon as possible to avoid future issues. See Database requirements for the current list of supported database versions.

  • Stoplight Elements documentation preview:

    • Swagger Studio now includes Stoplight Elements as an additional documentation preview option, available both inside the editor and on standalone documentation pages. This brings feature parity with the Portal/Stoplight consumer experience and gives users a familiar API documentation format. For details, refer to the Stoplight Elements documentation.
  • Modern Monaco editor (v5) replaces the Ace.js editor (v4):

    • The introduction of new Monaco-based editor improves the editing experience with features such as real-time field-level syntax highlighting, on-hover documentation display, interactive overview navigation, click-to-select comment blocks and AI-powered capabilities.

    • Added the following enhancements:

      • “Open in Explore” support for OpenAPI 3.1.

      • Diff Mode for OpenAPI 2.0 and 3.0.

      • Unified form editor for OpenAPI 2.0.

      • Draft mode support for OpenAPI 3.1 and AsyncAPI.

  • AsyncAPI 3.0.0 full support:

    • Full support for the AsyncAPI 3.0.0 specification is now available across the Swagger Studio ecosystem, including domains. This brings syntax highlighting, autocomplete, hover documentation, validation, and specification-level governance for AsyncAPI 3.0 definitions. For more details on the available features and limitations, see AsyncAPI Support.
  • Initial OpenAPI 3.2 support:

    • Swagger Editor now offers foundational support for OpenAPI 3.2, including syntax highlighting, autocomplete, and validation. Additionally, you can render and browse OpenAPI 3.2 documentation.

      This is an initial release. Advanced features such as code generation, integrations with external products, and full Elements support are not yet available and will be introduced in subsequent releases.

  • Spectral Ruleset Editor:

    • The Governance page now includes a multi-file editor for creating, editing, and publishing Spectral rulesets (.spectral.yaml) together with their custom functions. The editor covers file and folder operations, syntax highlighting, in-editor validation, and bundled publishing to the Governance page. Permissions are aligned with existing Governance rules.

      Not included in this release: in-editor validation for try-it-out specs and inline validation of the ruleset itself.

  • Swagger Portal updates:

    • Revision history and autosave for Swagger Portal HTML pages - Swagger Portal now supports revision history and autosave for HTML page editing. The system autogenerates revisions on save and publish actions. You can also create manual revisions with custom labels. Each revision carries a shareable link with user attribution. Autosave runs at configurable intervals.

    • Customizable portal footer - Providers can now configure a customizable footer for the consumer-facing portal. Options include an enable/disable toggle, legal notice text, separate images for light and dark mode, and up to six managed links (add, edit, delete, reorder). The footer renders responsively on the consumer side.

    • Portal ingress allowlist mode - subdomain restriction - Customers with strict security policies can disable the wildcard *.portal.<instance> subdomain and instead define an explicit comma-separated allowlist of permitted subdomains. When ingressType: allowlistis configured, only the listed subdomains are accessible. Portals created or edited outside the allowlist are handled gracefully with a clear error message.

      Helm values configuration:

      ingress:
          portal:
              # "glob" (default) or "allowlist"  
              ingressType: allowlist
              # Comma-separated list of allowed subdomains
              allowedSubdomains: product1, product2

      With the example above, portals are accessible at product1.portal.example.com and product2.portal.example.com.

  • AI-powered features updates:

    • Generate MCP Server code from the API catalog - You can now trigger Generate MCP Server from any API in the catalog to automatically produce TypeScript-based Model Context Protocol (MCP) server code derived from the API’s endpoints. The generated code covers all available endpoints and you can copy it for local use. The platform does not store the generated code.

    • Generate API definitions from existing code - You can now generate OpenAPI or AsyncAPI definitions directly from an existing codebase. After you select source files and target specification type, Swagger Studio generates the definition and saves metadata related to the source files. Supported languages are: JavaScript, TypeScript, Python, Java.

  • SSO and user management updates:

    • First name and last name mapping for LDAP and SAML SSO - SSO integrations with LDAP and SAML now support first name and last name attribute mapping, so that user accounts in Swagger Studio display human-readable screen names instead of raw identifiers.
  • Technical changes and infrastructure updates:

    • Search: OpenSearch replaces Elasticsearch - Enabling enhanced search now deploys OpenSearch instead of Elasticsearch. OpenSearch is API- and feature-compatible and offers a more stable release cycle, compatibility with cloud-provider hosted OpenSearch services, and Docker Hardened Image builds with near-zero critical/high vulnerabilities. Helm-based installations that explicitly require Elasticsearch can still configure it; consult the Helm values reference for details.

    • Swagger Codegen: New base image (Red Hat UBI 10) - Swagger Codegen has been rebuilt using a Red Hat UBI 10 base image. UBI 10 requires a CPU with x86- 64-v3 microarchitecture support (Intel Haswell / 4th Generation 2013+ or AMD Excavator/Zen equivalent). Nodes that do not meet this requirement fail to run the Codegen container after the upgrade.

    • Architecture changes:

      • The Config Service has been removed. All application configuration is now handled through standard Kubernetes mechanisms: ConfigMaps, init containers, and shared ephemeral in-memory volumes.

      • The swagger-converter-api deployment and service have been removed.

      The system now ignores the Helm values referencing converter or config-service settings - remove them from your values.yaml.

  • Helm values updates:

    • Together with the updated values.yaml, this release includes a distilled README.md bundled with the chart. The README documents all available values with descriptions, default settings, and usage notes. Use it as a quick reference alongside the inline comments in values.yaml.

    • Replicated SDK is now a Helm subchart - The Replicated SDK, component responsible for on-premise instance licensing, is now bundled as a subchart of the Swagger Studio Helm chart and is configured using the top-level replicated: key.

      replicated:
          image:
              repository: "library/replicated-sdk-image"
              # tag: 1.x.x
          priorityClassName: ""
          commonLabels: {}
          commonAnnotations: {}
          replicaCount: 1

      The replicated: block accepts all standard Replicated SDK subchart values. For the full list of available configuration options, see Replicated SDK values.yaml reference on GitHub. Any values not explicitly defined use the subchart’s defaults.

    • Custom metrics collection - A new customMetrics block enables Replicated to collect instance-level usage metrics as part of support bundles, giving SmartBear visibility into how on-premise instances are used. Collection is enabled by default.

      customMetrics:
          enabled: true
          # Delay before first collection (default: 30 minutes)
          initialDelay: 1800
          # Collection interval (default: 24 hours)
          collectionInterval: 86400
    • Security context overrides - All pod and container security contexts are now overridable from the values file:

      # Pod security context
      podSecurityContext:
          runAsUser: 1001
          runAsGroup: 1001
          fsGroup: 1001
          supplementalGroups: [1001]
          seccompProfile:
              type: "RuntimeDefault"
      # Container security context
      containerSecurityContext:
          runAsNonRoot: true
          readOnlyRootFilesystem: true
          allowPrivilegeEscalation: false
          capabilities:
              drop: ["ALL"]
    • Helm values updates - full summary:

      Change Key / section Notes
      Added replicated.* Replicated SDK subchart configuration. See SDKvalues.yaml reference.
      Added customMetrics.* Controls custom metrics collection (enabled, initialDelay, collectionInterval).
      Added ingress.portal.ingressType glob (default) or allowlist.
      Added ingress.portal.allowedSubdomains Comma-separated list of allowed subdomains when ingressType: allowlist. Example: product1, product2 .
      Added podSecurityContext / containerSecurityContext All security contexts are now overridable from the values file.
      Removed telemetry.* Superseded by customMetrics.*. Remove from your values.yaml.
      Removed Converter-related values swagger-converter-api has been removed.
      Removed Config-service-related values Config service has been removed.
  • Maintenance operation command updates:

    • The updated delete-user maintenance command now takes a user email address as its identifier parameter. Previously, a username was required.
  • Miscellaneous:

    • Swagger Studio introduces consistent, structure-based breadcrumbs for simplified navigation. With this enhancement, you can easily track your location within the content structure.

    • Code editor now features modernized design with refreshed visuals, unified navigation between editor modes, and improved panel resizing.

    • You can now update DNS-related fields in swaggerhub_portal and swaggerhub_virtserver databases using the improved bulk-replace maintenance command. This resolves breakage after DNS changes or instance migrations.

    • Various stability and security fixes.

  • Cluster component updates:

    • Updated KOTS to version: 1.130.2.

    • Updated OpenShift to version: 4.20.21.

  • kURL installer:curl -sSL https://kurl.sh/swaggerhub-2-14-0 | sudo bash

  • Upgrade notes (2.13.x → 2.14.0):

    1. Verify CPU compatibility. Confirm all Kubernetes nodes running the Codegen workload support the x86- 64-v3 microarchitecture before you proceed with the upgrade.

    2. Review and update Helm values. Remove deprecated keys (telemetry, converter, and config-service sections) from your values.yaml. Add the replicated:  block if you need to customize Replicated SDK settings. Refer to the bundled README.md inside the chart for a full values reference.

    3. Configure Portal ingress if required. To enforce a Portal subdomain allowlist, set ingress.portal.ingressType: allowlist and provide ingress.portal.allowedSubdomains as a comma-separated list of permitted subdomains.

    4. Plan database upgrades. MongoDB 5.0 and PostgreSQL 13 are no longer in the supported versions list. SmartBear recommends upgrading external databases to a supported version prior to or shortly after this upgrade.

    5. Update operator automation for delete-user. The delete-user command now requires an email address as the identifier instead of a username.

    6. Run preflight checks. Execute the preflight checks provided in the installer to validate environment readiness before applying the upgrade.

Was this page helpful?