feat(info): indicate OpenAPI 2.0 definition version (#9167)

This commit is contained in:
Krzysztof Kowalczyk
2023-08-31 13:09:48 +02:00
committed by GitHub
parent 6fd6e339cc
commit 4b48e36c09
11 changed files with 45 additions and 47 deletions

View File

@@ -1,15 +1,15 @@
import Markdown from "./markdown"
import AuthItem from "./auth-item"
import VersionStamp from "./version-stamp"
import OnlineValidatorBadge from "./online-validator-badge"
import Model from "./model"
import JsonSchema_string from "./json-schema-string"
import OpenAPIVersion from "./openapi-version"
export default {
Markdown,
AuthItem,
OpenAPIVersion,
JsonSchema_string,
VersionStamp,
model: Model,
onlineValidatorBadge: OnlineValidatorBadge,
}

View File

@@ -0,0 +1,7 @@
import React from "react"
import { OAS30ComponentWrapFactory } from "../helpers"
export default OAS30ComponentWrapFactory((props) => {
const { Ori } = props
return <Ori oasVersion="3.0" />
})

View File

@@ -1,19 +0,0 @@
/**
* @prettier
*/
import React from "react"
import { OAS30ComponentWrapFactory } from "../helpers"
export default OAS30ComponentWrapFactory((props) => {
const { Ori } = props
return (
<span>
<Ori {...props} />
<small className="version-stamp">
<pre className="version">OAS 3.0</pre>
</small>
</span>
)
})

View File

@@ -23,6 +23,7 @@ const Info = ({ getComponent, specSelectors }) => {
const Markdown = getComponent("Markdown", true)
const Link = getComponent("Link")
const VersionStamp = getComponent("VersionStamp")
const OpenAPIVersion = getComponent("OpenAPIVersion")
const InfoUrl = getComponent("InfoUrl")
const InfoBasePath = getComponent("InfoBasePath")
const License = getComponent("License", true)
@@ -34,7 +35,8 @@ const Info = ({ getComponent, specSelectors }) => {
<hgroup className="main">
<h2 className="title">
{title}
{version && <VersionStamp version={version}></VersionStamp>}
{version && <VersionStamp version={version} />}
<OpenAPIVersion oasVersion="3.1" />
</h2>
{(host || basePath) && <InfoBasePath host={host} basePath={basePath} />}

View File

@@ -15,7 +15,6 @@ import InfoWrapper from "./wrap-components/info"
import ModelWrapper from "./wrap-components/model"
import ModelsWrapper from "./wrap-components/models"
import VersionPragmaFilterWrapper from "./wrap-components/version-pragma-filter"
import VersionStampWrapper from "./wrap-components/version-stamp"
import {
isOAS31 as isOAS31Fn,
createOnlyOAS31Selector as createOnlyOAS31SelectorFn,
@@ -91,7 +90,6 @@ const OAS31Plugin = ({ fn }) => {
License: LicenseWrapper,
Contact: ContactWrapper,
VersionPragmaFilter: VersionPragmaFilterWrapper,
VersionStamp: VersionStampWrapper,
Model: ModelWrapper,
Models: ModelsWrapper,
JSONSchema202012KeywordDescription:

View File

@@ -1,19 +0,0 @@
/**
* @prettier
*/
import React from "react"
import { createOnlyOAS31ComponentWrapper } from "../fn"
const VersionStampWrapper = createOnlyOAS31ComponentWrapper(
({ originalComponent: Original, ...restProps }) => (
<span>
<Original {...restProps} />
<small className="version-stamp">
<pre className="version">OAS 3.1</pre>
</small>
</span>
)
)
export default VersionStampWrapper