Operation Badges
Each operation can have different badges that indicate its state, for example if it is deprecated, the operation id, etc. The available badges are:
deprecatedoperationId
By default, only the deprecated badge is shown, as appropriate. You can customize the operation badges using the useTheme({ operation: { badges: string[] }) function. The order in which you set the badges is the order in which they will be displayed.
Example
---
aside: false
outline: false
title: vitepress-openapi
---
<script setup lang="ts">
import { onBeforeMount, onBeforeUnmount } from 'vue'
import { useTheme } from 'vitepress-openapi/client'
onBeforeMount(() => {
useTheme({
operation: {
badges: ['deprecated', 'operationId'],
},
})
})
</script>
<OASpec />Preview
The Argentine Rock Legends is an example OpenAPI specification to test OpenAPI tools and libraries. Get all the data for all artists.
Inspired by Scalar Galaxy
Resources
- https://github.com/enzonotario/vitepress-openapi
- https://github.com/OAI/OpenAPI-Specification
Markdown Support
All descriptions can contain tons of text Markdown. If GitHub supports the syntax, chances are we’re supporting it, too. You can even create internal links to reference endpoints.
Examples
Blockquotes
I love Argentine Rock. <3
Tables
| Feature | Availability |
|---|---|
| Markdown Support | ✓ |
Accordion
<details>
<summary>Using Details Tags</summary>
<p>HTML Example</p>
</details>
Images
Yes, there’s support for images, too!
Contact
Servers
Get all artists
Get a list of all legendary Argentine Rock artists and explore their contributions to the music scene. You can get one using the GETGet an artist endpoint.
Parameters
Query Parameters
The number of items to return
102050"int64"10The number of items to skip before starting to collect the result set
123456"int64"0Responses
Add a new artist
Add a new legendary Argentine Rock artist. Make sure they truly deserve the title! You can view it later using the GETGet an artist endpoint.
Authorizations
Request Body
Responses
Get an artist
Learn more about a specific Argentine Rock artist and their legacy. You can update it using the PUTUpdate an artist endpoint.
Parameters
Path Parameters
1"int64"Responses
Update an artist
Update the information of a legendary Argentine Rock artist. Make sure to provide accurate data. You can get the current data using the GETGet an artist endpoint.
Authorizations
Parameters
Path Parameters
1"int64"Request Body
Responses
Delete an artist
This endpoint was used to delete artists. Unfortunately, that caused a lot of controversy. So, this endpoint is now deprecated and should not be used anymore. You can use the PUTUpdate an artist endpoint instead.
Authorizations
Parameters
Path Parameters
1"int64"Responses
Get all albums
Get a list of all albums from a legendary Argentine Rock artist. You can add a new album using the POSTAdd a new album endpoint.
Parameters
Path Parameters
1"int64"Query Parameters
The number of items to return
102050"int64"10The number of items to skip before starting to collect the result set
123456"int64"0Responses
Add a new album
Add a new album to a legendary Argentine Rock artist. Make sure it's a masterpiece! You can view all albums using the GETGet all albums endpoint.
Authorizations
Parameters
Path Parameters
1"int64"Request Body
Responses
Authentication
Some endpoints are public, but some require authentication. We provide all the required endpoints to create an account and authorize yourself.
Operations
Create a user
Create a user account to access exclusive content about Argentine Rock legends. After signing up, you can access endpoints like GETGet all artists to explore the data.
Request Body
Responses
Custom Prefix
You can also customize the prefix of the badges by setting the operation.badgePrefix.{badgeName} key in the i18n messages. For example, in your .vitepress/theme/index.ts, before calling theme.enhanceApp({ app }), you can set the following:
import { locales, theme, useTheme } from 'vitepress-openapi/client'
import DefaultTheme from 'vitepress/theme'
import 'vitepress-openapi/dist/style.css'
export default {
extends: DefaultTheme,
enhanceApp({ app }) {
useTheme({
i18n: {
messages: {
en: {
...locales.en,
'operation.badgePrefix.operationId': 'Operation ID: ',
},
es: {
...locales.es,
'operation.badgePrefix.operationId': 'ID de operación: ',
},
},
},
})
// Use the theme.
theme.enhanceApp({ app })
},
}