diff --git a/src/core/plugins/json-schema-2020-12/index.js b/src/core/plugins/json-schema-2020-12/index.js
index 983eacc1..4bef023d 100644
--- a/src/core/plugins/json-schema-2020-12/index.js
+++ b/src/core/plugins/json-schema-2020-12/index.js
@@ -43,7 +43,8 @@ import KeywordWriteOnly from "./components/keywords/WriteOnly/WriteOnly"
import Accordion from "./components/Accordion/Accordion"
import ExpandDeepButton from "./components/ExpandDeepButton/ExpandDeepButton"
import ChevronRightIcon from "./components/icons/ChevronRight"
-import { upperFirst } from "./fn"
+import { upperFirst, hasKeyword, isExpandable } from "./fn"
+import { useFn } from "./hooks"
import { withJSONSchemaContext } from "./hoc"
const JSONSchema202012Plugin = () => ({
@@ -94,6 +95,11 @@ const JSONSchema202012Plugin = () => ({
},
fn: {
upperFirst,
+ jsonSchema202012: {
+ isExpandable,
+ hasKeyword,
+ useFn,
+ },
},
})
diff --git a/src/core/plugins/oas31/index.js b/src/core/plugins/oas31/index.js
index 006380d7..b98610c1 100644
--- a/src/core/plugins/oas31/index.js
+++ b/src/core/plugins/oas31/index.js
@@ -14,7 +14,11 @@ import InfoWrapper from "./wrap-components/info"
import ModelsWrapper from "./wrap-components/models"
import VersionPragmaFilterWrapper from "./wrap-components/version-pragma-filter"
import VersionStampWrapper from "./wrap-components/version-stamp"
-import JSONSchema202012KeywordDescriptionWrapper from "./json-schema-2020-12-extensions/wrap-components/keywords/Description"
+import {
+ isOAS31 as isOAS31Fn,
+ createOnlyOAS31Selector as createOnlyOAS31SelectorFn,
+ createSystemSelector as createSystemSelectorFn,
+} from "./fn"
import {
license as selectLicense,
contact as selectContact,
@@ -46,22 +50,31 @@ import {
selectLicenseUrl as selectLicenseUrlWrapper,
} from "./spec-extensions/wrap-selectors"
import { selectLicenseUrl as selectOAS31LicenseUrl } from "./selectors"
-import {
- isOAS31 as isOAS31Fn,
- createOnlyOAS31Selector as createOnlyOAS31SelectorFn,
- createSystemSelector as createSystemSelectorFn,
-} from "./fn"
+import JSONSchema202012KeywordExample from "./json-schema-2020-12-extensions/components/keywords/Example"
+import JSONSchema202012KeywordDescriptionWrapper from "./json-schema-2020-12-extensions/wrap-components/keywords/Description"
+import JSONSchema202012KeywordDefaultWrapper from "./json-schema-2020-12-extensions/wrap-components/keywords/Default"
+import { makeIsExpandable } from "./json-schema-2020-12-extensions/fn"
-const OAS31Plugin = ({ fn }) => {
+const OAS31Plugin = ({ getSystem }) => {
+ const system = getSystem()
+ const { fn } = system
const createSystemSelector = fn.createSystemSelector || createSystemSelectorFn
const createOnlyOAS31Selector = fn.createOnlyOAS31Selector || createOnlyOAS31SelectorFn // prettier-ignore
+ const pluginFn = {
+ isOAs31: isOAS31Fn,
+ createSystemSelector: createSystemSelectorFn,
+ createOnlyOAS31Selector: createOnlyOAS31SelectorFn,
+ }
+ if (typeof fn.jsonSchema202012?.isExpandable === "function") {
+ pluginFn.jsonSchema202012 = {
+ ...fn.jsonSchema202012,
+ isExpandable: makeIsExpandable(fn.jsonSchema202012.isExpandable, system),
+ }
+ }
+
return {
- fn: {
- isOAs31: isOAS31Fn,
- createSystemSelector: createSystemSelectorFn,
- createOnlyOAS31Selector: createOnlyOAS31SelectorFn,
- },
+ fn: pluginFn,
components: {
Webhooks,
JsonSchemaDialect,
@@ -70,6 +83,7 @@ const OAS31Plugin = ({ fn }) => {
OAS31Contact: Contact,
OAS31VersionPragmaFilter: VersionPragmaFilter,
OAS31Models: Models,
+ JSONSchema202012KeywordExample,
},
wrapComponents: {
InfoContainer: InfoWrapper,
@@ -80,6 +94,7 @@ const OAS31Plugin = ({ fn }) => {
Models: ModelsWrapper,
JSONSchema202012KeywordDescription:
JSONSchema202012KeywordDescriptionWrapper,
+ JSONSchema202012KeywordDefault: JSONSchema202012KeywordDefaultWrapper,
},
statePlugins: {
spec: {
diff --git a/src/core/plugins/oas31/json-schema-2020-12-extensions/components/keywords/Description.jsx b/src/core/plugins/oas31/json-schema-2020-12-extensions/components/keywords/Description.jsx
new file mode 100644
index 00000000..bc00d269
--- /dev/null
+++ b/src/core/plugins/oas31/json-schema-2020-12-extensions/components/keywords/Description.jsx
@@ -0,0 +1,27 @@
+/**
+ * @prettier
+ */
+import React from "react"
+import PropTypes from "prop-types"
+
+const Description = ({ schema, getSystem }) => {
+ if (!schema?.description) return null
+
+ const { getComponent } = getSystem()
+ const MarkDown = getComponent("Markdown")
+
+ return (
+
+ )
+}
+
+Description.propTypes = {
+ schema: PropTypes.oneOfType([PropTypes.object, PropTypes.bool]),
+ getSystem: PropTypes.func.isRequired,
+}
+
+export default Description
diff --git a/src/core/plugins/oas31/json-schema-2020-12-extensions/components/keywords/Example.jsx b/src/core/plugins/oas31/json-schema-2020-12-extensions/components/keywords/Example.jsx
new file mode 100644
index 00000000..bb5ff8c5
--- /dev/null
+++ b/src/core/plugins/oas31/json-schema-2020-12-extensions/components/keywords/Example.jsx
@@ -0,0 +1,33 @@
+/**
+ * @prettier
+ */
+import React from "react"
+import PropTypes from "prop-types"
+
+const Example = ({ schema, fn }) => {
+ const { hasKeyword, stringify } = fn.jsonSchema202012.useFn()
+
+ if (!hasKeyword(schema, "example")) return null
+
+ return (
+
+
+ Example
+
+
+ {stringify(schema.example)}
+
+
+ )
+}
+
+Example.propTypes = {
+ schema: PropTypes.oneOfType([PropTypes.object, PropTypes.bool]),
+ fn: PropTypes.shape({
+ jsonSchema202012: PropTypes.shape({
+ useFn: PropTypes.func.isRequired,
+ }).isRequired,
+ }).isRequired,
+}
+
+export default Example
diff --git a/src/core/plugins/oas31/json-schema-2020-12-extensions/fn.js b/src/core/plugins/oas31/json-schema-2020-12-extensions/fn.js
new file mode 100644
index 00000000..a86fdfd3
--- /dev/null
+++ b/src/core/plugins/oas31/json-schema-2020-12-extensions/fn.js
@@ -0,0 +1,12 @@
+/**
+ * @prettier
+ */
+export const makeIsExpandable = (original, { fn }) => {
+ if (typeof original !== "function") {
+ return null
+ }
+
+ const { hasKeyword } = fn.jsonSchema202012
+
+ return (schema) => original(schema) || hasKeyword(schema, "example")
+}
diff --git a/src/core/plugins/oas31/json-schema-2020-12-extensions/wrap-components/keywords/Default.jsx b/src/core/plugins/oas31/json-schema-2020-12-extensions/wrap-components/keywords/Default.jsx
new file mode 100644
index 00000000..bd3e3a23
--- /dev/null
+++ b/src/core/plugins/oas31/json-schema-2020-12-extensions/wrap-components/keywords/Default.jsx
@@ -0,0 +1,21 @@
+/**
+ * @prettier
+ */
+import React from "react"
+import { createOnlyOAS31ComponentWrapper } from "../../../fn"
+
+const DefaultWrapper = createOnlyOAS31ComponentWrapper(
+ ({ schema, getSystem, originalComponent: KeywordDefault }) => {
+ const { getComponent, fn } = getSystem()
+ const KeywordExample = getComponent("JSONSchema202012KeywordExample")
+
+ return (
+ <>
+
+
+
+ )
+ }
+)
+
+export default DefaultWrapper
diff --git a/src/core/plugins/oas31/json-schema-2020-12-extensions/wrap-components/keywords/Description.jsx b/src/core/plugins/oas31/json-schema-2020-12-extensions/wrap-components/keywords/Description.jsx
index af50aab6..47902031 100644
--- a/src/core/plugins/oas31/json-schema-2020-12-extensions/wrap-components/keywords/Description.jsx
+++ b/src/core/plugins/oas31/json-schema-2020-12-extensions/wrap-components/keywords/Description.jsx
@@ -1,23 +1,9 @@
/**
* @prettier
*/
-import React from "react"
+import DescriptionKeyword from "../../components/keywords/Description"
import { createOnlyOAS31ComponentWrapper } from "../../../fn"
-const DescriptionWrapper = createOnlyOAS31ComponentWrapper(
- ({ schema, getComponent }) => {
- if (!schema?.description) return null
-
- const MarkDown = getComponent("Markdown")
-
- return (
-
- )
- }
-)
+const DescriptionWrapper = createOnlyOAS31ComponentWrapper(DescriptionKeyword)
export default DescriptionWrapper
diff --git a/src/core/plugins/oas31/wrap-components/models.jsx b/src/core/plugins/oas31/wrap-components/models.jsx
index df318e80..7577b65d 100644
--- a/src/core/plugins/oas31/wrap-components/models.jsx
+++ b/src/core/plugins/oas31/wrap-components/models.jsx
@@ -4,9 +4,11 @@
import React from "react"
import { createOnlyOAS31ComponentWrapper } from "../fn"
+import { makeIsExpandable } from "../json-schema-2020-12-extensions/fn"
const ModelsWrapper = createOnlyOAS31ComponentWrapper(({ getSystem }) => {
- const { getComponent, fn, getConfigs } = getSystem()
+ const system = getSystem()
+ const { getComponent, fn, getConfigs } = system
const configs = getConfigs()
if (ModelsWrapper.ModelsWithJSONContext) {
@@ -66,10 +68,7 @@ const ModelsWrapper = createOnlyOAS31ComponentWrapper(({ getSystem }) => {
"JSONSchema202012KeywordContentSchema"
)
const KeywordTitle = getComponent("JSONSchema202012KeywordTitle")
- const KeywordDescription = getComponent(
- "JSONSchema202012KeywordDescription",
- true
- )
+ const KeywordDescription = getComponent("JSONSchema202012KeywordDescription")
const KeywordDefault = getComponent("JSONSchema202012KeywordDefault")
const KeywordDeprecated = getComponent("JSONSchema202012KeywordDeprecated")
const KeywordReadOnly = getComponent("JSONSchema202012KeywordReadOnly")
@@ -130,6 +129,7 @@ const ModelsWrapper = createOnlyOAS31ComponentWrapper(({ getSystem }) => {
},
fn: {
upperFirst: fn.upperFirst,
+ isExpandable: makeIsExpandable(fn.jsonSchema202012.isExpandable, system),
},
})