Skip to content

Commit 113996f

Browse files
authored
feat(json-schema): expose API that generates examples from JSON Schema (#9190)
This allows to use the samples API in a static way without fully instantiating SwaggerUI. Refs #9188
1 parent edd1153 commit 113996f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

83 files changed

+292
-88
lines changed

flavors/swagger-ui-react/index.jsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,7 @@ SwaggerUI.defaultProps = {
169169
oauth2RedirectUrl: undefined,
170170
}
171171

172+
SwaggerUI.System = SwaggerUIConstructor.System
172173
SwaggerUI.presets = SwaggerUIConstructor.presets
173174
SwaggerUI.plugins = SwaggerUIConstructor.plugins
174175

src/core/index.js

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,14 @@ import ErrPlugin from "./plugins/err"
1212
import FilterPlugin from "./plugins/filter"
1313
import IconsPlugin from "./plugins/icons"
1414
import JSONSchema202012Plugin from "./plugins/json-schema-2020-12"
15+
import JSONSchema202012SamplesPlugin from "./plugins/json-schema-2020-12-samples"
1516
import LayoutPlugin from "./plugins/layout"
1617
import LogsPlugin from "./plugins/logs"
1718
import OpenAPI30Plugin from "./plugins/oas3"
1819
import OpenAPI31Plugin from "./plugins/oas3"
1920
import OnCompletePlugin from "./plugins/on-complete"
2021
import RequestSnippetsPlugin from "./plugins/request-snippets"
21-
import SamplesPlugin from "./plugins/samples"
22+
import JSONSchema5SamplesPlugin from "./plugins/json-schema-5-samples"
2223
import SpecPlugin from "./plugins/spec"
2324
import SwaggerClientPlugin from "./plugins/swagger-client"
2425
import UtilPlugin from "./plugins/util"
@@ -239,6 +240,8 @@ export default function SwaggerUI(opts) {
239240
return system
240241
}
241242

243+
SwaggerUI.System = System
244+
242245
SwaggerUI.presets = {
243246
base: BasePreset,
244247
apis: ApisPreset,
@@ -251,14 +254,15 @@ SwaggerUI.plugins = {
251254
Err: ErrPlugin,
252255
Filter: FilterPlugin,
253256
Icons: IconsPlugin,
257+
JSONSchema5Samples: JSONSchema5SamplesPlugin,
254258
JSONSchema202012: JSONSchema202012Plugin,
259+
JSONSchema202012Samples: JSONSchema202012SamplesPlugin,
255260
Layout: LayoutPlugin,
256261
Logs: LogsPlugin,
257262
OpenAPI30: OpenAPI30Plugin,
258263
OpenAPI31: OpenAPI31Plugin,
259264
OnComplete: OnCompletePlugin,
260265
RequestSnippets: RequestSnippetsPlugin,
261-
Samples: SamplesPlugin,
262266
Spec: SpecPlugin,
263267
SwaggerClient: SwaggerClientPlugin,
264268
Util: UtilPlugin,

src/core/plugins/json-schema-2020-12/samples-extensions/fn/api/encoderAPI.js renamed to src/core/plugins/json-schema-2020-12-samples/fn/api/encoderAPI.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* @prettier
33
*/
44

5-
import EncoderRegistry from "core/plugins/json-schema-2020-12/samples-extensions/fn/class/EncoderRegistry"
5+
import EncoderRegistry from "../class/EncoderRegistry"
66

77
const registry = new EncoderRegistry()
88

0 commit comments

Comments
 (0)