@redocly/config 0.7.0 → 0.8.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/default-theme-config-schema.d.ts +1880 -1879
- package/lib/default-theme-config-schema.js +3 -1
- package/lib/index.d.ts +1 -0
- package/lib/index.js +3 -1
- package/lib/portal-shared-types.d.ts +0 -1
- package/lib/redoc-config-schema.d.ts +0 -1375
- package/lib/redoc-config-schema.js +35 -5
- package/lib/redoc-types.d.ts +2 -2
- package/lib/root-config-schema.d.ts +5777 -5776
- package/lib/root-config-schema.js +1 -1
- package/lib-esm/default-theme-config-schema.d.ts +1880 -1879
- package/lib-esm/default-theme-config-schema.js +3 -1
- package/lib-esm/index.d.ts +1 -0
- package/lib-esm/index.js +1 -0
- package/lib-esm/portal-shared-types.d.ts +0 -1
- package/lib-esm/redoc-config-schema.d.ts +0 -1375
- package/lib-esm/redoc-config-schema.js +35 -5
- package/lib-esm/redoc-types.d.ts +2 -2
- package/lib-esm/root-config-schema.d.ts +5777 -5776
- package/lib-esm/root-config-schema.js +1 -1
- package/package.json +1 -1
|
@@ -2,7 +2,6 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.redocConfigSchema = void 0;
|
|
4
4
|
const feedback_config_schema_1 = require("./feedback-config-schema");
|
|
5
|
-
const reference_docs_config_schema_1 = require("./reference-docs-config-schema");
|
|
6
5
|
const codeSamplesConfigSchema = {
|
|
7
6
|
type: 'object',
|
|
8
7
|
properties: {
|
|
@@ -69,22 +68,53 @@ const downloadUrlsSchema = {
|
|
|
69
68
|
};
|
|
70
69
|
exports.redocConfigSchema = {
|
|
71
70
|
type: 'object',
|
|
72
|
-
properties:
|
|
71
|
+
properties: {
|
|
72
|
+
licenseKey: { type: 'string' },
|
|
73
|
+
hideLoading: { type: 'boolean' },
|
|
74
|
+
disableRouter: { type: 'boolean' },
|
|
75
|
+
hideSidebar: { type: 'boolean' },
|
|
76
|
+
feedback: feedback_config_schema_1.feedbackConfigSchema,
|
|
77
|
+
hideReplay: { type: 'boolean' },
|
|
78
|
+
oAuth2RedirectURI: { type: 'string', nullable: true },
|
|
79
|
+
corsProxyUrl: { type: 'string' },
|
|
80
|
+
sortRequiredPropsFirst: { type: 'boolean' },
|
|
81
|
+
sanitize: { type: 'boolean' },
|
|
82
|
+
hideDownloadButtons: { type: 'boolean' },
|
|
83
|
+
downloadUrls: downloadUrlsSchema,
|
|
84
|
+
onlyRequiredInSamples: { type: 'boolean' },
|
|
85
|
+
generatedSamplesMaxDepth: { oneOf: [{ type: 'number' }, { type: 'string' }] },
|
|
86
|
+
showExtensions: {
|
|
73
87
|
oneOf: [
|
|
74
88
|
{ type: 'boolean' },
|
|
75
89
|
{ type: 'string' },
|
|
76
90
|
{ type: 'array', items: { type: 'string' } },
|
|
77
91
|
],
|
|
78
|
-
},
|
|
92
|
+
},
|
|
93
|
+
hideSchemaTitles: { type: 'boolean' },
|
|
94
|
+
jsonSamplesExpandLevel: { oneOf: [{ type: 'number' }, { type: 'string' }] },
|
|
95
|
+
schemasExpansionLevel: { oneOf: [{ type: 'number' }, { type: 'string' }] },
|
|
96
|
+
mockServer: {
|
|
79
97
|
type: 'object',
|
|
80
98
|
properties: {
|
|
81
99
|
url: { type: 'string' },
|
|
82
100
|
position: { type: 'string', enum: ['first', 'last', 'replace', 'off'] },
|
|
83
101
|
description: { type: 'string' },
|
|
84
102
|
},
|
|
85
|
-
},
|
|
103
|
+
},
|
|
104
|
+
maxDisplayedEnumValues: { type: 'number' },
|
|
105
|
+
schemaDefinitionsTagName: { type: 'string' },
|
|
106
|
+
layout: { type: 'string', enum: ['stacked', 'three-panel'] },
|
|
107
|
+
hideInfoMetadata: { type: 'boolean' },
|
|
108
|
+
events: { type: 'object' },
|
|
109
|
+
skipBundle: { type: 'boolean' },
|
|
110
|
+
routingBasePath: { type: 'string' },
|
|
111
|
+
codeSamples: codeSamplesConfigSchema,
|
|
112
|
+
ignoreNamedSchemas: {
|
|
86
113
|
oneOf: [{ type: 'array', items: { type: 'string' } }, { type: 'string' }],
|
|
87
|
-
},
|
|
114
|
+
},
|
|
115
|
+
hidePropertiesPrefix: { type: 'boolean' },
|
|
116
|
+
excludeFromSearch: { type: 'boolean' },
|
|
117
|
+
},
|
|
88
118
|
additionalProperties: false,
|
|
89
119
|
};
|
|
90
120
|
//# sourceMappingURL=redoc-config-schema.js.map
|
package/lib/redoc-types.d.ts
CHANGED
|
@@ -2,8 +2,7 @@ import type { ReactElement, ComponentType } from 'react';
|
|
|
2
2
|
import type { FromSchema } from 'json-schema-to-ts';
|
|
3
3
|
import type { Schema, ConfigFunction } from '@markdoc/markdoc/dist/src/types';
|
|
4
4
|
import type { redocConfigSchema } from './redoc-config-schema';
|
|
5
|
-
|
|
6
|
-
export type RedocConfigTypes = Omit<FromSchema<typeof redocConfigSchema>, keyof DeprecatedRefDocsConfig> & {
|
|
5
|
+
export type RedocConfigTypes = FromSchema<typeof redocConfigSchema> & {
|
|
7
6
|
markdocOptions?: {
|
|
8
7
|
tags: Record<string, Schema>;
|
|
9
8
|
nodes: Record<string, Schema>;
|
|
@@ -16,6 +15,7 @@ export type RedocConfigTypes = Omit<FromSchema<typeof redocConfigSchema>, keyof
|
|
|
16
15
|
unstable_hooks?: HooksConfig;
|
|
17
16
|
requestInterceptor?: ((req: Request, operation: OperationModel) => void) | undefined | null;
|
|
18
17
|
unstable_externalCodeSamples?: Unstable_ExternalCodeSample[];
|
|
18
|
+
unstable_skipSamples?: boolean;
|
|
19
19
|
scrollYOffset?: number | string | (() => number);
|
|
20
20
|
};
|
|
21
21
|
type HooksConfig = {
|