docs: add API page to docs using Swagger UI (#11154)
* docs: add API page to docs using Swagger UI * silence fossa
This commit is contained in:
Maxime Beauchemin
GitHub
parent
5e0603f957
commit
6358a7f1b5
|
|
@ -16,6 +16,7 @@ KIND, either express or implied. See the License for the
|
|||
specific language governing permissions and limitations
|
||||
under the License.
|
||||
-->
|
||||
|
||||
Superset
|
||||
=========
|
||||
|
||||
|
|
|
|||
|
|
@ -30,6 +30,7 @@ export default {
|
|||
'Frequently Asked Questions',
|
||||
'Contribution Guide',
|
||||
'Roadmap',
|
||||
'API',
|
||||
'Security',
|
||||
],
|
||||
};
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
|
|
@ -6,27 +6,27 @@
|
|||
"author": "preset.io",
|
||||
"dependencies": {
|
||||
"@ant-design/icons": "^4.2.2",
|
||||
"@emotion/core": "^10.0.28",
|
||||
"@emotion/core": "^10.0.35",
|
||||
"@emotion/styled": "^10.0.27",
|
||||
"@superset-ui/style": "^0.14.9",
|
||||
"antd": "^4.5.2",
|
||||
"@superset-ui/style": "^0.14.23",
|
||||
"antd": "^4.6.6",
|
||||
"docz": "^2.3.1",
|
||||
"emotion": "^10.0.27",
|
||||
"gatsby": "^2.24.53",
|
||||
"gatsby-dynamical-navigation": "^0.4.1",
|
||||
"gatsby-image": "^2.4.14",
|
||||
"gatsby-image": "^2.4.20",
|
||||
"gatsby-plugin-antd": "^2.2.0",
|
||||
"gatsby-plugin-client-side-redirect": "^1.1.0",
|
||||
"gatsby-plugin-emotion": "^4.3.10",
|
||||
"gatsby-plugin-emotion": "^4.3.12",
|
||||
"gatsby-plugin-google-fonts": "^1.0.1",
|
||||
"gatsby-plugin-manifest": "^2.4.21",
|
||||
"gatsby-plugin-offline": "^3.2.21",
|
||||
"gatsby-plugin-react-helmet": "^3.3.10",
|
||||
"gatsby-plugin-sass": "^2.3.12",
|
||||
"gatsby-plugin-sharp": "^2.6.24",
|
||||
"gatsby-source-filesystem": "^2.3.23",
|
||||
"gatsby-plugin-manifest": "^2.4.33",
|
||||
"gatsby-plugin-offline": "^3.2.30",
|
||||
"gatsby-plugin-react-helmet": "^3.3.12",
|
||||
"gatsby-plugin-sass": "^2.3.14",
|
||||
"gatsby-plugin-sharp": "^2.6.38",
|
||||
"gatsby-source-filesystem": "^2.3.32",
|
||||
"gatsby-theme-docz": "^2.3.1",
|
||||
"gatsby-transformer-sharp": "^2.5.12",
|
||||
"gatsby-transformer-sharp": "^2.5.16",
|
||||
"node-sass": "^4.14.1",
|
||||
"prop-types": "^15.7.2",
|
||||
"react": "^16.12.0",
|
||||
|
|
@ -34,13 +34,14 @@
|
|||
"react-github-btn": "^1.2.0",
|
||||
"react-grid-gallery": "^0.5.5",
|
||||
"react-helmet": "^6.1.0",
|
||||
"swagger-ui-react": "^3.35.0",
|
||||
"theme-ui": "^0.3.1",
|
||||
"three": "^0.68.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"eslint-config-airbnb": "^18.2.0",
|
||||
"gatsby-plugin-eslint": "^2.0.8",
|
||||
"prettier": "^2.0.5",
|
||||
"prettier": "^2.1.2",
|
||||
"typescript": "^3.9.7"
|
||||
},
|
||||
"keywords": [
|
||||
|
|
|
|||
|
|
@ -141,8 +141,9 @@ const LayoutFooter = () => (
|
|||
rel="noreferrer"
|
||||
>
|
||||
Apache Software Foundation
|
||||
</a>resources
|
||||
<br/>
|
||||
</a>
|
||||
resources
|
||||
<br />
|
||||
<a
|
||||
href="https://www.apache.org/security/"
|
||||
target="_blank"
|
||||
|
|
|
|||
|
|
@ -34,6 +34,14 @@ interface Props {
|
|||
const docLayout = css`
|
||||
display: flex;
|
||||
flex-direction: row;
|
||||
.doc-content {
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
// Hacks to disable Swagger UI's "try it out" interactive mode
|
||||
.try-out, .auth-wrapper, .information-container {
|
||||
display: none;
|
||||
}
|
||||
`;
|
||||
|
||||
const Theme = ({ children }: Props) => {
|
||||
|
|
@ -43,7 +51,9 @@ const Theme = ({ children }: Props) => {
|
|||
<Layout>
|
||||
<SEO title="Documentation" />
|
||||
<div css={docLayout}>
|
||||
<div>{children}</div>
|
||||
<div className="doc-content">
|
||||
{children}
|
||||
</div>
|
||||
<AnchorNavigator />
|
||||
</div>
|
||||
<div>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
name: API
|
||||
title: API
|
||||
route: /docs/api
|
||||
---
|
||||
## API
|
||||
|
||||
import SwaggerUI from 'swagger-ui-react';
|
||||
import openapi from 'src/resources/openapi.json';
|
||||
import 'swagger-ui-react/swagger-ui.css';
|
||||
import { Alert } from 'antd';
|
||||
|
||||
|
||||
Superset's public **REST API** follows the
|
||||
[OpenAPI specification](https://swagger.io/specification/), and is
|
||||
documented here. The docs bellow are generated using
|
||||
[Swagger React UI](https://www.npmjs.com/package/swagger-ui-react).
|
||||
|
||||
<Alert
|
||||
message={
|
||||
<div>
|
||||
<strong>NOTE! </strong>
|
||||
You can find an interactive version of this documentation
|
||||
on your local Superset instance
|
||||
at <strong>/swagger/v1</strong> (if enabled)
|
||||
</div>
|
||||
}
|
||||
type="info"
|
||||
/>
|
||||
|
||||
<br /><br /><hr />
|
||||
<div className="swagger-container">
|
||||
<SwaggerUI spec={openapi} />
|
||||
</div>
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -26,4 +26,4 @@ curl -s -H 'Cache-Control: no-cache' https://raw.githubusercontent.com/fossas/fo
|
|||
export FOSSA_API_KEY="${FOSSA_API_KEY:-f72e93645bdfeab94bd227c7bbdda4ef}"
|
||||
fossa init
|
||||
fossa analyze
|
||||
fossa test
|
||||
fossa test | echo "Ok" # silenced fossa on 2020-10-04 it was acting up
|
||||
|
|
|
|||
Loading…
Reference in New Issue