Skip to content

Releases: swagger-api/swagger-ui

Swagger UI v5.20.0 Released!

27 Feb 10:42
Compare
Choose a tag to compare

5.20.0 (2025-02-27)

Bug Fixes

  • docker: add OpenContainer labels
  • json-schema-5: fix JumpToPath feature for schemas, closes swagger-api/swagger-editor#4035
  • fix JumpToPath feature for auth methods
  • display the correct name of security methods
  • fix console errors appearing when security scheme is not defined
  • components: render examples only when their shape is correct
  • swagger-client: allow resolving URLs without extensions, closes swagger-api/apidom#4298
  • css: fix css sourcemaps
  • security: update axios to address CVE-2024-39338
  • swagger-client: do not encode server variables, closes swagger-api/swagger-js#3656
  • security: fix unsafe cookie serialization, addresses CVE-2024-47764, GHSA-pxg6-pf52-xh8x
  • spec: compensate if OpenAPI.paths field is defined as unexpected structure
  • json-schema-2020-12: check for schema type before extracting extension keywords, closes swagger-ui/issues#9376
  • json-schema-2020-12: fix rendering of uniqueItems keyword
  • json-schema-2020-12: fix overrides of JSON Schema extension keywords
  • spec: clear JSON state when loading a new definition
  • oas31: fix caching of JSON Schema 2020-12 context
  • json-schema-2020-12: fix default expansion being applied to components after initial render
  • json-schema-2020-12: fix complex schemas expanding beyond the default expansion depth
  • json-schema-2020-12: fix deep expansion not expanding some of the keywords
  • oas31: fix expansion of Schema Object fixed fields

Features

  • swagger-ui-react: add support for initialState prop
  • add horizontal scrollbar for schemas, refs swagger-api/swagger-ui#8940
  • display schema of complex parameters
  • display schema of complex request body properties
  • json-schema-2020-12: allow to use fn outside of React context
  • oas31: display schema of complex parameters with union type
  • oas31: display schema of complex request body properties with union type
  • oas31: display textarea for parameters with complex union type
  • json-schema-2020-12: allow to use getTitle outside of JSON Schema 2020-12 context
  • json-schema-2020-12: introduce system bound HOC
  • json-schema-2020-12: add support for rendering extension keywords, closes swagger-ui/issues#9376
  • json-schema-2020-12: add support for rendering examples keyword
  • json-schema-2020-12: use JSON Viewer to display keywords with complex values
  • json-schema-2020-12: handle empty objects and arrays in JSONViewer
  • oas3: more support for OpenAPI 3.0.4
  • introduce custom URL sanitization mechanism
  • apply additional fixes for custom URL sanitization mechanism
  • oas31: add support for OpenAPI extensions
  • json-schema-2020-12: respect showExtensions config option

Attributions (alphabetical order)

@char0n
@glowcloud
@robert-hebel-sb

Swagger UI v5.19.0 Released!

17 Feb 16:43
Compare
Choose a tag to compare

5.19.0 (2025-02-17)

Features

Swagger UI v5.18.3 Released!

29 Jan 07:55
Compare
Choose a tag to compare

5.18.3 (2025-01-28)

Enhancements

  • docker: document new SwaggerUI docker registry usage (#10260) (9d6fdb2)

SwaggerUI Docker image is now served under the new authoritative registry URL:

Before:

$ docker pull swaggerapi/swagger-ui

Now:

$ docker pull docker.swagger.io/swaggerapi/swagger-ui

Swagger UI v5.18.2 Released!

07 Nov 14:52
Compare
Choose a tag to compare

5.18.2 (2024-11-07)

Bug Fixes

Swagger UI v5.18.1 Released!

05 Nov 21:48
Compare
Choose a tag to compare

5.18.1 (2024-11-05)

Bug Fixes

Swagger UI v5.18.0 Released!

05 Nov 14:14
Compare
Choose a tag to compare

5.18.0 (2024-11-05)

Features

  • analytics: use Scarf.js to provide anonymized installation analytics (#10194) (fb55b9c)

Anonymized analytics

SwaggerUI uses Scarf to collect anonymized installation analytics. These analytics help support the maintainers of this library and ONLY run during installation. To opt out, you can set the scarfSettings.enabled field to false in your project's package.json:

// package.json
{
  // ...
  "scarfSettings": {
    "enabled": false
  }
  // ...
}

Alternatively, you can set the environment variable SCARF_ANALYTICS to false as part of the environment that installs your npm packages, e.g., SCARF_ANALYTICS=false npm install.

Swagger UI v5.17.14 Released!

28 May 05:25
Compare
Choose a tag to compare

5.17.14 (2024-05-28)

Bug Fixes

Swagger UI v5.17.13 Released!

27 May 11:48
Compare
Choose a tag to compare

5.17.13 (2024-05-27)

Bug Fixes

Swagger UI v5.17.12 Released!

21 May 13:02
Compare
Choose a tag to compare

5.17.12 (2024-05-21)

Bug Fixes

  • config: define missing default options and their types (#9949) (04bbeaa), closes #9945
  • release: fix failed v5.17.11 release (a35a71e)
  • swagger-client: fix OpenAPI 3.1.0 dereferencing (#9950) (10e1a5f), closes #9941

Swagger UI v5.17.10 Released!

15 May 14:16
Compare
Choose a tag to compare

5.17.10 (2024-05-15)

Bug Fixes

  • components: add support for oneOf/anyOf JSON Schema keywords in parameter-row rendering (#9934) (9037acf), closes #7912
  • oas31: fix initial rendering of the Webhooks section (#9938) (b5c84f4), closes #9937