Releases: enzonotario/vitepress-openapi
Releases · enzonotario/vitepress-openapi
v0.0.3-alpha.48
🚀 Features
- useSidebar:
- MethodAliases option to customize method bag - by @enzonotario in #121 (50d18)
- useTheme:
- Add
defaultTagDescription
config - by @enzonotario in #114 (238d4) - Allows to customize CodeSamples langs/generator - by @enzonotario in #116 (4636f)
- Add
🐞 Bug Fixes
- PathsSummary: Allows to navigate to Operations with {} chars - by @enzonotario in #117 (7ff03)
View changes on GitHub
v0.0.3-alpha.47
🐞 Bug Fixes
- spec: Generate defaultTag for operations that has no tags - by @enzonotario in #106 (933cc)
View changes on GitHub
v0.0.3-alpha.46
🚀 Features
- OASpec: Allows to specify tags - by @enzonotario (c2ff0)
- usePaths: Add
getTags
to generate pages based on tags - by @enzonotario (de893) - useSidebar: Add
itemsByTags
to generate sidebar based on tags - by @enzonotario (c7139)
View changes on GitHub
v0.0.3-alpha.45
🐞 Bug Fixes
- operation slots: Include Parameters slots by default - by @enzonotario (78e67)
View changes on GitHub
v0.0.3-alpha.44
🚨 Breaking Changes
- OAOperation: Use hideBranding instead of hideDefaultFooter prop - by @enzonotario (3904a)
🚀 Features
- usePaths:
- Composable to generate paths routes - by @enzonotario (99dcd)
- OASpec:
- Expose OAOperation slots to extend in OASpec - by @enzonotario (82004)
- useTheme:
- Allows to avoid circulars in schemas - by @enzonotario (f9208)
- LazyRendering for tags/paths - by @enzonotario (18455)
- Allows to configure operation's slots and cols - by @enzonotario (c92c5)
View changes on GitHub
v0.0.3-alpha.43
🚀 Features
- OAParameter: Show example/s value/s - by @enzonotario in #94 (5c71d)
View changes on GitHub
v0.0.3-alpha.42
🚨 Breaking Changes
- OAPath: Remove
end-top
slot - by @enzonotario (5ab61)
🚀 Features
- openapi: Add getOpenApiInstance to manage between custom/injected/global specs - by @enzonotario (23a20)
View changes on GitHub
If using have configured the Theme to use a Global Spec, it's recommended to update your configuration to:
import DefaultTheme from 'vitepress/theme'
import type { Theme } from 'vitepress'
import { theme, useOpenapi } from 'vitepress-openapi'
import 'vitepress-openapi/dist/style.css'
import spec from '../../public/openapi.json' assert { type: 'json' }
export default {
extends: DefaultTheme,
async enhanceApp({ app, router, siteData }) {
// Set the OpenAPI specification.
const openapi = useOpenapi({ spec })
app.provide('openapi', openapi) // <--- provide openapi instance
// Use the theme.
theme.enhanceApp({ app })
}
} satisfies Theme
See more: https://vitepress-openapi.vercel.app/guide/getting-started.html#theme-configuration
v0.0.3-alpha.41
🐞 Bug Fixes
- hasExample: Consider
examples
- by @enzonotario (0662f) - openapi: Avoid parsing spec on every Operation, for better performance when using
OASpec
- by @enzonotario (e07cd)
View changes on GitHub
v0.0.3-alpha.40
🐞 Bug Fixes
- OAPaths: Correctly display
hr
line after every Operation - by @enzonotario (c5b6a) - OpenApi: Default securitySchemes object - by @enzonotario (c3072)
View changes on GitHub
v0.0.3-alpha.39
🚀 Features
- Spec: Group by tags - by @enzonotario (1c09b)
🐞 Bug Fixes
- playground variables: Handle Boolean parameters with Checkbox - by @enzonotario (b9fd4)