4557b2497b
- New top-level field - `webhooks`. This allows describing out-of-band webhooks that are available as part of the API. - New top-level field - `jsonSchemaDialect`. This allows defining of a default `$schema` value for Schema Objects - The Info Object has a new `summary` field. - The License Object now has a new `identifier` field for SPDX licenses. This `identifier` field is mutually exclusive with the `url` field. Either can be used in OpenAPI 3.1 definitions. - Components Object now has a new entry `pathItems`, to allow for reusable Path Item Objects to be defined within a valid OpenAPI document. - `License` and `Contact` components are now exported and available via `getComponent` - New version predicates and selectors for `isOpenAPI30` and `isOpenAPI31`. This avoids needing to change the usage of `isOAS3` selector. - New OAS3 components: `Webhooks` - New OAS3 wrapped components: `Info`, `License`
78 lines
3.0 KiB
JavaScript
78 lines
3.0 KiB
JavaScript
import React from "react"
|
|
import PropTypes from "prop-types"
|
|
import ImPropTypes from "react-immutable-proptypes"
|
|
import { sanitizeUrl } from "core/utils"
|
|
import { safeBuildUrl } from "core/utils/url"
|
|
import { OAS3ComponentWrapFactory } from "../helpers"
|
|
|
|
const Info = (props) => {
|
|
const { info, url, host, basePath, getComponent, specSelectors, externalDocs, selectedServer, url: specUrl } = props
|
|
const isOpenAPI31 = specSelectors.selectIsOpenAPI31()
|
|
const version = info.get("version")
|
|
const description = info.get("description")
|
|
const title = info.get("title")
|
|
const termsOfServiceUrl = safeBuildUrl(info.get("termsOfService"), specUrl, { selectedServer })
|
|
const contact = info.get("contact")
|
|
const license = info.get("license")
|
|
// note that ux may want to move summary to a sub-heading, as summary is a string that does not need to be Markdown
|
|
const summary = info.get("summary") // OAS3.1 field
|
|
const rawExternalDocsUrl = externalDocs && externalDocs.get("url")
|
|
const externalDocsUrl = safeBuildUrl(rawExternalDocsUrl, specUrl, { selectedServer })
|
|
const externalDocsDescription = externalDocs && externalDocs.get("description")
|
|
|
|
const Markdown = getComponent("Markdown", true)
|
|
const Link = getComponent("Link")
|
|
const VersionStamp = getComponent("VersionStamp")
|
|
const InfoUrl = getComponent("InfoUrl")
|
|
const InfoBasePath = getComponent("InfoBasePath")
|
|
const License = getComponent("License")
|
|
const Contact = getComponent("Contact")
|
|
|
|
return (
|
|
<div className="info">
|
|
<hgroup className="main">
|
|
<h2 className="title" >{title}
|
|
{version && <VersionStamp version={version}></VersionStamp>}
|
|
</h2>
|
|
{host || basePath ? <InfoBasePath host={host} basePath={basePath} /> : null}
|
|
{url && <InfoUrl getComponent={getComponent} url={url} />}
|
|
</hgroup>
|
|
|
|
{
|
|
isOpenAPI31 && summary && <div className="info__summary">
|
|
<Markdown source={summary} />
|
|
</div>
|
|
}
|
|
<div className="description">
|
|
<Markdown source={description} />
|
|
</div>
|
|
|
|
{
|
|
termsOfServiceUrl && <div className="info__tos">
|
|
<Link target="_blank" href={sanitizeUrl(termsOfServiceUrl)}>Terms of service</Link>
|
|
</div>
|
|
}
|
|
|
|
{contact && contact.size ? <Contact getComponent={getComponent} data={contact} selectedServer={selectedServer} url={url} /> : null}
|
|
{license && license.size ? <License getComponent={getComponent} license={license} selectedServer={selectedServer} url={url} /> : null}
|
|
{externalDocsUrl ?
|
|
<Link className="info__extdocs" target="_blank" href={sanitizeUrl(externalDocsUrl)}>{externalDocsDescription || externalDocsUrl}</Link>
|
|
: null}
|
|
|
|
</div>
|
|
)
|
|
}
|
|
|
|
Info.propTypes = {
|
|
info: PropTypes.object,
|
|
url: PropTypes.string,
|
|
host: PropTypes.string,
|
|
basePath: PropTypes.string,
|
|
externalDocs: ImPropTypes.map,
|
|
getComponent: PropTypes.func.isRequired,
|
|
specSelectors: PropTypes.object.isRequired,
|
|
oas3selectors: PropTypes.func,
|
|
selectedServer: PropTypes.string,
|
|
}
|
|
|
|
export default OAS3ComponentWrapFactory(Info) |