docusaurus-plugin-openapi-docs 0.0.0-422 → 0.0.0-423
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.
|
@@ -55,6 +55,7 @@ function createResponseHeaders(responseHeaders) {
|
|
|
55
55
|
}
|
|
56
56
|
function createResponseExamples(responseExamples) {
|
|
57
57
|
return Object.entries(responseExamples).map(([exampleName, exampleValue]) => {
|
|
58
|
+
var _a;
|
|
58
59
|
const camelToSpaceName = exampleName.replace(/([A-Z])/g, " $1");
|
|
59
60
|
let finalFormattedName = camelToSpaceName.charAt(0).toUpperCase() + camelToSpaceName.slice(1);
|
|
60
61
|
return (0, utils_1.create)("TabItem", {
|
|
@@ -62,7 +63,7 @@ function createResponseExamples(responseExamples) {
|
|
|
62
63
|
value: `${finalFormattedName}`,
|
|
63
64
|
children: [
|
|
64
65
|
(0, utils_1.create)("ResponseSamples", {
|
|
65
|
-
responseExample: JSON.stringify(exampleValue.value, null, 2),
|
|
66
|
+
responseExample: JSON.stringify((_a = exampleValue.value) !== null && _a !== void 0 ? _a : exampleValue, null, 2),
|
|
66
67
|
}),
|
|
67
68
|
],
|
|
68
69
|
});
|
|
@@ -83,7 +84,9 @@ function createStatusCodes({ responses }) {
|
|
|
83
84
|
const responseHeaders = responses[code].headers;
|
|
84
85
|
const responseContent = responses[code].content;
|
|
85
86
|
const responseContentKey = responseContent && Object.keys(responseContent)[0];
|
|
86
|
-
const responseExamples = responseContentKey &&
|
|
87
|
+
const responseExamples = responseContentKey &&
|
|
88
|
+
(responseContent[responseContentKey].examples ||
|
|
89
|
+
responseContent[responseContentKey].example);
|
|
87
90
|
return (0, utils_1.create)("TabItem", {
|
|
88
91
|
label: code,
|
|
89
92
|
value: code,
|
|
@@ -101,7 +104,7 @@ function createStatusCodes({ responses }) {
|
|
|
101
104
|
(0, createDetails_1.createDetails)({
|
|
102
105
|
"data-collaposed": false,
|
|
103
106
|
open: true,
|
|
104
|
-
style: { textAlign: "left" },
|
|
107
|
+
style: { textAlign: "left", marginBottom: "1rem" },
|
|
105
108
|
children: [
|
|
106
109
|
(0, createDetailsSummary_1.createDetailsSummary)({
|
|
107
110
|
children: [
|
|
@@ -126,7 +129,7 @@ function createStatusCodes({ responses }) {
|
|
|
126
129
|
createResponseExamples(responseExamples),
|
|
127
130
|
],
|
|
128
131
|
})),
|
|
129
|
-
(0, utils_2.guard)(responseHeaders, () => (0, createDetails_1.createDetails)({
|
|
132
|
+
(0, utils_2.guard)(responseHeaders && !responseExamples, () => (0, createDetails_1.createDetails)({
|
|
130
133
|
"data-collaposed": false,
|
|
131
134
|
open: true,
|
|
132
135
|
style: { textAlign: "left" },
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "docusaurus-plugin-openapi-docs",
|
|
3
3
|
"description": "OpenAPI plugin for Docusaurus.",
|
|
4
|
-
"version": "0.0.0-
|
|
4
|
+
"version": "0.0.0-423",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"keywords": [
|
|
7
7
|
"openapi",
|
|
@@ -67,5 +67,5 @@
|
|
|
67
67
|
"engines": {
|
|
68
68
|
"node": ">=14"
|
|
69
69
|
},
|
|
70
|
-
"gitHead": "
|
|
70
|
+
"gitHead": "ed2383ca5a0b71bb9a123e185c14e48ab6c12f41"
|
|
71
71
|
}
|
|
@@ -79,7 +79,11 @@ function createResponseExamples(responseExamples: any) {
|
|
|
79
79
|
value: `${finalFormattedName}`,
|
|
80
80
|
children: [
|
|
81
81
|
create("ResponseSamples", {
|
|
82
|
-
responseExample: JSON.stringify(
|
|
82
|
+
responseExample: JSON.stringify(
|
|
83
|
+
exampleValue.value ?? exampleValue,
|
|
84
|
+
null,
|
|
85
|
+
2
|
|
86
|
+
),
|
|
83
87
|
}),
|
|
84
88
|
],
|
|
85
89
|
});
|
|
@@ -106,7 +110,9 @@ export function createStatusCodes({ responses }: Props) {
|
|
|
106
110
|
const responseContentKey: any =
|
|
107
111
|
responseContent && Object.keys(responseContent)[0];
|
|
108
112
|
const responseExamples: any =
|
|
109
|
-
responseContentKey &&
|
|
113
|
+
responseContentKey &&
|
|
114
|
+
(responseContent[responseContentKey].examples ||
|
|
115
|
+
responseContent[responseContentKey].example);
|
|
110
116
|
|
|
111
117
|
return create("TabItem", {
|
|
112
118
|
label: code,
|
|
@@ -126,7 +132,7 @@ export function createStatusCodes({ responses }: Props) {
|
|
|
126
132
|
createDetails({
|
|
127
133
|
"data-collaposed": false,
|
|
128
134
|
open: true,
|
|
129
|
-
style: { textAlign: "left" },
|
|
135
|
+
style: { textAlign: "left", marginBottom: "1rem" },
|
|
130
136
|
children: [
|
|
131
137
|
createDetailsSummary({
|
|
132
138
|
children: [
|
|
@@ -152,7 +158,7 @@ export function createStatusCodes({ responses }: Props) {
|
|
|
152
158
|
],
|
|
153
159
|
})
|
|
154
160
|
),
|
|
155
|
-
guard(responseHeaders, () =>
|
|
161
|
+
guard(responseHeaders && !responseExamples, () =>
|
|
156
162
|
createDetails({
|
|
157
163
|
"data-collaposed": false,
|
|
158
164
|
open: true,
|