docusaurus-theme-openapi-docs 4.4.0 → 4.5.0
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/theme/ApiExplorer/ApiCodeBlock/Content/String.js +3 -3
- package/lib/theme/ApiExplorer/ApiCodeBlock/CopyButton/index.d.ts +5 -1
- package/lib/theme/ApiExplorer/Authorization/slice.js +2 -2
- package/lib/theme/ApiExplorer/Body/slice.js +2 -2
- package/lib/theme/ApiExplorer/CodeSnippets/index.d.ts +3 -3
- package/lib/theme/ApiExplorer/Request/index.js +2 -2
- package/lib/theme/ApiExplorer/Request/makeRequest.d.ts +1 -1
- package/lib/theme/ApiExplorer/Request/makeRequest.js +3 -2
- package/lib/theme/ApiExplorer/Response/slice.js +2 -2
- package/lib/theme/ApiExplorer/Server/slice.js +2 -2
- package/lib/theme/ApiExplorer/buildPostmanRequest.d.ts +1 -1
- package/lib/theme/ApiExplorer/buildPostmanRequest.js +119 -46
- package/lib/theme/ApiExplorer/index.js +58 -2
- package/lib/theme/CodeSamples/_CodeSamples.scss +3 -0
- package/lib/theme/CodeSamples/index.d.ts +8 -0
- package/lib/theme/{ResponseSamples → CodeSamples}/index.js +4 -4
- package/lib/theme/ParamsItem/index.d.ts +1 -4
- package/lib/theme/ResponseExamples/index.js +9 -9
- package/lib/theme/Schema/index.js +39 -97
- package/lib/theme/SchemaItem/index.js +34 -0
- package/lib/theme/styles.scss +1 -1
- package/lib/types.d.ts +5 -116
- package/package.json +5 -3
- package/src/theme/ApiExplorer/ApiCodeBlock/Content/String.tsx +3 -3
- package/src/theme/ApiExplorer/ApiCodeBlock/CopyButton/index.tsx +5 -1
- package/src/theme/ApiExplorer/CodeSnippets/index.tsx +3 -3
- package/src/theme/ApiExplorer/Request/index.tsx +2 -2
- package/src/theme/ApiExplorer/Request/makeRequest.ts +4 -3
- package/src/theme/ApiExplorer/buildPostmanRequest.ts +48 -18
- package/src/theme/ApiExplorer/index.tsx +4 -2
- package/src/theme/CodeSamples/_CodeSamples.scss +3 -0
- package/src/theme/{ResponseSamples → CodeSamples}/index.tsx +5 -10
- package/src/theme/ParamsItem/index.tsx +1 -5
- package/src/theme/ResponseExamples/index.tsx +6 -9
- package/src/theme/Schema/index.tsx +47 -78
- package/src/theme/SchemaItem/index.tsx +27 -0
- package/src/theme/styles.scss +1 -1
- package/src/types.ts +5 -115
- package/tsconfig.tsbuildinfo +1 -1
- package/lib/theme/ResponseSamples/_ResponseSamples.scss +0 -3
- package/lib/theme/ResponseSamples/index.d.ts +0 -8
- package/src/theme/ApiExplorer/postman-collection.d.ts +0 -10
- package/src/theme/ApiExplorer/react-modal.d.ts +0 -8
- package/src/theme/ResponseSamples/_ResponseSamples.scss +0 -3
- package/src/theme-translations.d.ts +0 -9
|
@@ -12,7 +12,7 @@ import Request from "@theme/ApiExplorer/Request";
|
|
|
12
12
|
import Response from "@theme/ApiExplorer/Response";
|
|
13
13
|
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
|
14
14
|
import { ApiItem } from "docusaurus-plugin-openapi-docs/src/types";
|
|
15
|
-
import sdk from "postman-collection";
|
|
15
|
+
import * as sdk from "postman-collection";
|
|
16
16
|
|
|
17
17
|
function ApiExplorer({
|
|
18
18
|
item,
|
|
@@ -21,7 +21,9 @@ function ApiExplorer({
|
|
|
21
21
|
item: NonNullable<ApiItem>;
|
|
22
22
|
infoPath: string;
|
|
23
23
|
}) {
|
|
24
|
-
const postman = new sdk.Request(
|
|
24
|
+
const postman = new sdk.Request(
|
|
25
|
+
item.postman ? (item.postman as any).toJSON() : {}
|
|
26
|
+
);
|
|
25
27
|
|
|
26
28
|
return (
|
|
27
29
|
<>
|
|
@@ -11,21 +11,16 @@ import CodeBlock from "@theme/CodeBlock";
|
|
|
11
11
|
import { Language } from "prism-react-renderer";
|
|
12
12
|
|
|
13
13
|
export interface Props {
|
|
14
|
-
readonly
|
|
14
|
+
readonly example: string;
|
|
15
15
|
readonly language: Language;
|
|
16
16
|
}
|
|
17
17
|
|
|
18
|
-
function
|
|
19
|
-
responseExample,
|
|
20
|
-
language,
|
|
21
|
-
}: Props): React.JSX.Element {
|
|
18
|
+
function CodeSamples({ example, language }: Props): React.JSX.Element {
|
|
22
19
|
return (
|
|
23
|
-
<div className="openapi-
|
|
24
|
-
<CodeBlock language={language ? language : "json"}>
|
|
25
|
-
{responseExample}
|
|
26
|
-
</CodeBlock>
|
|
20
|
+
<div className="openapi-code__code-samples-container">
|
|
21
|
+
<CodeBlock language={language ? language : "json"}>{example}</CodeBlock>
|
|
27
22
|
</div>
|
|
28
23
|
);
|
|
29
24
|
}
|
|
30
25
|
|
|
31
|
-
export default
|
|
26
|
+
export default CodeSamples;
|
|
@@ -16,10 +16,6 @@ import clsx from "clsx";
|
|
|
16
16
|
import { getQualifierMessage, getSchemaName } from "../../markdown/schema";
|
|
17
17
|
import { guard, toString } from "../../markdown/utils";
|
|
18
18
|
|
|
19
|
-
interface Map<T> {
|
|
20
|
-
[key: string]: T;
|
|
21
|
-
}
|
|
22
|
-
|
|
23
19
|
export interface ExampleObject {
|
|
24
20
|
summary?: string;
|
|
25
21
|
description?: string;
|
|
@@ -32,7 +28,7 @@ export interface Props {
|
|
|
32
28
|
param: {
|
|
33
29
|
description: string;
|
|
34
30
|
example: any;
|
|
35
|
-
examples:
|
|
31
|
+
examples: Record<string, ExampleObject>;
|
|
36
32
|
name: string;
|
|
37
33
|
required: boolean;
|
|
38
34
|
deprecated: boolean;
|
|
@@ -7,8 +7,8 @@
|
|
|
7
7
|
|
|
8
8
|
import React from "react";
|
|
9
9
|
|
|
10
|
+
import CodeSamples from "@theme/CodeSamples";
|
|
10
11
|
import Markdown from "@theme/Markdown";
|
|
11
|
-
import ResponseSamples from "@theme/ResponseSamples";
|
|
12
12
|
import TabItem from "@theme/TabItem";
|
|
13
13
|
import { sampleResponseFromSchema } from "docusaurus-plugin-openapi-docs/lib/openapi/createResponseExample";
|
|
14
14
|
import format from "xml-formatter";
|
|
@@ -78,10 +78,7 @@ export const ResponseExamples: React.FC<ResponseExamplesProps> = ({
|
|
|
78
78
|
{exampleValue.summary}
|
|
79
79
|
</Markdown>
|
|
80
80
|
)}
|
|
81
|
-
<
|
|
82
|
-
responseExample={responseExample}
|
|
83
|
-
language={language}
|
|
84
|
-
/>
|
|
81
|
+
<CodeSamples example={responseExample} language={language} />
|
|
85
82
|
</TabItem>
|
|
86
83
|
);
|
|
87
84
|
}
|
|
@@ -120,7 +117,7 @@ export const ResponseExample: React.FC<ResponseExampleProps> = ({
|
|
|
120
117
|
{responseExample.summary}
|
|
121
118
|
</Markdown>
|
|
122
119
|
)}
|
|
123
|
-
<
|
|
120
|
+
<CodeSamples example={exampleContent} language={language} />
|
|
124
121
|
</TabItem>
|
|
125
122
|
);
|
|
126
123
|
};
|
|
@@ -167,7 +164,7 @@ export const ExampleFromSchema: React.FC<ExampleFromSchemaProps> = ({
|
|
|
167
164
|
return (
|
|
168
165
|
// @ts-ignore
|
|
169
166
|
<TabItem label="Example (auto)" value="Example (auto)">
|
|
170
|
-
<
|
|
167
|
+
<CodeSamples example={xmlExample} language="xml" />
|
|
171
168
|
</TabItem>
|
|
172
169
|
);
|
|
173
170
|
}
|
|
@@ -180,8 +177,8 @@ export const ExampleFromSchema: React.FC<ExampleFromSchemaProps> = ({
|
|
|
180
177
|
return (
|
|
181
178
|
// @ts-ignore
|
|
182
179
|
<TabItem label="Example (auto)" value="Example (auto)">
|
|
183
|
-
<
|
|
184
|
-
|
|
180
|
+
<CodeSamples
|
|
181
|
+
example={JSON.stringify(responseExample, null, 2)}
|
|
185
182
|
language="json"
|
|
186
183
|
/>
|
|
187
184
|
</TabItem>
|
|
@@ -21,7 +21,10 @@ import {
|
|
|
21
21
|
getQualifierMessage,
|
|
22
22
|
getSchemaName,
|
|
23
23
|
} from "docusaurus-plugin-openapi-docs/lib/markdown/schema";
|
|
24
|
-
import {
|
|
24
|
+
import {
|
|
25
|
+
SchemaObject,
|
|
26
|
+
SchemaType,
|
|
27
|
+
} from "docusaurus-plugin-openapi-docs/lib/openapi/types";
|
|
25
28
|
import isEmpty from "lodash/isEmpty";
|
|
26
29
|
|
|
27
30
|
// eslint-disable-next-line import/no-extraneous-dependencies
|
|
@@ -113,7 +116,7 @@ const AnyOneOf: React.FC<SchemaProps> = ({ schema, schemaType }) => {
|
|
|
113
116
|
</span>
|
|
114
117
|
<SchemaTabs>
|
|
115
118
|
{schema[type]?.map((anyOneSchema: any, index: number) => {
|
|
116
|
-
const label = anyOneSchema.title ||
|
|
119
|
+
const label = anyOneSchema.title || anyOneSchema.type;
|
|
117
120
|
return (
|
|
118
121
|
// @ts-ignore
|
|
119
122
|
<TabItem
|
|
@@ -122,9 +125,7 @@ const AnyOneOf: React.FC<SchemaProps> = ({ schema, schemaType }) => {
|
|
|
122
125
|
value={`${index}-item-properties`}
|
|
123
126
|
>
|
|
124
127
|
{/* Handle primitive types directly */}
|
|
125
|
-
{
|
|
126
|
-
anyOneSchema.type
|
|
127
|
-
) && (
|
|
128
|
+
{(isPrimitive(anyOneSchema) || anyOneSchema.const) && (
|
|
128
129
|
<SchemaItem
|
|
129
130
|
collapsible={false}
|
|
130
131
|
name={undefined}
|
|
@@ -503,88 +504,42 @@ const Items: React.FC<{
|
|
|
503
504
|
schema: any;
|
|
504
505
|
schemaType: "request" | "response";
|
|
505
506
|
}> = ({ schema, schemaType }) => {
|
|
506
|
-
//
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
<OpeningArrayBracket />
|
|
511
|
-
<Properties schema={schema.items} schemaType={schemaType} />
|
|
512
|
-
<ClosingArrayBracket />
|
|
513
|
-
</>
|
|
514
|
-
);
|
|
507
|
+
// Process schema.items to handle allOf merging
|
|
508
|
+
let itemsSchema = schema.items;
|
|
509
|
+
if (schema.items?.allOf) {
|
|
510
|
+
itemsSchema = mergeAllOf(schema.items) as SchemaObject;
|
|
515
511
|
}
|
|
516
512
|
|
|
517
|
-
//
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
<OpeningArrayBracket />
|
|
522
|
-
<AdditionalProperties schema={schema.items} schemaType={schemaType} />
|
|
523
|
-
<ClosingArrayBracket />
|
|
524
|
-
</>
|
|
525
|
-
);
|
|
526
|
-
}
|
|
513
|
+
// Handle complex schemas with multiple schema types
|
|
514
|
+
const hasOneOfAnyOf = itemsSchema?.oneOf || itemsSchema?.anyOf;
|
|
515
|
+
const hasProperties = itemsSchema?.properties;
|
|
516
|
+
const hasAdditionalProperties = itemsSchema?.additionalProperties;
|
|
527
517
|
|
|
528
|
-
|
|
529
|
-
if (schema.items?.oneOf || schema.items?.anyOf) {
|
|
518
|
+
if (hasOneOfAnyOf || hasProperties || hasAdditionalProperties) {
|
|
530
519
|
return (
|
|
531
520
|
<>
|
|
532
521
|
<OpeningArrayBracket />
|
|
533
|
-
|
|
522
|
+
{hasOneOfAnyOf && (
|
|
523
|
+
<AnyOneOf schema={itemsSchema} schemaType={schemaType} />
|
|
524
|
+
)}
|
|
525
|
+
{hasProperties && (
|
|
526
|
+
<Properties schema={itemsSchema} schemaType={schemaType} />
|
|
527
|
+
)}
|
|
528
|
+
{hasAdditionalProperties && (
|
|
529
|
+
<AdditionalProperties schema={itemsSchema} schemaType={schemaType} />
|
|
530
|
+
)}
|
|
534
531
|
<ClosingArrayBracket />
|
|
535
532
|
</>
|
|
536
533
|
);
|
|
537
534
|
}
|
|
538
535
|
|
|
539
|
-
// Handles case when schema.items has allOf
|
|
540
|
-
if (schema.items?.allOf) {
|
|
541
|
-
const mergedSchemas = mergeAllOf(schema.items) as SchemaObject;
|
|
542
|
-
|
|
543
|
-
// Handles combo anyOf/oneOf + properties
|
|
544
|
-
if (
|
|
545
|
-
(mergedSchemas.oneOf || mergedSchemas.anyOf) &&
|
|
546
|
-
mergedSchemas.properties
|
|
547
|
-
) {
|
|
548
|
-
return (
|
|
549
|
-
<>
|
|
550
|
-
<OpeningArrayBracket />
|
|
551
|
-
<AnyOneOf schema={mergedSchemas} schemaType={schemaType} />
|
|
552
|
-
<Properties schema={mergedSchemas} schemaType={schemaType} />
|
|
553
|
-
<ClosingArrayBracket />
|
|
554
|
-
</>
|
|
555
|
-
);
|
|
556
|
-
}
|
|
557
|
-
|
|
558
|
-
// Handles only anyOf/oneOf
|
|
559
|
-
if (mergedSchemas.oneOf || mergedSchemas.anyOf) {
|
|
560
|
-
return (
|
|
561
|
-
<>
|
|
562
|
-
<OpeningArrayBracket />
|
|
563
|
-
<AnyOneOf schema={mergedSchemas} schemaType={schemaType} />
|
|
564
|
-
<ClosingArrayBracket />
|
|
565
|
-
</>
|
|
566
|
-
);
|
|
567
|
-
}
|
|
568
|
-
|
|
569
|
-
// Handles properties
|
|
570
|
-
if (mergedSchemas.properties) {
|
|
571
|
-
return (
|
|
572
|
-
<>
|
|
573
|
-
<OpeningArrayBracket />
|
|
574
|
-
<Properties schema={mergedSchemas} schemaType={schemaType} />
|
|
575
|
-
<ClosingArrayBracket />
|
|
576
|
-
</>
|
|
577
|
-
);
|
|
578
|
-
}
|
|
579
|
-
}
|
|
580
|
-
|
|
581
536
|
// Handles basic types (string, number, integer, boolean, object)
|
|
582
537
|
if (
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
538
|
+
itemsSchema?.type === "string" ||
|
|
539
|
+
itemsSchema?.type === "number" ||
|
|
540
|
+
itemsSchema?.type === "integer" ||
|
|
541
|
+
itemsSchema?.type === "boolean" ||
|
|
542
|
+
itemsSchema?.type === "object"
|
|
588
543
|
) {
|
|
589
544
|
return (
|
|
590
545
|
<div style={{ marginLeft: ".5rem" }}>
|
|
@@ -592,9 +547,9 @@ const Items: React.FC<{
|
|
|
592
547
|
<SchemaItem
|
|
593
548
|
collapsible={false}
|
|
594
549
|
name="" // No name for array items
|
|
595
|
-
schemaName={getSchemaName(
|
|
596
|
-
qualifierMessage={getQualifierMessage(
|
|
597
|
-
schema={
|
|
550
|
+
schemaName={getSchemaName(itemsSchema)}
|
|
551
|
+
qualifierMessage={getQualifierMessage(itemsSchema)}
|
|
552
|
+
schema={itemsSchema}
|
|
598
553
|
discriminator={false}
|
|
599
554
|
children={null}
|
|
600
555
|
/>
|
|
@@ -607,7 +562,7 @@ const Items: React.FC<{
|
|
|
607
562
|
return (
|
|
608
563
|
<>
|
|
609
564
|
<OpeningArrayBracket />
|
|
610
|
-
{Object.entries(
|
|
565
|
+
{Object.entries(itemsSchema || {}).map(([key, val]: [string, any]) => (
|
|
611
566
|
<SchemaEdge
|
|
612
567
|
key={key}
|
|
613
568
|
name={key}
|
|
@@ -937,3 +892,17 @@ const SchemaNode: React.FC<SchemaProps> = ({ schema, schemaType }) => {
|
|
|
937
892
|
};
|
|
938
893
|
|
|
939
894
|
export default SchemaNode;
|
|
895
|
+
|
|
896
|
+
type PrimitiveSchemaType = Exclude<SchemaType, "object" | "array">;
|
|
897
|
+
|
|
898
|
+
const PRIMITIVE_TYPES: Record<PrimitiveSchemaType, true> = {
|
|
899
|
+
string: true,
|
|
900
|
+
number: true,
|
|
901
|
+
integer: true,
|
|
902
|
+
boolean: true,
|
|
903
|
+
null: true,
|
|
904
|
+
} as const;
|
|
905
|
+
|
|
906
|
+
const isPrimitive = (schema: SchemaObject) => {
|
|
907
|
+
return PRIMITIVE_TYPES[schema.type as PrimitiveSchemaType];
|
|
908
|
+
};
|
|
@@ -65,6 +65,7 @@ export default function SchemaItem(props: Props) {
|
|
|
65
65
|
let example: string | undefined;
|
|
66
66
|
let nullable;
|
|
67
67
|
let enumDescriptions: [string, string][] = [];
|
|
68
|
+
let constValue: string | undefined;
|
|
68
69
|
|
|
69
70
|
if (schema) {
|
|
70
71
|
deprecated = schema.deprecated;
|
|
@@ -75,6 +76,7 @@ export default function SchemaItem(props: Props) {
|
|
|
75
76
|
nullable =
|
|
76
77
|
schema.nullable ||
|
|
77
78
|
(Array.isArray(schema.type) && schema.type.includes("null")); // support JSON Schema nullable
|
|
79
|
+
constValue = schema.const;
|
|
78
80
|
}
|
|
79
81
|
|
|
80
82
|
const renderRequired = guard(
|
|
@@ -161,6 +163,30 @@ export default function SchemaItem(props: Props) {
|
|
|
161
163
|
return undefined;
|
|
162
164
|
}
|
|
163
165
|
|
|
166
|
+
function renderConstValue() {
|
|
167
|
+
if (constValue !== undefined) {
|
|
168
|
+
if (typeof constValue === "string") {
|
|
169
|
+
return (
|
|
170
|
+
<div>
|
|
171
|
+
<strong>Constant value: </strong>
|
|
172
|
+
<span>
|
|
173
|
+
<code>{constValue}</code>
|
|
174
|
+
</span>
|
|
175
|
+
</div>
|
|
176
|
+
);
|
|
177
|
+
}
|
|
178
|
+
return (
|
|
179
|
+
<div>
|
|
180
|
+
<strong>Constant value: </strong>
|
|
181
|
+
<span>
|
|
182
|
+
<code>{JSON.stringify(constValue)}</code>
|
|
183
|
+
</span>
|
|
184
|
+
</div>
|
|
185
|
+
);
|
|
186
|
+
}
|
|
187
|
+
return undefined;
|
|
188
|
+
}
|
|
189
|
+
|
|
164
190
|
const schemaContent = (
|
|
165
191
|
<div>
|
|
166
192
|
<span className="openapi-schema__container">
|
|
@@ -184,6 +210,7 @@ export default function SchemaItem(props: Props) {
|
|
|
184
210
|
{renderSchemaDescription}
|
|
185
211
|
{renderEnumDescriptions}
|
|
186
212
|
{renderQualifierMessage}
|
|
213
|
+
{renderConstValue()}
|
|
187
214
|
{renderDefaultValue()}
|
|
188
215
|
{renderExample()}
|
|
189
216
|
{collapsibleSchemaContent ?? collapsibleSchemaContent}
|
package/src/theme/styles.scss
CHANGED
package/src/types.ts
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* LICENSE file in the root directory of this source tree.
|
|
6
6
|
* ========================================================================== */
|
|
7
7
|
|
|
8
|
-
import type {
|
|
8
|
+
import type { DocFrontMatter as DocusaurusDocFrontMatter } from "@docusaurus/plugin-content-docs";
|
|
9
9
|
import type { JSONSchema4, JSONSchema6, JSONSchema7 } from "json-schema";
|
|
10
10
|
|
|
11
11
|
export interface ThemeConfig {
|
|
@@ -15,10 +15,6 @@ export interface ThemeConfig {
|
|
|
15
15
|
};
|
|
16
16
|
}
|
|
17
17
|
|
|
18
|
-
interface Map<T> {
|
|
19
|
-
[key: string]: T;
|
|
20
|
-
}
|
|
21
|
-
|
|
22
18
|
export type JSONSchema = JSONSchema4 | JSONSchema6 | JSONSchema7;
|
|
23
19
|
export type SchemaObject = Omit<
|
|
24
20
|
JSONSchema,
|
|
@@ -38,7 +34,7 @@ export type SchemaObject = Omit<
|
|
|
38
34
|
anyOf?: SchemaObject[];
|
|
39
35
|
not?: SchemaObject;
|
|
40
36
|
items?: SchemaObject;
|
|
41
|
-
properties?:
|
|
37
|
+
properties?: Record<string, SchemaObject>;
|
|
42
38
|
additionalProperties?: boolean | SchemaObject;
|
|
43
39
|
|
|
44
40
|
// OpenAPI additions
|
|
@@ -54,7 +50,7 @@ export type SchemaObject = Omit<
|
|
|
54
50
|
|
|
55
51
|
export interface DiscriminatorObject {
|
|
56
52
|
propertyName: string;
|
|
57
|
-
mapping?:
|
|
53
|
+
mapping?: Record<string, string>;
|
|
58
54
|
}
|
|
59
55
|
|
|
60
56
|
export interface XMLObject {
|
|
@@ -70,113 +66,7 @@ export interface ExternalDocumentationObject {
|
|
|
70
66
|
url: string;
|
|
71
67
|
}
|
|
72
68
|
|
|
73
|
-
export
|
|
74
|
-
author?: string;
|
|
75
|
-
/** Date can be any
|
|
76
|
-
* [parsable date string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse).
|
|
77
|
-
*/
|
|
78
|
-
date?: Date | string;
|
|
79
|
-
};
|
|
80
|
-
|
|
81
|
-
export type DocFrontMatter = {
|
|
82
|
-
/**
|
|
83
|
-
* The last part of the doc ID (will be refactored in the future to be the
|
|
84
|
-
* full ID instead)
|
|
85
|
-
* @see {@link DocMetadata.id}
|
|
86
|
-
*/
|
|
87
|
-
id?: string;
|
|
88
|
-
/**
|
|
89
|
-
* Will override the default title collected from h1 heading.
|
|
90
|
-
* @see {@link DocMetadata.title}
|
|
91
|
-
*/
|
|
92
|
-
title?: string;
|
|
93
|
-
/**
|
|
94
|
-
* Front matter tags, unnormalized.
|
|
95
|
-
* @see {@link DocMetadata.tags}
|
|
96
|
-
*/
|
|
97
|
-
tags?: FrontMatterTag[];
|
|
98
|
-
/**
|
|
99
|
-
* If there isn't a Markdown h1 heading (which, if there is, we don't
|
|
100
|
-
* remove), this front matter will cause the front matter title to not be
|
|
101
|
-
* displayed in the doc page.
|
|
102
|
-
*/
|
|
103
|
-
hide_title?: boolean;
|
|
104
|
-
/** Hide the TOC on the right. */
|
|
105
|
-
hide_table_of_contents?: boolean;
|
|
106
|
-
/** Used in the head meta. */
|
|
107
|
-
keywords?: string[];
|
|
108
|
-
/** Used in the head meta. Should use `assets.image` in priority. */
|
|
109
|
-
image?: string;
|
|
110
|
-
/**
|
|
111
|
-
* Will override the default excerpt.
|
|
112
|
-
* @see {@link DocMetadata.description}
|
|
113
|
-
*/
|
|
114
|
-
description?: string;
|
|
115
|
-
/**
|
|
116
|
-
* Custom slug appended after /<baseUrl>/<routeBasePath>/<versionPath>
|
|
117
|
-
* @see {@link DocMetadata.slug}
|
|
118
|
-
*/
|
|
119
|
-
slug?: string;
|
|
120
|
-
/** Customizes the sidebar label for this doc. Will default to its title. */
|
|
121
|
-
sidebar_label?: string;
|
|
122
|
-
/**
|
|
123
|
-
* Controls the position of a doc inside the generated sidebar slice when
|
|
124
|
-
* using autogenerated sidebar items.
|
|
125
|
-
*
|
|
126
|
-
* @see https://docusaurus.io/docs/sidebar#autogenerated-sidebar-metadata
|
|
127
|
-
*/
|
|
128
|
-
sidebar_position?: number;
|
|
129
|
-
/**
|
|
130
|
-
* Gives the corresponding sidebar label a special class name when using
|
|
131
|
-
* autogenerated sidebars.
|
|
132
|
-
*/
|
|
133
|
-
sidebar_class_name?: string;
|
|
134
|
-
/**
|
|
135
|
-
* Will be propagated to the final sidebars data structure. Useful if you
|
|
136
|
-
* have swizzled sidebar-related code or simply querying doc data through
|
|
137
|
-
* sidebars.
|
|
138
|
-
*/
|
|
139
|
-
sidebar_custom_props?: { [key: string]: unknown };
|
|
140
|
-
/**
|
|
141
|
-
* Changes the sidebar association of the current doc. Use `null` to make
|
|
142
|
-
* the current doc not associated to any sidebar.
|
|
143
|
-
*/
|
|
144
|
-
displayed_sidebar?: string | null;
|
|
145
|
-
/**
|
|
146
|
-
* Customizes the pagination label for this doc. Will default to the sidebar
|
|
147
|
-
* label.
|
|
148
|
-
*/
|
|
149
|
-
pagination_label?: string;
|
|
150
|
-
/** Overrides the default URL computed for this doc. */
|
|
151
|
-
custom_edit_url?: string | null;
|
|
152
|
-
/**
|
|
153
|
-
* Whether number prefix parsing is disabled on this doc.
|
|
154
|
-
* @see https://docusaurus.io/docs/sidebar#using-number-prefixes
|
|
155
|
-
*/
|
|
156
|
-
parse_number_prefixes?: boolean;
|
|
157
|
-
/**
|
|
158
|
-
* Minimum TOC heading level. Must be between 2 and 6 and lower or equal to
|
|
159
|
-
* the max value.
|
|
160
|
-
*/
|
|
161
|
-
toc_min_heading_level?: number;
|
|
162
|
-
/** Maximum TOC heading level. Must be between 2 and 6. */
|
|
163
|
-
toc_max_heading_level?: number;
|
|
164
|
-
/**
|
|
165
|
-
* The ID of the documentation you want the "Next" pagination to link to.
|
|
166
|
-
* Use `null` to disable showing "Next" for this page.
|
|
167
|
-
* @see {@link DocMetadata.next}
|
|
168
|
-
*/
|
|
169
|
-
pagination_next?: string | null;
|
|
170
|
-
/**
|
|
171
|
-
* The ID of the documentation you want the "Previous" pagination to link
|
|
172
|
-
* to. Use `null` to disable showing "Previous" for this page.
|
|
173
|
-
* @see {@link DocMetadata.prev}
|
|
174
|
-
*/
|
|
175
|
-
pagination_prev?: string | null;
|
|
176
|
-
/** Should this doc be excluded from production builds? */
|
|
177
|
-
draft?: boolean;
|
|
178
|
-
/** Allows overriding the last updated author and/or date. */
|
|
179
|
-
last_update?: FileChange;
|
|
69
|
+
export interface DocFrontMatter extends DocusaurusDocFrontMatter {
|
|
180
70
|
/** Provides OpenAPI Docs with a reference path to their respective Info Doc */
|
|
181
71
|
info_path?: string;
|
|
182
|
-
}
|
|
72
|
+
}
|
package/tsconfig.tsbuildinfo
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"root":["./src/index.ts","./src/plugin-content-docs.d.ts","./src/postman-code-generators.d.ts","./src/react-magic-dropzone.d.ts","./src/theme-classic.d.ts","./src/theme-openapi.d.ts","./src/
|
|
1
|
+
{"root":["./src/index.ts","./src/plugin-content-docs.d.ts","./src/postman-code-generators.d.ts","./src/react-magic-dropzone.d.ts","./src/theme-classic.d.ts","./src/theme-openapi.d.ts","./src/types.ts","./src/markdown/createDescription.ts","./src/markdown/schema.ts","./src/markdown/utils.test.ts","./src/markdown/utils.ts","./src/theme/ApiExplorer/buildPostmanRequest.ts","./src/theme/ApiExplorer/index.tsx","./src/theme/ApiExplorer/persistanceMiddleware.ts","./src/theme/ApiExplorer/storage-utils.ts","./src/theme/ApiExplorer/Accept/index.tsx","./src/theme/ApiExplorer/Accept/slice.ts","./src/theme/ApiExplorer/ApiCodeBlock/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/Container/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/Content/Element.tsx","./src/theme/ApiExplorer/ApiCodeBlock/Content/String.tsx","./src/theme/ApiExplorer/ApiCodeBlock/CopyButton/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/ExitButton/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/ExpandButton/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/Line/index.tsx","./src/theme/ApiExplorer/ApiCodeBlock/WordWrapButton/index.tsx","./src/theme/ApiExplorer/Authorization/auth-types.ts","./src/theme/ApiExplorer/Authorization/index.tsx","./src/theme/ApiExplorer/Authorization/slice.ts","./src/theme/ApiExplorer/Body/index.tsx","./src/theme/ApiExplorer/Body/slice.ts","./src/theme/ApiExplorer/CodeSnippets/code-snippets-types.ts","./src/theme/ApiExplorer/CodeSnippets/index.tsx","./src/theme/ApiExplorer/CodeSnippets/languages.ts","./src/theme/ApiExplorer/CodeTabs/index.tsx","./src/theme/ApiExplorer/ContentType/index.tsx","./src/theme/ApiExplorer/ContentType/slice.ts","./src/theme/ApiExplorer/Export/index.tsx","./src/theme/ApiExplorer/FloatingButton/index.tsx","./src/theme/ApiExplorer/FormFileUpload/index.tsx","./src/theme/ApiExplorer/FormItem/index.tsx","./src/theme/ApiExplorer/FormMultiSelect/index.tsx","./src/theme/ApiExplorer/FormSelect/index.tsx","./src/theme/ApiExplorer/FormTextInput/index.tsx","./src/theme/ApiExplorer/LiveEditor/index.tsx","./src/theme/ApiExplorer/MethodEndpoint/index.tsx","./src/theme/ApiExplorer/ParamOptions/index.tsx","./src/theme/ApiExplorer/ParamOptions/slice.ts","./src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamArrayFormItem.tsx","./src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamBooleanFormItem.tsx","./src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamMultiSelectFormItem.tsx","./src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamSelectFormItem.tsx","./src/theme/ApiExplorer/ParamOptions/ParamFormItems/ParamTextFormItem.tsx","./src/theme/ApiExplorer/Request/index.tsx","./src/theme/ApiExplorer/Request/makeRequest.ts","./src/theme/ApiExplorer/Response/index.tsx","./src/theme/ApiExplorer/Response/slice.ts","./src/theme/ApiExplorer/SecuritySchemes/index.tsx","./src/theme/ApiExplorer/Server/index.tsx","./src/theme/ApiExplorer/Server/slice.ts","./src/theme/ApiItem/hooks.ts","./src/theme/ApiItem/index.tsx","./src/theme/ApiItem/store.ts","./src/theme/ApiItem/Layout/index.tsx","./src/theme/ApiLogo/index.tsx","./src/theme/ApiTabs/index.tsx","./src/theme/ArrayBrackets/index.tsx","./src/theme/CodeSamples/index.tsx","./src/theme/DiscriminatorTabs/index.tsx","./src/theme/MimeTabs/index.tsx","./src/theme/OperationTabs/index.tsx","./src/theme/ParamsDetails/index.tsx","./src/theme/ParamsItem/index.tsx","./src/theme/RequestSchema/index.tsx","./src/theme/ResponseExamples/index.tsx","./src/theme/ResponseHeaders/index.tsx","./src/theme/ResponseSchema/index.tsx","./src/theme/Schema/index.tsx","./src/theme/SchemaItem/index.tsx","./src/theme/SchemaTabs/index.tsx","./src/theme/SkeletonLoader/index.tsx","./src/theme/StatusCodes/index.tsx"],"version":"5.8.3"}
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import React from "react";
|
|
2
|
-
import { Language } from "prism-react-renderer";
|
|
3
|
-
export interface Props {
|
|
4
|
-
readonly responseExample: string;
|
|
5
|
-
readonly language: Language;
|
|
6
|
-
}
|
|
7
|
-
declare function ResponseSamples({ responseExample, language, }: Props): React.JSX.Element;
|
|
8
|
-
export default ResponseSamples;
|
|
@@ -1,10 +0,0 @@
|
|
|
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
|
-
declare module "postman-collection" {
|
|
9
|
-
export = Request.sdk;
|
|
10
|
-
}
|
|
@@ -1,8 +0,0 @@
|
|
|
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
|
-
declare module "react-modal";
|
|
@@ -1,9 +0,0 @@
|
|
|
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
|
-
// TODO: Remove this when https://github.com/facebook/docusaurus/issues/6087 is resolved.
|
|
9
|
-
declare module "@docusaurus/theme-translations";
|