starlight-openapi@0.14.0

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.