Releases: HiDeoo/starlight-openapi
Releases · HiDeoo/starlight-openapi
v0.6.3
v0.6.2
🐞 Bug Fixes
- Fixes an issue preventing operations with identical IDs but different methods from having distinct generated pages - by @HiDeoo (e0d68)
View changes on GitHub
v0.6.1
🐞 Bug Fixes
View changes on GitHub
v0.6.0
v0.5.0
🚨 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
🐞 Bug Fixes
View changes on GitHub
v0.4.0
🚨 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
v0.3.1
v0.3.0
🚨 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.