@dv.net/docs-vitepress-openapi 1.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +52 -0
- package/dist/docs-vitepress-openapi.client.cjs.js +1 -0
- package/dist/docs-vitepress-openapi.client.es.js +16 -0
- package/dist/docs-vitepress-openapi.css +1 -0
- package/dist/docs-vitepress-openapi.node.cjs.js +4102 -0
- package/dist/docs-vitepress-openapi.node.es.js +72981 -0
- package/dist/vanilla-picker-BAEwS4Fy.js +536 -0
- package/dist/vanilla-picker-m653iADl.cjs +8 -0
- package/package.json +80 -0
- package/src/client.ts +73 -0
- package/src/components/Common/Lazy/OALazy.vue +49 -0
- package/src/components/Common/Lazy/lazyBus.ts +8 -0
- package/src/components/Common/OACodeBlock.vue +91 -0
- package/src/components/Common/OACodeValue.vue +22 -0
- package/src/components/Common/OAHeaderBadges.vue +44 -0
- package/src/components/Common/OAHeading.vue +84 -0
- package/src/components/Common/OAInfo.vue +106 -0
- package/src/components/Common/OAIntroduction.vue +25 -0
- package/src/components/Common/OAJSONEditor.vue +41 -0
- package/src/components/Common/OAMarkdown.vue +28 -0
- package/src/components/Common/OAMethodBadge.vue +20 -0
- package/src/components/Common/OAServers.vue +42 -0
- package/src/components/Operation/OAOperation.vue +345 -0
- package/src/components/Operation/OAOperationTags.vue +30 -0
- package/src/components/Parameter/OAParameter.vue +80 -0
- package/src/components/Parameter/OAParameterAttribute.vue +44 -0
- package/src/components/Parameter/OAParameterExamples.vue +52 -0
- package/src/components/Parameter/OAParameters.vue +69 -0
- package/src/components/Path/OAPath.vue +347 -0
- package/src/components/Path/OAPathEndpoint.vue +99 -0
- package/src/components/Path/OAPaths.vue +62 -0
- package/src/components/Path/OAPathsByTag.vue +118 -0
- package/src/components/Path/OAPathsByTags.vue +99 -0
- package/src/components/Path/OAPathsSummary.vue +52 -0
- package/src/components/Playground/OAPlaygroundParameterInput.vue +97 -0
- package/src/components/Playground/OAPlaygroundParameters.vue +262 -0
- package/src/components/Playground/OAPlaygroundResponse.vue +74 -0
- package/src/components/Playground/OAPlaygroundSecurityInput.vue +44 -0
- package/src/components/Remote/OARemoteContext.vue +42 -0
- package/src/components/Remote/OARemoteOperation.vue +30 -0
- package/src/components/Remote/OARemoteRoot.vue +29 -0
- package/src/components/Remote/OARemoteSpec.vue +23 -0
- package/src/components/Request/OARequestBody.vue +24 -0
- package/src/components/Response/OAResponse.vue +81 -0
- package/src/components/Response/OAResponses.vue +119 -0
- package/src/components/Sample/OACodeSamples.vue +71 -0
- package/src/components/Schema/OASchemaPropertyAttributes.vue +44 -0
- package/src/components/Schema/OASchemaTabs.vue +90 -0
- package/src/components/Schema/OASchemaUI.vue +151 -0
- package/src/components/Security/OASecurity.vue +79 -0
- package/src/components/Security/OASecurityContent.vue +100 -0
- package/src/components/Spec/OASpec.vue +127 -0
- package/src/components/Spec/OASpecSkeleton.vue +26 -0
- package/src/components/Try/OATryItButton.vue +171 -0
- package/src/components/Try/OATryWithVariables.vue +105 -0
- package/src/components/index.ts +55 -0
- package/src/components/ui/badge/Badge.vue +18 -0
- package/src/components/ui/badge/index.ts +32 -0
- package/src/components/ui/button/Button.vue +28 -0
- package/src/components/ui/button/index.ts +37 -0
- package/src/components/ui/checkbox/Checkbox.vue +33 -0
- package/src/components/ui/checkbox/index.ts +1 -0
- package/src/components/ui/collapsible/Collapsible.vue +18 -0
- package/src/components/ui/collapsible/CollapsibleContent.vue +15 -0
- package/src/components/ui/collapsible/CollapsibleTrigger.vue +12 -0
- package/src/components/ui/collapsible/index.ts +3 -0
- package/src/components/ui/input/Input.vue +29 -0
- package/src/components/ui/input/index.ts +1 -0
- package/src/components/ui/label/Label.vue +29 -0
- package/src/components/ui/label/index.ts +1 -0
- package/src/components/ui/multiselect/Multiselect.vue +104 -0
- package/src/components/ui/select/Select.vue +15 -0
- package/src/components/ui/select/SelectContent.vue +56 -0
- package/src/components/ui/select/SelectGroup.vue +24 -0
- package/src/components/ui/select/SelectItem.vue +40 -0
- package/src/components/ui/select/SelectItemText.vue +12 -0
- package/src/components/ui/select/SelectLabel.vue +14 -0
- package/src/components/ui/select/SelectScrollDownButton.vue +29 -0
- package/src/components/ui/select/SelectScrollUpButton.vue +29 -0
- package/src/components/ui/select/SelectSeparator.vue +22 -0
- package/src/components/ui/select/SelectTrigger.vue +33 -0
- package/src/components/ui/select/SelectValue.vue +12 -0
- package/src/components/ui/select/index.ts +11 -0
- package/src/components/ui/tabs/Tabs.vue +15 -0
- package/src/components/ui/tabs/TabsContent.vue +24 -0
- package/src/components/ui/tabs/TabsList.vue +27 -0
- package/src/components/ui/tabs/TabsTrigger.vue +33 -0
- package/src/components/ui/tabs/index.ts +21 -0
- package/src/composables/useOpenapi.ts +70 -0
- package/src/composables/usePaths.ts +31 -0
- package/src/composables/usePlayground.ts +49 -0
- package/src/composables/useShiki.ts +46 -0
- package/src/composables/useSidebar.ts +301 -0
- package/src/composables/useTheme.ts +799 -0
- package/src/index.ts +8 -0
- package/src/json.css +251 -0
- package/src/lib/OpenApi.ts +254 -0
- package/src/lib/codeSamples/buildRequest.ts +149 -0
- package/src/lib/codeSamples/generateCodeSample.ts +20 -0
- package/src/lib/codeSamples/generateCodeSampleCurl.ts +150 -0
- package/src/lib/codeSamples/generateCodeSampleJavaScript.ts +29 -0
- package/src/lib/codeSamples/generateCodeSamplePhp.ts +50 -0
- package/src/lib/codeSamples/generateCodeSamplePython.ts +32 -0
- package/src/lib/codeSamples/request.ts +25 -0
- package/src/lib/constraintsParser.ts +30 -0
- package/src/lib/createOpenApiInstance.ts +18 -0
- package/src/lib/deepUnref.ts +76 -0
- package/src/lib/examples/getPropertyExample.ts +31 -0
- package/src/lib/examples/getPropertyExamples.ts +27 -0
- package/src/lib/examples/getSchemaExample.ts +38 -0
- package/src/lib/examples/getSchemaUiJson.ts +150 -0
- package/src/lib/examples/getSchemaUiXml.ts +9 -0
- package/src/lib/examples/hasExample.ts +26 -0
- package/src/lib/getOpenApiInstance.ts +39 -0
- package/src/lib/getSchemaUi.ts +280 -0
- package/src/lib/getSecurityUi.ts +33 -0
- package/src/lib/operationData.ts +24 -0
- package/src/lib/prepareOpenAPI/generateMissingOperationIds.ts +19 -0
- package/src/lib/prepareOpenAPI/generateMissingSummary.ts +20 -0
- package/src/lib/prepareOpenAPI/generateMissingTags.ts +36 -0
- package/src/lib/prepareOpenAPI/prepareOpenAPI.ts +35 -0
- package/src/lib/processOpenAPI.ts +131 -0
- package/src/lib/resolveCircularRef.ts +66 -0
- package/src/lib/sidebar/cleanSidebarItems.ts +19 -0
- package/src/lib/sidebar/ensureGroupTextSlashPrefix.ts +18 -0
- package/src/lib/sidebar/flatSidebarItems.ts +58 -0
- package/src/lib/sidebar/generateSidebarItemsByPaths.ts +132 -0
- package/src/lib/sidebar/mergeAdjacentGroups.ts +56 -0
- package/src/lib/sidebar/setItemCollapsedState.ts +15 -0
- package/src/lib/utils.ts +7 -0
- package/src/locales/en.json +50 -0
- package/src/locales/index.ts +4 -0
- package/src/style.css +180 -0
- package/src/types.ts +73 -0
- package/src/vite-env.d.ts +8 -0
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
<script setup>
|
|
2
|
+
import { inject } from 'vue'
|
|
3
|
+
import { getOpenApiInstance } from '../../lib/getOpenApiInstance'
|
|
4
|
+
|
|
5
|
+
const props = defineProps({
|
|
6
|
+
spec: {
|
|
7
|
+
type: Object,
|
|
8
|
+
required: false,
|
|
9
|
+
},
|
|
10
|
+
openapi: {
|
|
11
|
+
type: Object,
|
|
12
|
+
required: false,
|
|
13
|
+
},
|
|
14
|
+
})
|
|
15
|
+
|
|
16
|
+
const openapi = props.openapi ?? getOpenApiInstance({
|
|
17
|
+
custom: { spec: props.spec },
|
|
18
|
+
injected: inject('openapi', undefined),
|
|
19
|
+
})
|
|
20
|
+
|
|
21
|
+
const servers = openapi.getServers()
|
|
22
|
+
</script>
|
|
23
|
+
|
|
24
|
+
<template>
|
|
25
|
+
<div>
|
|
26
|
+
<OAHeading level="h2">
|
|
27
|
+
{{ $t('Servers') }}
|
|
28
|
+
</OAHeading>
|
|
29
|
+
|
|
30
|
+
<div class="flex flex-col space-y-4">
|
|
31
|
+
<div v-for="server in servers" :key="server.url" class="flex flex-col p-3 gap-2 rounded bg-muted">
|
|
32
|
+
<span class="font-semibold select-all">
|
|
33
|
+
{{ server.url }}
|
|
34
|
+
</span>
|
|
35
|
+
|
|
36
|
+
<span v-if="server.description" class="text-gray-600 dark:text-gray-300">
|
|
37
|
+
{{ server.description }}
|
|
38
|
+
</span>
|
|
39
|
+
</div>
|
|
40
|
+
</div>
|
|
41
|
+
</div>
|
|
42
|
+
</template>
|
|
@@ -0,0 +1,345 @@
|
|
|
1
|
+
<script setup lang="ts">
|
|
2
|
+
import type { OperationSlot } from '../../types'
|
|
3
|
+
import { computed, inject, useSlots } from 'vue'
|
|
4
|
+
import { getOpenApiInstance } from '../../lib/getOpenApiInstance'
|
|
5
|
+
import OAHeaderBadges from '../Common/OAHeaderBadges.vue'
|
|
6
|
+
import OAOperationTags from './OAOperationTags.vue'
|
|
7
|
+
|
|
8
|
+
const props = defineProps({
|
|
9
|
+
operationId: {
|
|
10
|
+
type: String,
|
|
11
|
+
required: true,
|
|
12
|
+
},
|
|
13
|
+
spec: {
|
|
14
|
+
type: Object,
|
|
15
|
+
required: false,
|
|
16
|
+
},
|
|
17
|
+
openapi: {
|
|
18
|
+
type: Object,
|
|
19
|
+
required: false,
|
|
20
|
+
},
|
|
21
|
+
prefixHeadings: {
|
|
22
|
+
// Whether to add prefixes to component headings (for the One Page view)
|
|
23
|
+
type: Boolean,
|
|
24
|
+
default: false,
|
|
25
|
+
},
|
|
26
|
+
hideDefaultFooter: {
|
|
27
|
+
/**
|
|
28
|
+
* @deprecated Use `hideBranding` instead
|
|
29
|
+
*/
|
|
30
|
+
type: Boolean,
|
|
31
|
+
default: undefined,
|
|
32
|
+
},
|
|
33
|
+
hideBranding: {
|
|
34
|
+
type: Boolean,
|
|
35
|
+
default: (props: { hideBranding?: boolean, hideDefaultFooter?: boolean }) => {
|
|
36
|
+
if (props.hideBranding === undefined && props.hideDefaultFooter !== undefined) {
|
|
37
|
+
console.warn(
|
|
38
|
+
'`hideDefaultFooter` is deprecated. Use `hideBranding` instead.',
|
|
39
|
+
)
|
|
40
|
+
|
|
41
|
+
return props.hideDefaultFooter
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
return false
|
|
45
|
+
},
|
|
46
|
+
},
|
|
47
|
+
})
|
|
48
|
+
|
|
49
|
+
defineSlots<{
|
|
50
|
+
[x in OperationSlot]: (props: OperationSlot) => any
|
|
51
|
+
}>()
|
|
52
|
+
|
|
53
|
+
const openapi = props.openapi ?? getOpenApiInstance({
|
|
54
|
+
custom: { spec: props.spec },
|
|
55
|
+
injected: inject('openapi', undefined),
|
|
56
|
+
})
|
|
57
|
+
|
|
58
|
+
const slots = useSlots()
|
|
59
|
+
|
|
60
|
+
const headingPrefix = computed(() => {
|
|
61
|
+
if (!props.prefixHeadings) {
|
|
62
|
+
return null
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
return props.operationId
|
|
66
|
+
})
|
|
67
|
+
|
|
68
|
+
function hasSlot(name: OperationSlot): boolean {
|
|
69
|
+
return slots[name] !== undefined
|
|
70
|
+
}
|
|
71
|
+
</script>
|
|
72
|
+
|
|
73
|
+
<template>
|
|
74
|
+
<OAPath
|
|
75
|
+
v-if="props.operationId"
|
|
76
|
+
:id="props.operationId"
|
|
77
|
+
:openapi="openapi"
|
|
78
|
+
>
|
|
79
|
+
<template
|
|
80
|
+
v-if="hasSlot('header')"
|
|
81
|
+
#header="header"
|
|
82
|
+
>
|
|
83
|
+
<slot
|
|
84
|
+
name="header"
|
|
85
|
+
v-bind="header"
|
|
86
|
+
/>
|
|
87
|
+
</template>
|
|
88
|
+
<template
|
|
89
|
+
v-else
|
|
90
|
+
#header="header"
|
|
91
|
+
>
|
|
92
|
+
<div class="flex flex-col">
|
|
93
|
+
<OAHeaderBadges
|
|
94
|
+
:operation="header.operation"
|
|
95
|
+
:deprecated="header.deprecated"
|
|
96
|
+
/>
|
|
97
|
+
|
|
98
|
+
<OAHeading
|
|
99
|
+
:id="headingPrefix"
|
|
100
|
+
level="h1"
|
|
101
|
+
:class="{
|
|
102
|
+
'line-through': header.deprecated,
|
|
103
|
+
}"
|
|
104
|
+
>
|
|
105
|
+
{{ header.operation.summary }}
|
|
106
|
+
</OAHeading>
|
|
107
|
+
</div>
|
|
108
|
+
</template>
|
|
109
|
+
|
|
110
|
+
<template
|
|
111
|
+
v-if="hasSlot('tags')"
|
|
112
|
+
#tags="tags"
|
|
113
|
+
>
|
|
114
|
+
<slot
|
|
115
|
+
name="tags"
|
|
116
|
+
v-bind="tags"
|
|
117
|
+
/>
|
|
118
|
+
</template>
|
|
119
|
+
<template
|
|
120
|
+
v-else
|
|
121
|
+
#tags="tags"
|
|
122
|
+
>
|
|
123
|
+
<OAOperationTags
|
|
124
|
+
:tags="tags.operation.tags"
|
|
125
|
+
/>
|
|
126
|
+
</template>
|
|
127
|
+
|
|
128
|
+
<template
|
|
129
|
+
v-if="hasSlot('description')"
|
|
130
|
+
#description="description"
|
|
131
|
+
>
|
|
132
|
+
<slot
|
|
133
|
+
name="description"
|
|
134
|
+
v-bind="description"
|
|
135
|
+
/>
|
|
136
|
+
</template>
|
|
137
|
+
<template
|
|
138
|
+
v-else
|
|
139
|
+
#description="description"
|
|
140
|
+
>
|
|
141
|
+
<OAMarkdown
|
|
142
|
+
v-if="description.operation.description"
|
|
143
|
+
:content="description.operation.description"
|
|
144
|
+
class="description"
|
|
145
|
+
/>
|
|
146
|
+
</template>
|
|
147
|
+
|
|
148
|
+
<template
|
|
149
|
+
v-if="hasSlot('security')"
|
|
150
|
+
#security="security"
|
|
151
|
+
>
|
|
152
|
+
<slot
|
|
153
|
+
name="security"
|
|
154
|
+
v-bind="security"
|
|
155
|
+
/>
|
|
156
|
+
</template>
|
|
157
|
+
<template
|
|
158
|
+
v-else
|
|
159
|
+
#security="security"
|
|
160
|
+
>
|
|
161
|
+
<OASecurity
|
|
162
|
+
v-if="Object.keys(security.securityUi).length"
|
|
163
|
+
:security-ui="security.securityUi"
|
|
164
|
+
:heading-prefix="headingPrefix"
|
|
165
|
+
/>
|
|
166
|
+
</template>
|
|
167
|
+
|
|
168
|
+
<template
|
|
169
|
+
v-if="hasSlot('parameters')"
|
|
170
|
+
#parameters="parameters"
|
|
171
|
+
>
|
|
172
|
+
<slot
|
|
173
|
+
name="parameters"
|
|
174
|
+
v-bind="parameters"
|
|
175
|
+
/>
|
|
176
|
+
</template>
|
|
177
|
+
<template
|
|
178
|
+
v-else
|
|
179
|
+
#parameters="parameters"
|
|
180
|
+
>
|
|
181
|
+
<OAHeading
|
|
182
|
+
level="h2"
|
|
183
|
+
:prefix="headingPrefix"
|
|
184
|
+
>
|
|
185
|
+
{{ $t('Parameters') }}
|
|
186
|
+
</OAHeading>
|
|
187
|
+
|
|
188
|
+
<OAParameters
|
|
189
|
+
:operation-id="props.operationId"
|
|
190
|
+
:parameters="parameters.parameters"
|
|
191
|
+
/>
|
|
192
|
+
</template>
|
|
193
|
+
|
|
194
|
+
<template
|
|
195
|
+
v-if="hasSlot('request-body')"
|
|
196
|
+
#request-body="requestBody"
|
|
197
|
+
>
|
|
198
|
+
<slot
|
|
199
|
+
name="request-body"
|
|
200
|
+
v-bind="requestBody"
|
|
201
|
+
/>
|
|
202
|
+
</template>
|
|
203
|
+
<template
|
|
204
|
+
v-else
|
|
205
|
+
#request-body="requestBody"
|
|
206
|
+
>
|
|
207
|
+
<OAHeading
|
|
208
|
+
level="h2"
|
|
209
|
+
:prefix="headingPrefix"
|
|
210
|
+
>
|
|
211
|
+
{{ $t('Request Body') }}
|
|
212
|
+
</OAHeading>
|
|
213
|
+
|
|
214
|
+
<OARequestBody
|
|
215
|
+
:operation-id="requestBody.operationId"
|
|
216
|
+
:request-body="requestBody.requestBody"
|
|
217
|
+
:content-type="requestBody.contentType"
|
|
218
|
+
/>
|
|
219
|
+
</template>
|
|
220
|
+
|
|
221
|
+
<template
|
|
222
|
+
v-if="hasSlot('responses')"
|
|
223
|
+
#responses="responses"
|
|
224
|
+
>
|
|
225
|
+
<slot
|
|
226
|
+
name="responses"
|
|
227
|
+
v-bind="responses"
|
|
228
|
+
/>
|
|
229
|
+
</template>
|
|
230
|
+
<template
|
|
231
|
+
v-else
|
|
232
|
+
#responses="responses"
|
|
233
|
+
>
|
|
234
|
+
<OAResponses
|
|
235
|
+
:operation-id="responses.operationId"
|
|
236
|
+
:responses="responses.responses"
|
|
237
|
+
:response-type="responses.responseType"
|
|
238
|
+
:heading-prefix="headingPrefix"
|
|
239
|
+
/>
|
|
240
|
+
</template>
|
|
241
|
+
|
|
242
|
+
<template
|
|
243
|
+
v-if="hasSlot('path')"
|
|
244
|
+
#path="path"
|
|
245
|
+
>
|
|
246
|
+
<slot
|
|
247
|
+
name="path"
|
|
248
|
+
v-bind="path"
|
|
249
|
+
/>
|
|
250
|
+
</template>
|
|
251
|
+
<template
|
|
252
|
+
v-else
|
|
253
|
+
#path="path"
|
|
254
|
+
>
|
|
255
|
+
<OAPathEndpoint
|
|
256
|
+
:path="path.path"
|
|
257
|
+
:method="path.method"
|
|
258
|
+
:base-url="path.baseUrl"
|
|
259
|
+
:hide-base-url="path.hideBaseUrl"
|
|
260
|
+
:deprecated="path.deprecated"
|
|
261
|
+
:servers="path.servers"
|
|
262
|
+
@update:selected-server="path.updateSelectedServer"
|
|
263
|
+
/>
|
|
264
|
+
</template>
|
|
265
|
+
|
|
266
|
+
<template
|
|
267
|
+
v-if="hasSlot('try-it')"
|
|
268
|
+
#try-it="tryIt"
|
|
269
|
+
>
|
|
270
|
+
<slot
|
|
271
|
+
name="try-it"
|
|
272
|
+
v-bind="tryIt"
|
|
273
|
+
/>
|
|
274
|
+
</template>
|
|
275
|
+
<template
|
|
276
|
+
v-else
|
|
277
|
+
#try-it="tryIt"
|
|
278
|
+
>
|
|
279
|
+
<ClientOnly>
|
|
280
|
+
<OATryWithVariables
|
|
281
|
+
:request="tryIt.request"
|
|
282
|
+
:operation-id="tryIt.operationId"
|
|
283
|
+
:path="tryIt.path"
|
|
284
|
+
:method="tryIt.method"
|
|
285
|
+
:base-url="tryIt.baseUrl"
|
|
286
|
+
:parameters="tryIt.parameters"
|
|
287
|
+
:request-body="tryIt.requestBody"
|
|
288
|
+
:security-ui="tryIt.securityUi"
|
|
289
|
+
:content-type="tryIt.contentType"
|
|
290
|
+
@update:selected-server="tryIt.updateSelectedServer"
|
|
291
|
+
@update:request="tryIt.updateRequest"
|
|
292
|
+
/>
|
|
293
|
+
</ClientOnly>
|
|
294
|
+
</template>
|
|
295
|
+
|
|
296
|
+
<template
|
|
297
|
+
v-if="hasSlot('code-samples')"
|
|
298
|
+
#code-samples="codeSamples"
|
|
299
|
+
>
|
|
300
|
+
<slot
|
|
301
|
+
name="code-samples"
|
|
302
|
+
v-bind="codeSamples"
|
|
303
|
+
/>
|
|
304
|
+
</template>
|
|
305
|
+
<template
|
|
306
|
+
v-else
|
|
307
|
+
#code-samples="codeSamples"
|
|
308
|
+
>
|
|
309
|
+
<OAHeading
|
|
310
|
+
level="h2"
|
|
311
|
+
:prefix="headingPrefix"
|
|
312
|
+
>
|
|
313
|
+
{{ $t('Samples') }}
|
|
314
|
+
</OAHeading>
|
|
315
|
+
|
|
316
|
+
<OACodeSamples
|
|
317
|
+
:operation-id="codeSamples.operationId"
|
|
318
|
+
:path="codeSamples.path"
|
|
319
|
+
:method="codeSamples.method"
|
|
320
|
+
:base-url="codeSamples.baseUrl"
|
|
321
|
+
:request="codeSamples.request"
|
|
322
|
+
/>
|
|
323
|
+
</template>
|
|
324
|
+
|
|
325
|
+
<template
|
|
326
|
+
v-if="hasSlot('branding')"
|
|
327
|
+
#branding="branding"
|
|
328
|
+
>
|
|
329
|
+
<slot
|
|
330
|
+
name="branding"
|
|
331
|
+
v-bind="branding"
|
|
332
|
+
/>
|
|
333
|
+
</template>
|
|
334
|
+
|
|
335
|
+
<template
|
|
336
|
+
v-if="hasSlot('footer')"
|
|
337
|
+
#footer="footer"
|
|
338
|
+
>
|
|
339
|
+
<slot
|
|
340
|
+
name="footer"
|
|
341
|
+
v-bind="footer"
|
|
342
|
+
/>
|
|
343
|
+
</template>
|
|
344
|
+
</OAPath>
|
|
345
|
+
</template>
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
<script setup lang="ts">
|
|
2
|
+
import { useTheme } from '../../composables/useTheme'
|
|
3
|
+
import { Badge } from '../ui/badge'
|
|
4
|
+
|
|
5
|
+
const props = defineProps({
|
|
6
|
+
tags: {
|
|
7
|
+
type: Array,
|
|
8
|
+
required: true,
|
|
9
|
+
},
|
|
10
|
+
})
|
|
11
|
+
|
|
12
|
+
const themeConfig = useTheme()
|
|
13
|
+
|
|
14
|
+
const prefix = themeConfig.getTagsLinkPrefix()
|
|
15
|
+
</script>
|
|
16
|
+
|
|
17
|
+
<template>
|
|
18
|
+
<div class="flex flex-wrap gap-2">
|
|
19
|
+
<a
|
|
20
|
+
v-for="(tag, index) in props.tags"
|
|
21
|
+
:key="index"
|
|
22
|
+
:href="`${prefix}${tag}`"
|
|
23
|
+
:aria-label="$t('tags.goTo', { tag })"
|
|
24
|
+
>
|
|
25
|
+
<Badge variant="outline">
|
|
26
|
+
{{ tag }}
|
|
27
|
+
</Badge>
|
|
28
|
+
</a>
|
|
29
|
+
</div>
|
|
30
|
+
</template>
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
<script setup>
|
|
2
|
+
import { getConstraints } from '../../lib/constraintsParser'
|
|
3
|
+
import OACodeValue from '../Common/OACodeValue.vue'
|
|
4
|
+
import OAParameterAttribute from './OAParameterAttribute.vue'
|
|
5
|
+
import OAParameterExamples from './OAParameterExamples.vue'
|
|
6
|
+
|
|
7
|
+
const props = defineProps({
|
|
8
|
+
parameter: {
|
|
9
|
+
type: Object,
|
|
10
|
+
required: true,
|
|
11
|
+
},
|
|
12
|
+
})
|
|
13
|
+
|
|
14
|
+
const constraints = getConstraints(props.parameter.schema)
|
|
15
|
+
</script>
|
|
16
|
+
|
|
17
|
+
<template>
|
|
18
|
+
<div class="flex flex-col p-3 gap-2 rounded bg-muted">
|
|
19
|
+
<div class="flex flex-col gap-2">
|
|
20
|
+
<div class="flex flex-row items-center gap-2">
|
|
21
|
+
<span class="text-sm font-bold">{{ props.parameter.name }}</span>
|
|
22
|
+
<span
|
|
23
|
+
v-if="props.parameter.required"
|
|
24
|
+
class="text-sm text-red-500"
|
|
25
|
+
>*</span>
|
|
26
|
+
</div>
|
|
27
|
+
|
|
28
|
+
<OAMarkdown
|
|
29
|
+
v-if="props.parameter.description"
|
|
30
|
+
:content="props.parameter.description"
|
|
31
|
+
class="text-sm text-gray-800 dark:text-gray-100"
|
|
32
|
+
/>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div
|
|
36
|
+
v-if="props.parameter.schema"
|
|
37
|
+
class="flex flex-col gap-2"
|
|
38
|
+
>
|
|
39
|
+
<div class="flex flex-row gap-2">
|
|
40
|
+
<OAParameterAttribute
|
|
41
|
+
v-if="props.parameter.schema.type"
|
|
42
|
+
:name="$t('Type')"
|
|
43
|
+
:value="props.parameter.schema.type"
|
|
44
|
+
bold-name
|
|
45
|
+
/>
|
|
46
|
+
|
|
47
|
+
<span
|
|
48
|
+
v-if="props.parameter.required"
|
|
49
|
+
class="text-sm text-red-500"
|
|
50
|
+
>{{ $t('Required') }}</span>
|
|
51
|
+
</div>
|
|
52
|
+
|
|
53
|
+
<OAParameterAttribute v-if="props.parameter.schema.enum" :name="$t('Enum')" :value="props.parameter.schema.enum.join(', ')">
|
|
54
|
+
<template #value>
|
|
55
|
+
<div class="flex flex-wrap gap-2">
|
|
56
|
+
<OACodeValue
|
|
57
|
+
v-for="(value, idx) in props.parameter.schema.enum"
|
|
58
|
+
:key="idx"
|
|
59
|
+
:value="value"
|
|
60
|
+
/>
|
|
61
|
+
</div>
|
|
62
|
+
</template>
|
|
63
|
+
</OAParameterAttribute>
|
|
64
|
+
|
|
65
|
+
<OAParameterExamples :property="props.parameter" />
|
|
66
|
+
|
|
67
|
+
<template v-if="Object.keys(constraints).length > 0">
|
|
68
|
+
<OAParameterAttribute
|
|
69
|
+
v-for="(value, name) in constraints"
|
|
70
|
+
:key="name"
|
|
71
|
+
:name="name"
|
|
72
|
+
>
|
|
73
|
+
<template #value>
|
|
74
|
+
<OACodeValue :value="value" />
|
|
75
|
+
</template>
|
|
76
|
+
</OAParameterAttribute>
|
|
77
|
+
</template>
|
|
78
|
+
</div>
|
|
79
|
+
</div>
|
|
80
|
+
</template>
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
<script setup lang="ts">
|
|
2
|
+
import type { Slots } from 'vue'
|
|
3
|
+
import { useSlots } from 'vue'
|
|
4
|
+
|
|
5
|
+
const props = defineProps({
|
|
6
|
+
name: {
|
|
7
|
+
type: String,
|
|
8
|
+
required: true,
|
|
9
|
+
},
|
|
10
|
+
boldName: {
|
|
11
|
+
type: Boolean,
|
|
12
|
+
default: false,
|
|
13
|
+
},
|
|
14
|
+
value: {
|
|
15
|
+
type: [String, Number, Boolean, Object, Array],
|
|
16
|
+
required: false,
|
|
17
|
+
},
|
|
18
|
+
})
|
|
19
|
+
|
|
20
|
+
const slots: Slots = useSlots()
|
|
21
|
+
|
|
22
|
+
function hasSlot(name: string): boolean {
|
|
23
|
+
return slots[name] !== undefined
|
|
24
|
+
}
|
|
25
|
+
</script>
|
|
26
|
+
|
|
27
|
+
<template>
|
|
28
|
+
<div
|
|
29
|
+
class="flex flex-row gap-2 text-sm"
|
|
30
|
+
>
|
|
31
|
+
<span
|
|
32
|
+
:class="{
|
|
33
|
+
'font-bold': props.boldName,
|
|
34
|
+
}"
|
|
35
|
+
>
|
|
36
|
+
{{ props.name }}
|
|
37
|
+
</span>
|
|
38
|
+
|
|
39
|
+
<slot v-if="hasSlot('value')" name="value" />
|
|
40
|
+
<span v-else class="text-gray-600 dark:text-gray-300">
|
|
41
|
+
{{ props.value }}
|
|
42
|
+
</span>
|
|
43
|
+
</div>
|
|
44
|
+
</template>
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
<script setup>
|
|
2
|
+
import { useTheme } from '../../composables/useTheme'
|
|
3
|
+
import { getPropertyExamples } from '../../lib/examples/getPropertyExamples'
|
|
4
|
+
import OACodeValue from '../Common/OACodeValue.vue'
|
|
5
|
+
import OAParameterAttribute from './OAParameterAttribute.vue'
|
|
6
|
+
|
|
7
|
+
const props = defineProps({
|
|
8
|
+
property: {
|
|
9
|
+
type: Object,
|
|
10
|
+
required: true,
|
|
11
|
+
},
|
|
12
|
+
})
|
|
13
|
+
|
|
14
|
+
const examples = getPropertyExamples(props.property)
|
|
15
|
+
|
|
16
|
+
const wrapExamples = useTheme().getWrapExamples()
|
|
17
|
+
</script>
|
|
18
|
+
|
|
19
|
+
<template>
|
|
20
|
+
<div
|
|
21
|
+
v-if="examples?.length === 1"
|
|
22
|
+
class="flex flex-row space-x-2"
|
|
23
|
+
>
|
|
24
|
+
<span class="text-sm">{{ $t('Example') }}</span>
|
|
25
|
+
<OACodeValue :value="examples[0]" />
|
|
26
|
+
</div>
|
|
27
|
+
<div
|
|
28
|
+
v-if="examples?.length > 1"
|
|
29
|
+
class="flex flex-row flex-wrap gap-2"
|
|
30
|
+
:class="{
|
|
31
|
+
'items-center': wrapExamples,
|
|
32
|
+
}"
|
|
33
|
+
>
|
|
34
|
+
<OAParameterAttribute :name="$t('Examples')">
|
|
35
|
+
<template #value>
|
|
36
|
+
<div
|
|
37
|
+
class="flex gap-2"
|
|
38
|
+
:class="{
|
|
39
|
+
'flex-col': !wrapExamples,
|
|
40
|
+
'flex-row flex-wrap': wrapExamples,
|
|
41
|
+
}"
|
|
42
|
+
>
|
|
43
|
+
<OACodeValue
|
|
44
|
+
v-for="(example, idx) in examples"
|
|
45
|
+
:key="idx"
|
|
46
|
+
:value="example"
|
|
47
|
+
/>
|
|
48
|
+
</div>
|
|
49
|
+
</template>
|
|
50
|
+
</OAParameterAttribute>
|
|
51
|
+
</div>
|
|
52
|
+
</template>
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
<script setup>
|
|
2
|
+
import { defineProps } from 'vue'
|
|
3
|
+
|
|
4
|
+
const props = defineProps({
|
|
5
|
+
operationId: {
|
|
6
|
+
type: String,
|
|
7
|
+
required: true,
|
|
8
|
+
},
|
|
9
|
+
parameters: {
|
|
10
|
+
type: Array,
|
|
11
|
+
required: true,
|
|
12
|
+
},
|
|
13
|
+
})
|
|
14
|
+
|
|
15
|
+
const headerParameters = props.parameters.filter(parameter => parameter && parameter.in === 'header')
|
|
16
|
+
|
|
17
|
+
const pathParameters = props.parameters.filter(parameter => parameter && parameter.in === 'path')
|
|
18
|
+
|
|
19
|
+
const queryParameters = props.parameters.filter(parameter => parameter && parameter.in === 'query')
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
<template>
|
|
23
|
+
<div class="flex flex-col">
|
|
24
|
+
<div
|
|
25
|
+
v-if="headerParameters.length"
|
|
26
|
+
class="space-y-4"
|
|
27
|
+
>
|
|
28
|
+
<h3>
|
|
29
|
+
{{ $t('Header Parameters') }}
|
|
30
|
+
</h3>
|
|
31
|
+
|
|
32
|
+
<OAParameter
|
|
33
|
+
v-for="parameter in headerParameters"
|
|
34
|
+
:key="parameter.name"
|
|
35
|
+
:parameter="parameter"
|
|
36
|
+
/>
|
|
37
|
+
</div>
|
|
38
|
+
|
|
39
|
+
<div
|
|
40
|
+
v-if="pathParameters.length"
|
|
41
|
+
class="space-y-4"
|
|
42
|
+
>
|
|
43
|
+
<h3>
|
|
44
|
+
{{ $t('Path Parameters') }}
|
|
45
|
+
</h3>
|
|
46
|
+
|
|
47
|
+
<OAParameter
|
|
48
|
+
v-for="parameter in pathParameters"
|
|
49
|
+
:key="parameter.name"
|
|
50
|
+
:parameter="parameter"
|
|
51
|
+
/>
|
|
52
|
+
</div>
|
|
53
|
+
|
|
54
|
+
<div
|
|
55
|
+
v-if="queryParameters.length"
|
|
56
|
+
class="space-y-4"
|
|
57
|
+
>
|
|
58
|
+
<h3>
|
|
59
|
+
{{ $t('Query Parameters') }}
|
|
60
|
+
</h3>
|
|
61
|
+
|
|
62
|
+
<OAParameter
|
|
63
|
+
v-for="parameter in queryParameters"
|
|
64
|
+
:key="parameter.name"
|
|
65
|
+
:parameter="parameter"
|
|
66
|
+
/>
|
|
67
|
+
</div>
|
|
68
|
+
</div>
|
|
69
|
+
</template>
|