docusaurus-plugin-openapi-docs 0.0.0-beta.655 → 0.0.0-beta.656
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/lib/markdown/createParamsDetails.js +2 -1
- package/lib/markdown/createRequestHeader.d.ts +1 -0
- package/lib/markdown/createRequestHeader.js +13 -0
- package/lib/markdown/createRequestSchema.js +26 -16
- package/lib/markdown/createResponseSchema.js +15 -11
- package/lib/markdown/index.js +3 -2
- package/package.json +2 -2
- package/src/markdown/createParamsDetails.ts +2 -1
- package/src/markdown/createRequestHeader.ts +10 -0
- package/src/markdown/createRequestSchema.ts +25 -19
- package/src/markdown/createResponseSchema.ts +14 -14
- package/src/markdown/index.ts +3 -2
|
@@ -26,7 +26,8 @@ function createParamsDetails({ parameters, type }) {
|
|
|
26
26
|
children: [
|
|
27
27
|
(0, createDetailsSummary_1.createDetailsSummary)({
|
|
28
28
|
children: [
|
|
29
|
-
(0, utils_1.create)("
|
|
29
|
+
(0, utils_1.create)("h3", {
|
|
30
|
+
className: "openapi-markdown__details-summary-header-params",
|
|
30
31
|
children: `${type.charAt(0).toUpperCase() + type.slice(1)} Parameters`,
|
|
31
32
|
}),
|
|
32
33
|
],
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function createRequestHeader(header: string): string;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* ============================================================================
|
|
3
|
+
* Copyright (c) Palo Alto Networks
|
|
4
|
+
*
|
|
5
|
+
* This source code is licensed under the MIT license found in the
|
|
6
|
+
* LICENSE file in the root directory of this source tree.
|
|
7
|
+
* ========================================================================== */
|
|
8
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
+
exports.createRequestHeader = void 0;
|
|
10
|
+
function createRequestHeader(header) {
|
|
11
|
+
return `## ${header}\n\n`;
|
|
12
|
+
}
|
|
13
|
+
exports.createRequestHeader = createRequestHeader;
|
|
@@ -5,8 +5,12 @@
|
|
|
5
5
|
* This source code is licensed under the MIT license found in the
|
|
6
6
|
* LICENSE file in the root directory of this source tree.
|
|
7
7
|
* ========================================================================== */
|
|
8
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
9
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
10
|
+
};
|
|
8
11
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
12
|
exports.createRequestSchema = exports.mergeAllOf = void 0;
|
|
13
|
+
const clsx_1 = __importDefault(require("clsx"));
|
|
10
14
|
const createArrayBracket_1 = require("./createArrayBracket");
|
|
11
15
|
const createDescription_1 = require("./createDescription");
|
|
12
16
|
const createDetails_1 = require("./createDetails");
|
|
@@ -400,8 +404,8 @@ function createDetailsNode(name, schemaName, schema, required, nullable) {
|
|
|
400
404
|
className: "openapi-schema__container",
|
|
401
405
|
children: [
|
|
402
406
|
(0, utils_1.create)("strong", {
|
|
403
|
-
|
|
404
|
-
|
|
407
|
+
className: (0, clsx_1.default)("openapi-schema__property", {
|
|
408
|
+
"openapi-schema__strikethrough": schema.deprecated,
|
|
405
409
|
}),
|
|
406
410
|
children: name,
|
|
407
411
|
}),
|
|
@@ -420,7 +424,7 @@ function createDetailsNode(name, schemaName, schema, required, nullable) {
|
|
|
420
424
|
]),
|
|
421
425
|
(0, utils_1.guard)(nullable, () => [
|
|
422
426
|
(0, utils_1.create)("span", {
|
|
423
|
-
className: "
|
|
427
|
+
className: "openapi-schema__nullable",
|
|
424
428
|
children: "nullable",
|
|
425
429
|
}),
|
|
426
430
|
]),
|
|
@@ -428,13 +432,13 @@ function createDetailsNode(name, schemaName, schema, required, nullable) {
|
|
|
428
432
|
? required.includes(name)
|
|
429
433
|
: required === true, () => [
|
|
430
434
|
(0, utils_1.create)("span", {
|
|
431
|
-
className: "
|
|
435
|
+
className: "openapi-schema__required",
|
|
432
436
|
children: "required",
|
|
433
437
|
}),
|
|
434
438
|
]),
|
|
435
439
|
(0, utils_1.guard)(schema.deprecated, () => [
|
|
436
440
|
(0, utils_1.create)("span", {
|
|
437
|
-
className: "
|
|
441
|
+
className: "openapi-schema__deprecated",
|
|
438
442
|
children: "deprecated",
|
|
439
443
|
}),
|
|
440
444
|
]),
|
|
@@ -473,14 +477,14 @@ function createPropertyDiscriminator(name, schemaName, schema, discriminator, re
|
|
|
473
477
|
return undefined;
|
|
474
478
|
}
|
|
475
479
|
return (0, utils_1.create)("div", {
|
|
476
|
-
className: "openapi-discriminator__item",
|
|
480
|
+
className: "openapi-discriminator__item openapi-schema__list-item",
|
|
477
481
|
children: (0, utils_1.create)("div", {
|
|
478
482
|
children: [
|
|
479
483
|
(0, utils_1.create)("span", {
|
|
480
484
|
className: "openapi-schema__container",
|
|
481
485
|
children: [
|
|
482
486
|
(0, utils_1.create)("strong", {
|
|
483
|
-
className: "openapi-discriminator__name",
|
|
487
|
+
className: "openapi-discriminator__name openapi-schema__property",
|
|
484
488
|
children: name,
|
|
485
489
|
}),
|
|
486
490
|
(0, utils_1.guard)(schemaName, (name) => (0, utils_1.create)("span", {
|
|
@@ -489,7 +493,7 @@ function createPropertyDiscriminator(name, schemaName, schema, discriminator, re
|
|
|
489
493
|
})),
|
|
490
494
|
(0, utils_1.guard)(required, () => [
|
|
491
495
|
(0, utils_1.create)("span", {
|
|
492
|
-
className: "
|
|
496
|
+
className: "openapi-schema__required",
|
|
493
497
|
children: "required",
|
|
494
498
|
}),
|
|
495
499
|
]),
|
|
@@ -676,18 +680,21 @@ function createRequestSchema({ title, body, ...rest }) {
|
|
|
676
680
|
value: `${mimeType}`,
|
|
677
681
|
children: [
|
|
678
682
|
(0, createDetails_1.createDetails)({
|
|
679
|
-
className: "openapi-markdown__details",
|
|
683
|
+
className: "openapi-markdown__details mime",
|
|
680
684
|
"data-collapsed": false,
|
|
681
685
|
open: true,
|
|
682
686
|
...rest,
|
|
683
687
|
children: [
|
|
684
688
|
(0, createDetailsSummary_1.createDetailsSummary)({
|
|
685
|
-
|
|
689
|
+
className: "openapi-markdown__details-summary-mime",
|
|
686
690
|
children: [
|
|
687
|
-
(0, utils_1.create)("
|
|
691
|
+
(0, utils_1.create)("h3", {
|
|
692
|
+
className: "openapi-markdown__details-summary-header-body",
|
|
693
|
+
children: `${title}`,
|
|
694
|
+
}),
|
|
688
695
|
(0, utils_1.guard)(body.required && body.required === true, () => [
|
|
689
696
|
(0, utils_1.create)("span", {
|
|
690
|
-
className: "
|
|
697
|
+
className: "openapi-schema__required",
|
|
691
698
|
children: "required",
|
|
692
699
|
}),
|
|
693
700
|
]),
|
|
@@ -734,22 +741,25 @@ function createRequestSchema({ title, body, ...rest }) {
|
|
|
734
741
|
value: `${randomFirstKey}-schema`,
|
|
735
742
|
children: [
|
|
736
743
|
(0, createDetails_1.createDetails)({
|
|
737
|
-
className: "openapi-markdown__details",
|
|
744
|
+
className: "openapi-markdown__details mime",
|
|
738
745
|
"data-collapsed": false,
|
|
739
746
|
open: true,
|
|
740
747
|
...rest,
|
|
741
748
|
children: [
|
|
742
749
|
(0, createDetailsSummary_1.createDetailsSummary)({
|
|
743
|
-
|
|
750
|
+
className: "openapi-markdown__details-summary-mime",
|
|
744
751
|
children: [
|
|
745
|
-
(0, utils_1.create)("
|
|
752
|
+
(0, utils_1.create)("h3", {
|
|
753
|
+
className: "openapi-markdown__details-summary-header-body",
|
|
754
|
+
children: `${title}`,
|
|
755
|
+
}),
|
|
746
756
|
(0, utils_1.guard)(firstBody.type === "array", (format) => (0, utils_1.create)("span", {
|
|
747
757
|
style: { opacity: "0.6" },
|
|
748
758
|
children: ` array`,
|
|
749
759
|
})),
|
|
750
760
|
(0, utils_1.guard)(body.required, () => [
|
|
751
761
|
(0, utils_1.create)("strong", {
|
|
752
|
-
className: "
|
|
762
|
+
className: "openapi-schema__required",
|
|
753
763
|
children: "required",
|
|
754
764
|
}),
|
|
755
765
|
]),
|
|
@@ -5,8 +5,12 @@
|
|
|
5
5
|
* This source code is licensed under the MIT license found in the
|
|
6
6
|
* LICENSE file in the root directory of this source tree.
|
|
7
7
|
* ========================================================================== */
|
|
8
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
9
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
10
|
+
};
|
|
8
11
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
12
|
exports.createResponseSchema = exports.mergeAllOf = void 0;
|
|
13
|
+
const clsx_1 = __importDefault(require("clsx"));
|
|
10
14
|
const createArrayBracket_1 = require("./createArrayBracket");
|
|
11
15
|
const createDescription_1 = require("./createDescription");
|
|
12
16
|
const createDetails_1 = require("./createDetails");
|
|
@@ -401,8 +405,8 @@ function createDetailsNode(name, schemaName, schema, required, nullable) {
|
|
|
401
405
|
className: "openapi-schema__container",
|
|
402
406
|
children: [
|
|
403
407
|
(0, utils_1.create)("strong", {
|
|
404
|
-
|
|
405
|
-
|
|
408
|
+
className: (0, clsx_1.default)("openapi-schema__property", {
|
|
409
|
+
"openapi-schema__strikethrough": schema.deprecated,
|
|
406
410
|
}),
|
|
407
411
|
children: name,
|
|
408
412
|
}),
|
|
@@ -421,7 +425,7 @@ function createDetailsNode(name, schemaName, schema, required, nullable) {
|
|
|
421
425
|
]),
|
|
422
426
|
(0, utils_1.guard)(nullable, () => [
|
|
423
427
|
(0, utils_1.create)("span", {
|
|
424
|
-
className: "
|
|
428
|
+
className: "openapi-schema__nullable",
|
|
425
429
|
children: "nullable",
|
|
426
430
|
}),
|
|
427
431
|
]),
|
|
@@ -429,13 +433,13 @@ function createDetailsNode(name, schemaName, schema, required, nullable) {
|
|
|
429
433
|
? required.includes(name)
|
|
430
434
|
: required === true, () => [
|
|
431
435
|
(0, utils_1.create)("span", {
|
|
432
|
-
className: "
|
|
436
|
+
className: "openapi-schema__required",
|
|
433
437
|
children: "required",
|
|
434
438
|
}),
|
|
435
439
|
]),
|
|
436
440
|
(0, utils_1.guard)(schema.deprecated, () => [
|
|
437
441
|
(0, utils_1.create)("span", {
|
|
438
|
-
className: "
|
|
442
|
+
className: "openapi-schema__deprecated",
|
|
439
443
|
children: "deprecated",
|
|
440
444
|
}),
|
|
441
445
|
]),
|
|
@@ -474,14 +478,14 @@ function createPropertyDiscriminator(name, schemaName, schema, discriminator, re
|
|
|
474
478
|
return undefined;
|
|
475
479
|
}
|
|
476
480
|
return (0, utils_1.create)("div", {
|
|
477
|
-
className: "openapi-discriminator__item",
|
|
481
|
+
className: "openapi-discriminator__item openapi-schema__list-item",
|
|
478
482
|
children: (0, utils_1.create)("div", {
|
|
479
483
|
children: [
|
|
480
484
|
(0, utils_1.create)("span", {
|
|
481
485
|
className: "openapi-schema__container",
|
|
482
486
|
children: [
|
|
483
487
|
(0, utils_1.create)("strong", {
|
|
484
|
-
className: "openapi-discriminator__name",
|
|
488
|
+
className: "openapi-discriminator__name openapi-schema__property",
|
|
485
489
|
children: name,
|
|
486
490
|
}),
|
|
487
491
|
(0, utils_1.guard)(schemaName, (name) => (0, utils_1.create)("span", {
|
|
@@ -490,7 +494,7 @@ function createPropertyDiscriminator(name, schemaName, schema, discriminator, re
|
|
|
490
494
|
})),
|
|
491
495
|
(0, utils_1.guard)(required, () => [
|
|
492
496
|
(0, utils_1.create)("span", {
|
|
493
|
-
className: "
|
|
497
|
+
className: "openapi-schema__required",
|
|
494
498
|
children: "required",
|
|
495
499
|
}),
|
|
496
500
|
]),
|
|
@@ -693,18 +697,18 @@ function createResponseSchema({ title, body, ...rest }) {
|
|
|
693
697
|
value: `${title}`,
|
|
694
698
|
children: [
|
|
695
699
|
(0, createDetails_1.createDetails)({
|
|
696
|
-
className: "openapi-markdown__details",
|
|
700
|
+
className: "openapi-markdown__details response",
|
|
697
701
|
"data-collapsed": false,
|
|
698
702
|
open: true,
|
|
699
703
|
...rest,
|
|
700
704
|
children: [
|
|
701
705
|
(0, createDetailsSummary_1.createDetailsSummary)({
|
|
702
|
-
|
|
706
|
+
className: "openapi-markdown__details-summary-response",
|
|
703
707
|
children: [
|
|
704
708
|
(0, utils_1.create)("strong", { children: `${title}` }),
|
|
705
709
|
(0, utils_1.guard)(body.required && body.required === true, () => [
|
|
706
710
|
(0, utils_1.create)("span", {
|
|
707
|
-
className: "
|
|
711
|
+
className: "openapi-schema__required",
|
|
708
712
|
children: "required",
|
|
709
713
|
}),
|
|
710
714
|
]),
|
package/lib/markdown/index.js
CHANGED
|
@@ -19,6 +19,7 @@ const createLogo_1 = require("./createLogo");
|
|
|
19
19
|
const createMethodEndpoint_1 = require("./createMethodEndpoint");
|
|
20
20
|
const createParamsDetails_1 = require("./createParamsDetails");
|
|
21
21
|
const createRequestBodyDetails_1 = require("./createRequestBodyDetails");
|
|
22
|
+
const createRequestHeader_1 = require("./createRequestHeader");
|
|
22
23
|
const createStatusCodes_1 = require("./createStatusCodes");
|
|
23
24
|
const createTermsOfService_1 = require("./createTermsOfService");
|
|
24
25
|
const createVendorExtensions_1 = require("./createVendorExtensions");
|
|
@@ -38,17 +39,17 @@ function createApiPageMD({ title, api: { deprecated, "x-deprecated-description":
|
|
|
38
39
|
`import TabItem from "@theme/TabItem";\n\n`,
|
|
39
40
|
(0, createHeading_1.createHeading)(title.replace(utils_1.lessThan, "<").replace(utils_1.greaterThan, ">")),
|
|
40
41
|
(0, createMethodEndpoint_1.createMethodEndpoint)(method, path),
|
|
41
|
-
`## ${title.replace(utils_1.lessThan, "<").replace(utils_1.greaterThan, ">")}\n\n`,
|
|
42
42
|
infoPath && (0, createAuthorization_1.createAuthorization)(infoPath),
|
|
43
43
|
frontMatter.show_extensions && (0, createVendorExtensions_1.createVendorExtensions)(extensions),
|
|
44
44
|
(0, createDeprecationNotice_1.createDeprecationNotice)({ deprecated, description: deprecatedDescription }),
|
|
45
45
|
(0, createDescription_1.createDescription)(description),
|
|
46
|
+
(0, createRequestHeader_1.createRequestHeader)("Request"),
|
|
46
47
|
(0, createParamsDetails_1.createParamsDetails)({ parameters, type: "path" }),
|
|
47
48
|
(0, createParamsDetails_1.createParamsDetails)({ parameters, type: "query" }),
|
|
48
49
|
(0, createParamsDetails_1.createParamsDetails)({ parameters, type: "header" }),
|
|
49
50
|
(0, createParamsDetails_1.createParamsDetails)({ parameters, type: "cookie" }),
|
|
50
51
|
(0, createRequestBodyDetails_1.createRequestBodyDetails)({
|
|
51
|
-
title: "
|
|
52
|
+
title: "Body",
|
|
52
53
|
body: requestBody,
|
|
53
54
|
}),
|
|
54
55
|
(0, createStatusCodes_1.createStatusCodes)({ responses }),
|
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-beta.
|
|
4
|
+
"version": "0.0.0-beta.656",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"keywords": [
|
|
7
7
|
"openapi",
|
|
@@ -60,5 +60,5 @@
|
|
|
60
60
|
"engines": {
|
|
61
61
|
"node": ">=14"
|
|
62
62
|
},
|
|
63
|
-
"gitHead": "
|
|
63
|
+
"gitHead": "6c2e5c4c756a07b333560c08616ef0e87516df75"
|
|
64
64
|
}
|
|
@@ -32,7 +32,8 @@ export function createParamsDetails({ parameters, type }: Props) {
|
|
|
32
32
|
children: [
|
|
33
33
|
createDetailsSummary({
|
|
34
34
|
children: [
|
|
35
|
-
create("
|
|
35
|
+
create("h3", {
|
|
36
|
+
className: "openapi-markdown__details-summary-header-params",
|
|
36
37
|
children: `${
|
|
37
38
|
type.charAt(0).toUpperCase() + type.slice(1)
|
|
38
39
|
} Parameters`,
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/* ============================================================================
|
|
2
|
+
* Copyright (c) Palo Alto Networks
|
|
3
|
+
*
|
|
4
|
+
* This source code is licensed under the MIT license found in the
|
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
|
6
|
+
* ========================================================================== */
|
|
7
|
+
|
|
8
|
+
export function createRequestHeader(header: string) {
|
|
9
|
+
return `## ${header}\n\n`;
|
|
10
|
+
}
|
|
@@ -5,6 +5,8 @@
|
|
|
5
5
|
* LICENSE file in the root directory of this source tree.
|
|
6
6
|
* ========================================================================== */
|
|
7
7
|
|
|
8
|
+
import clsx from "clsx";
|
|
9
|
+
|
|
8
10
|
import { MediaTypeObject, SchemaObject } from "../openapi/types";
|
|
9
11
|
import {
|
|
10
12
|
createClosingArrayBracket,
|
|
@@ -467,8 +469,8 @@ function createDetailsNode(
|
|
|
467
469
|
className: "openapi-schema__container",
|
|
468
470
|
children: [
|
|
469
471
|
create("strong", {
|
|
470
|
-
|
|
471
|
-
|
|
472
|
+
className: clsx("openapi-schema__property", {
|
|
473
|
+
"openapi-schema__strikethrough": schema.deprecated,
|
|
472
474
|
}),
|
|
473
475
|
children: name,
|
|
474
476
|
}),
|
|
@@ -490,7 +492,7 @@ function createDetailsNode(
|
|
|
490
492
|
),
|
|
491
493
|
guard(nullable, () => [
|
|
492
494
|
create("span", {
|
|
493
|
-
className: "
|
|
495
|
+
className: "openapi-schema__nullable",
|
|
494
496
|
children: "nullable",
|
|
495
497
|
}),
|
|
496
498
|
]),
|
|
@@ -500,16 +502,14 @@ function createDetailsNode(
|
|
|
500
502
|
: required === true,
|
|
501
503
|
() => [
|
|
502
504
|
create("span", {
|
|
503
|
-
className:
|
|
504
|
-
"badge badge--danger openapi-schema__required",
|
|
505
|
+
className: "openapi-schema__required",
|
|
505
506
|
children: "required",
|
|
506
507
|
}),
|
|
507
508
|
]
|
|
508
509
|
),
|
|
509
510
|
guard(schema.deprecated, () => [
|
|
510
511
|
create("span", {
|
|
511
|
-
className:
|
|
512
|
-
"badge badge--warning openapi-schema__deprecated",
|
|
512
|
+
className: "openapi-schema__deprecated",
|
|
513
513
|
children: "deprecated",
|
|
514
514
|
}),
|
|
515
515
|
]),
|
|
@@ -561,14 +561,14 @@ function createPropertyDiscriminator(
|
|
|
561
561
|
}
|
|
562
562
|
|
|
563
563
|
return create("div", {
|
|
564
|
-
className: "openapi-discriminator__item",
|
|
564
|
+
className: "openapi-discriminator__item openapi-schema__list-item",
|
|
565
565
|
children: create("div", {
|
|
566
566
|
children: [
|
|
567
567
|
create("span", {
|
|
568
568
|
className: "openapi-schema__container",
|
|
569
569
|
children: [
|
|
570
570
|
create("strong", {
|
|
571
|
-
className: "openapi-discriminator__name",
|
|
571
|
+
className: "openapi-discriminator__name openapi-schema__property",
|
|
572
572
|
children: name,
|
|
573
573
|
}),
|
|
574
574
|
guard(schemaName, (name) =>
|
|
@@ -579,7 +579,7 @@ function createPropertyDiscriminator(
|
|
|
579
579
|
),
|
|
580
580
|
guard(required, () => [
|
|
581
581
|
create("span", {
|
|
582
|
-
className: "
|
|
582
|
+
className: "openapi-schema__required",
|
|
583
583
|
children: "required",
|
|
584
584
|
}),
|
|
585
585
|
]),
|
|
@@ -895,19 +895,22 @@ export function createRequestSchema({ title, body, ...rest }: Props) {
|
|
|
895
895
|
value: `${mimeType}`,
|
|
896
896
|
children: [
|
|
897
897
|
createDetails({
|
|
898
|
-
className: "openapi-markdown__details",
|
|
898
|
+
className: "openapi-markdown__details mime",
|
|
899
899
|
"data-collapsed": false,
|
|
900
900
|
open: true,
|
|
901
901
|
...rest,
|
|
902
902
|
children: [
|
|
903
903
|
createDetailsSummary({
|
|
904
|
-
|
|
904
|
+
className: "openapi-markdown__details-summary-mime",
|
|
905
905
|
children: [
|
|
906
|
-
create("
|
|
906
|
+
create("h3", {
|
|
907
|
+
className:
|
|
908
|
+
"openapi-markdown__details-summary-header-body",
|
|
909
|
+
children: `${title}`,
|
|
910
|
+
}),
|
|
907
911
|
guard(body.required && body.required === true, () => [
|
|
908
912
|
create("span", {
|
|
909
|
-
className:
|
|
910
|
-
"badge badge--danger openapi-schema__required",
|
|
913
|
+
className: "openapi-schema__required",
|
|
911
914
|
children: "required",
|
|
912
915
|
}),
|
|
913
916
|
]),
|
|
@@ -958,15 +961,18 @@ export function createRequestSchema({ title, body, ...rest }: Props) {
|
|
|
958
961
|
value: `${randomFirstKey}-schema`,
|
|
959
962
|
children: [
|
|
960
963
|
createDetails({
|
|
961
|
-
className: "openapi-markdown__details",
|
|
964
|
+
className: "openapi-markdown__details mime",
|
|
962
965
|
"data-collapsed": false,
|
|
963
966
|
open: true,
|
|
964
967
|
...rest,
|
|
965
968
|
children: [
|
|
966
969
|
createDetailsSummary({
|
|
967
|
-
|
|
970
|
+
className: "openapi-markdown__details-summary-mime",
|
|
968
971
|
children: [
|
|
969
|
-
create("
|
|
972
|
+
create("h3", {
|
|
973
|
+
className: "openapi-markdown__details-summary-header-body",
|
|
974
|
+
children: `${title}`,
|
|
975
|
+
}),
|
|
970
976
|
guard(firstBody.type === "array", (format) =>
|
|
971
977
|
create("span", {
|
|
972
978
|
style: { opacity: "0.6" },
|
|
@@ -975,7 +981,7 @@ export function createRequestSchema({ title, body, ...rest }: Props) {
|
|
|
975
981
|
),
|
|
976
982
|
guard(body.required, () => [
|
|
977
983
|
create("strong", {
|
|
978
|
-
className: "
|
|
984
|
+
className: "openapi-schema__required",
|
|
979
985
|
children: "required",
|
|
980
986
|
}),
|
|
981
987
|
]),
|
|
@@ -5,6 +5,8 @@
|
|
|
5
5
|
* LICENSE file in the root directory of this source tree.
|
|
6
6
|
* ========================================================================== */
|
|
7
7
|
|
|
8
|
+
import clsx from "clsx";
|
|
9
|
+
|
|
8
10
|
import { MediaTypeObject, SchemaObject } from "../openapi/types";
|
|
9
11
|
import {
|
|
10
12
|
createClosingArrayBracket,
|
|
@@ -472,8 +474,8 @@ function createDetailsNode(
|
|
|
472
474
|
className: "openapi-schema__container",
|
|
473
475
|
children: [
|
|
474
476
|
create("strong", {
|
|
475
|
-
|
|
476
|
-
|
|
477
|
+
className: clsx("openapi-schema__property", {
|
|
478
|
+
"openapi-schema__strikethrough": schema.deprecated,
|
|
477
479
|
}),
|
|
478
480
|
children: name,
|
|
479
481
|
}),
|
|
@@ -495,7 +497,7 @@ function createDetailsNode(
|
|
|
495
497
|
),
|
|
496
498
|
guard(nullable, () => [
|
|
497
499
|
create("span", {
|
|
498
|
-
className: "
|
|
500
|
+
className: "openapi-schema__nullable",
|
|
499
501
|
children: "nullable",
|
|
500
502
|
}),
|
|
501
503
|
]),
|
|
@@ -505,16 +507,14 @@ function createDetailsNode(
|
|
|
505
507
|
: required === true,
|
|
506
508
|
() => [
|
|
507
509
|
create("span", {
|
|
508
|
-
className:
|
|
509
|
-
"badge badge--danger openapi-schema__required",
|
|
510
|
+
className: "openapi-schema__required",
|
|
510
511
|
children: "required",
|
|
511
512
|
}),
|
|
512
513
|
]
|
|
513
514
|
),
|
|
514
515
|
guard(schema.deprecated, () => [
|
|
515
516
|
create("span", {
|
|
516
|
-
className:
|
|
517
|
-
"badge badge--warning openapi-schema__deprecated",
|
|
517
|
+
className: "openapi-schema__deprecated",
|
|
518
518
|
children: "deprecated",
|
|
519
519
|
}),
|
|
520
520
|
]),
|
|
@@ -566,14 +566,14 @@ function createPropertyDiscriminator(
|
|
|
566
566
|
}
|
|
567
567
|
|
|
568
568
|
return create("div", {
|
|
569
|
-
className: "openapi-discriminator__item",
|
|
569
|
+
className: "openapi-discriminator__item openapi-schema__list-item",
|
|
570
570
|
children: create("div", {
|
|
571
571
|
children: [
|
|
572
572
|
create("span", {
|
|
573
573
|
className: "openapi-schema__container",
|
|
574
574
|
children: [
|
|
575
575
|
create("strong", {
|
|
576
|
-
className: "openapi-discriminator__name",
|
|
576
|
+
className: "openapi-discriminator__name openapi-schema__property",
|
|
577
577
|
children: name,
|
|
578
578
|
}),
|
|
579
579
|
guard(schemaName, (name) =>
|
|
@@ -584,7 +584,7 @@ function createPropertyDiscriminator(
|
|
|
584
584
|
),
|
|
585
585
|
guard(required, () => [
|
|
586
586
|
create("span", {
|
|
587
|
-
className: "
|
|
587
|
+
className: "openapi-schema__required",
|
|
588
588
|
children: "required",
|
|
589
589
|
}),
|
|
590
590
|
]),
|
|
@@ -922,21 +922,21 @@ export function createResponseSchema({ title, body, ...rest }: Props) {
|
|
|
922
922
|
value: `${title}`,
|
|
923
923
|
children: [
|
|
924
924
|
createDetails({
|
|
925
|
-
className: "openapi-markdown__details",
|
|
925
|
+
className: "openapi-markdown__details response",
|
|
926
926
|
"data-collapsed": false,
|
|
927
927
|
open: true,
|
|
928
928
|
...rest,
|
|
929
929
|
children: [
|
|
930
930
|
createDetailsSummary({
|
|
931
|
-
|
|
931
|
+
className:
|
|
932
|
+
"openapi-markdown__details-summary-response",
|
|
932
933
|
children: [
|
|
933
934
|
create("strong", { children: `${title}` }),
|
|
934
935
|
guard(
|
|
935
936
|
body.required && body.required === true,
|
|
936
937
|
() => [
|
|
937
938
|
create("span", {
|
|
938
|
-
className:
|
|
939
|
-
"badge badge--danger openapi-schema__required",
|
|
939
|
+
className: "openapi-schema__required",
|
|
940
940
|
children: "required",
|
|
941
941
|
}),
|
|
942
942
|
]
|
package/src/markdown/index.ts
CHANGED
|
@@ -24,6 +24,7 @@ import { createLogo } from "./createLogo";
|
|
|
24
24
|
import { createMethodEndpoint } from "./createMethodEndpoint";
|
|
25
25
|
import { createParamsDetails } from "./createParamsDetails";
|
|
26
26
|
import { createRequestBodyDetails } from "./createRequestBodyDetails";
|
|
27
|
+
import { createRequestHeader } from "./createRequestHeader";
|
|
27
28
|
import { createStatusCodes } from "./createStatusCodes";
|
|
28
29
|
import { createTermsOfService } from "./createTermsOfService";
|
|
29
30
|
import { createVendorExtensions } from "./createVendorExtensions";
|
|
@@ -70,17 +71,17 @@ export function createApiPageMD({
|
|
|
70
71
|
`import TabItem from "@theme/TabItem";\n\n`,
|
|
71
72
|
createHeading(title.replace(lessThan, "<").replace(greaterThan, ">")),
|
|
72
73
|
createMethodEndpoint(method, path),
|
|
73
|
-
`## ${title.replace(lessThan, "<").replace(greaterThan, ">")}\n\n`,
|
|
74
74
|
infoPath && createAuthorization(infoPath),
|
|
75
75
|
frontMatter.show_extensions && createVendorExtensions(extensions),
|
|
76
76
|
createDeprecationNotice({ deprecated, description: deprecatedDescription }),
|
|
77
77
|
createDescription(description),
|
|
78
|
+
createRequestHeader("Request"),
|
|
78
79
|
createParamsDetails({ parameters, type: "path" }),
|
|
79
80
|
createParamsDetails({ parameters, type: "query" }),
|
|
80
81
|
createParamsDetails({ parameters, type: "header" }),
|
|
81
82
|
createParamsDetails({ parameters, type: "cookie" }),
|
|
82
83
|
createRequestBodyDetails({
|
|
83
|
-
title: "
|
|
84
|
+
title: "Body",
|
|
84
85
|
body: requestBody,
|
|
85
86
|
} as Props),
|
|
86
87
|
createStatusCodes({ responses }),
|