starlight-openapi

   🐞 Bug Fixes

• Fixes a request body rendering issue with implicit object schemas  -  by @HiDeoo (9f94d)

    View changes on GitHub

   🚀 Features

• Displays the description of objects before their properties  -  by @HiDeoo (cc93a)

   🐞 Bug Fixes

• Fixes a markdown rendering performance issue  -  by @HiDeoo (242a3)
• Fixes a potential crash when rendering examples  -  by @HiDeoo (0d0fc)
• Fixes authorization methods broken links  -  by @HiDeoo (b88eb)

    View changes on GitHub

   🚨 Breaking Changes

• Bumps minimum required Astro version to 4.2.7 and Starlight to 0.19.0  -  by @HiDeoo (c7fb9)

• Starlight OpenAPI is now a Starlight plugin  -  by @HiDeoo (322c3)

  You will need to update your Astro configuration to remove the previous version and add the new version as a Starlight plugin in your astro.config.mjs file:

  import starlight from "@astrojs/starlight";
  import { defineConfig } from "astro/config";
  -import { generateAPI } from 'starlight-openapi'
  +import starlightOpenAPI, { openAPISidebarGroups } from 'starlight-openapi'
  
  -// Generate the documentation and get the associated sidebar groups.
  -const { openAPISidebarGroups, starlightOpenAPI } = await generateAPI([
  -  {
  -    base: 'api',
  -    label: 'My API',
  -    schema: '../schemas/api-schema.yaml',
  -  },
  -])
  
  export default defineConfig({
    // …
    integrations: [
      starlight({
  +     plugins: [
  +       // Generate the OpenAPI documentation pages.
  +       starlightOpenAPI([
  +         {
  +         base: 'api',
  +         label: 'My API',
  +         schema: '../schemas/api-schema.yaml',
  +         },
  +       ]),
  +     ],
        sidebar: [
          {
            label: 'Guides',
            items: [{ label: 'Example Guide', link: '/guides/example/' }],
          },
          // Add the generated sidebar groups to the sidebar.
          ...openAPISidebarGroups,
        ],
        title: "My Docs",
      }),
  -   // Add the Starlight OpenAPI integration.
  -   starlightOpenAPI(),
    ],
  });
  

   🚀 Features

• Renders code example using Expressive Code  -  by @HiDeoo (4d93a)

   🐞 Bug Fixes

• Fixes issue where OpenAPI pages were missing a sidebar  -  by @HiDeoo (c774e)

    View changes on GitHub

   🚨 Breaking Changes

• Bump maximum supported Starlight version to 0.13.1  -  by @HiDeoo (dd21a)
  The Starlight OpenAPI integration is not compatible with Starlight 0.14.0 and above due to an upstream issue. Please follow this PR to track the progress regarding this issue.

   🐞 Bug Fixes

• Fixes remote schema download issue  -  by @HiDeoo (ebdcd)
• Fixes installation issue with Yarn by no longer relying on gitpkg to install a dependency  -  by @HiDeoo and Laurynas Keturakis (da6d8)

    View changes on GitHub

   🚀 Features

• Authorisations now link to their descriptions in the overview page  -  by @HiDeoo (b0667)

   🐞 Bug Fixes

• oneOf and anyOf UI rendering issues with object schemas  -  by @HiDeoo (3f38a)
• oneOf and anyOf UI rendering issues with array schemas  -  by @HiDeoo (2a12a)
• enum UI rendering issues with array schemas  -  by @HiDeoo (3af98)

    View changes on GitHub

   🚨 Breaking Changes

• Bump minimum required Astro version to 3.2.0 and Starlight to 0.11.0  -  by @HiDeoo (05b04)
  Due to some API changes in Starlight, all OpenAPI documentation pages will no longer display a sidebar. If you wish to preserve a sidebar on these specific pages until this is fixed, please stick to the 0.2.2 release and Starlight <0.11.0 for the time being.

    View changes on GitHub

   🚨 Breaking Changes

• Bump maximum supported Starlight version to 0.10.4  -  by @HiDeoo (9d80b)

   🐞 Bug Fixes

• Markdown related build issue  -  by @HiDeoo (f9a1c)

    View changes on GitHub

   🐞 Bug Fixes

• Improve model composition UI for non-object model definitions  -  by @HiDeoo (11019)

    View changes on GitHub

   🚨 Breaking Changes

• Bump minimum required Astro version to 3.0 and Starlight to 0.9.0  -  by @HiDeoo (47283)

   🐞 Bug Fixes

• Invalid page component import path  -  by @HiDeoo (c3e3a)
• Build error with Starlight v0.9.1  -  by @HiDeoo (32d33)
• Hide empty section panels  -  by @HiDeoo (a91ff)

    View changes on GitHub

   🚀 Features

• Initial public release.