Skip to content

Commit

Permalink
feat(open-api): add servers display if set
Browse files Browse the repository at this point in the history
INT-407
  • Loading branch information
FreekVR committed Apr 16, 2024
1 parent 5d50d1f commit 92ec5d9
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/.vuepress/plugins/openApi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ ${document.security ? '## Authorization' : ''}
:security='${JSON.stringify(document.security ?? [])}'
:security-schemes='${JSON.stringify(document.components?.securitySchemes ?? [])}' />
${document.servers?.length ? '## Servers' : ''}
<OpenApiServers :servers='${JSON.stringify(document.servers ?? [])}' />
${renderPaths(document, document.paths, 'Endpoints')}
${renderPaths(document, document.webhooks, 'Webhooks')}
Expand Down
23 changes: 23 additions & 0 deletions src/.vuepress/theme/client/components/global/OpenApiServers.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<template>
<ul
v-if="servers?.length"
class="open-api-servers">
<li
v-for="(server, index) in servers"
:key="index">
<code>{{ server.url }}</code>
<Markdown
v-if="server.description"
:content="server.description" />
</li>
</ul>
</template>

<script setup lang="ts">
import {type OpenAPIV3_1 as OpenApiType} from 'openapi-types';
import Markdown from './Markdown.vue';
defineProps<{
servers: OpenApiType.Document['servers'];
}>();
</script>
2 changes: 2 additions & 0 deletions src/.vuepress/theme/client/components/global/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -84,3 +84,5 @@ export {default as OpenApiSchemaInfo} from './OpenApiSchemaInfo.vue';
export {default as OpenApiSecurityRequirements} from './OpenApiSecurityRequirements.vue';

export {default as OpenApiSecurityScheme} from './OpenApiSecurityScheme.vue';

export {default as OpenApiServers} from './OpenApiServers.vue';

0 comments on commit 92ec5d9

Please sign in to comment.