[email protected]

Patch Changes

• #83 dc88650 Thanks @HiDeoo! - Ensures property titles are rendered when provided in a schema.

[email protected]

Minor Changes

• #80 d6175bc Thanks @HiDeoo! - Adds a new sidebar.operations.sort configuration option to configure the sorting method for the operation sidebar links.

  The current behavior to sort the operation sidebar links in the order they appear in the OpenAPI document is preserved by default. Setting this option to 'alphabetical' will sort the operation sidebar links alphabetically.

• #80 d6175bc Thanks @HiDeoo! - Deprecates the sidebar label, collapsed, and sidebarMethodBadges options in favor of a new sidebar option object.

  The previous options are still supported for backward compatibility, but they will be removed in a future release.

  starlightOpenAPI([
    {
      base: 'api',
      schema: '../schemas/api-schema.yaml',
  -   label: 'My API',
  -   collapsed: false,
  -   sidebarMethodBadges: true,
  +   sidebar: {
  +     label: 'My API',
  +     collapsed: false,
  +     operations: { badges: true },
  +   },
    },
  ])

• #80 d6175bc Thanks @HiDeoo! - Adds a new sidebar.tags.sort configuration option to configure the sorting method for the tag sidebar groups.

  The current behavior to sort the tag sidebar groups in the order they appear in the OpenAPI document is preserved by default. Setting this option to 'alphabetical' will sort the tag sidebar groups alphabetically.

• #80 d6175bc Thanks @HiDeoo! - Adds a new sidebar.operations.labels configuration option to define whether the operation sidebar labels should use the operation ID or summary.

  The current behavior to use the operation summary and fall back to the operation ID if no summary is provided is preserved by default. Setting this option to 'operationId' will always use the operation ID as the operation sidebar label.

Patch Changes

• #80 d6175bc Thanks @HiDeoo! - Fixes a rendering issue for model definition properties using nested allOf properties.

• #80 d6175bc Thanks @HiDeoo! - Fixes a syntax highlighting issue for response examples defined at the object-level in a reference of the components section.

[email protected]

Minor Changes

• #75 52dd833 Thanks @HiDeoo! - ⚠️ BREAKING CHANGE: The minimum supported version of Starlight is now version 0.32.0.

  Please use the @astrojs/upgrade command to upgrade your project:

  npx @astrojs/upgrade

[email protected]

Patch Changes

• #73 beeb586 Thanks @HiDeoo! - Adds astro as a peer dependency to prevent potential build errors in monorepos with hoisting disabled.

[email protected]

Minor Changes

• #70 b6679d7 Thanks @HiDeoo! - Improves formatting of query parameter examples based on the style and explode property values and the RFC 6570 URI template specification.

[email protected]

Minor Changes

• #67 194dfe7 Thanks @HiDeoo! - Adds a new sidebarMethodBadges schema configuration option to display badges next to sidebar operation links with the associated HTTP method.

[email protected]

Minor Changes

• #63 b19e249 Thanks @HiDeoo! - Adds overview pages for operations grouped by tags defined with a description or externalDocs fields displaying the tag's information.

[email protected]

Minor Changes

• #58 f91f2f4 Thanks @HiDeoo! - Adds support for Astro v5, drops support for Astro v4.

  ⚠️ BREAKING CHANGE: The minimum supported version of Starlight is now 0.30.0.

  Please follow the upgrade guide to update your project.

v0.8.3

   🐞 Bug Fixes

• Fixes an invalid link for security schemes when using the Astro base option  -  by @taiseimiyaji and @HiDeoo (87fb6)

    View changes on GitHub

v0.8.2

   🐞 Bug Fixes

• Fixes an issue where model definitions using oneOf or anyOf could be ignored when combined using the allOf keyword  -  by @HiDeoo (4ae04)

    View changes on GitHub