mirror of
https://github.com/Unleash/unleash.git
synced 2025-02-14 00:19:16 +01:00
2d04bd9ea2
## What This PR (finally 🎉) adds generated OpenAPI docs to the official Unleash documentation. In addition to generating docs when things get merged to main, it also pushes new doc updates every day at 12:00 AM (cron `@daily`). ## Why Now that we have OpenAPI'd all the things, we can finally start using it. This will allow us to remove hand-written api docs from the documentation and should make sure everything is always kept up to date. ### Generating from us-hosted (Unleash enterprise) Unleash has several different versions (open source, pro, enterprise). The versions do not necessarily have the exact same api surface. In fact, the enterprise version has a few endpoints that open source does not. Because we want to have _all_ endpoints listed in the documentation we need to generated the docs from an enterprise spec. Which brings us into the next point: ### The need for scheduled jobs Regarding the daily scheduled tasks to update the documentation: why do we need that? The docs are generated from the tip of the main branch. For most of the docs, this is good and something that we want. However, because the OpenAPI docs are generated from the enterprise edition, it _will not be in sync_ with the open source main branch. Also, we probably do not want the docs to list the current bleeding edge api changes. Instead, we should prefer to use the latest enterprise release (roughly). However, because we don't get notified when this version is released and deployed, we'll instead run the API generation on a daily cadence. This isn't the perfect solution, but it's simple and gets us 80% of the way there. More intricate solutions can be set up later. ## How - By adding a scheduled workflow to the generate docs config. - By adding .gitignore entries for the generated files There's also some minor changes in styling etc. ## Dependencies This is dependent on the changes introduced in #2062 having propagated to the enterprise release, which will probably not be for another week or so. ## Discussion What should the API reference docs url be? I've set it to be `/reference/api/unleash/*` for now, but I'm on the fence about whether it should be `apis` or `api` in there. I also want to get the proxy and other APIs in there as we grow. ------- ## Commits * docs: style openapi operation buttons * docs: minor operation badge adjustments * docs: use permalink to css snippet i copied * docs: ignore files related to openapi generation * docs: re-enable openapi docs * Docs(#1391): prep for integration * docs(#1391): run docs generation daily * docs(#1391): add generation step to doc prs too * docs(#1391): use the US hosted instance to generate docs * docs(#1391): move doc generation into build command * docs(#1391): use `/reference/api/*` instead of `/reference/apis/*`
243 lines
7.9 KiB
CSS
243 lines
7.9 KiB
CSS
/* stylelint-disable docusaurus/copyright-header */
|
|
/**
|
|
* Any CSS included here will be global. The classic template
|
|
* bundles Infima by default. Infima is a CSS framework designed to
|
|
* work well for content-centric websites.
|
|
*/
|
|
|
|
/* You can override the default Infima variables here. */
|
|
:root {
|
|
--unleash-color-purple: #635dc5;
|
|
--unleash-color-gray: #ecebeb;
|
|
|
|
--ifm-code-font-size: 90%;
|
|
--ifm-font-size-base: 15px;
|
|
--navbar-link-color: #122d33;
|
|
}
|
|
|
|
footer {
|
|
--ifm-footer-link-hover-color: var(--ifm-footer-link-color);
|
|
}
|
|
|
|
html[data-theme='light'] {
|
|
--ifm-color-primary-lightest: #8783d2;
|
|
--ifm-color-primary-lighter: #7b76ce;
|
|
--ifm-color-primary-light: #6f6ac9;
|
|
--ifm-color-primary: var(--unleash-color-purple);
|
|
--ifm-color-primary-dark: #5953be;
|
|
--ifm-color-primary-darker: #4f4ab7;
|
|
--ifm-color-primary-darkest: #4540b0;
|
|
|
|
--ifm-menu-color-background-active: var(--unleash-color-gray);
|
|
--ifm-menu-color-background-hover: var(--unleash-color-gray);
|
|
|
|
--unleash-color-admonition-background: var(--unleash-color-gray);
|
|
--unleash-color-admonition-border: #999;
|
|
--unleash-color-admonition-text: #2b2b2b;
|
|
|
|
--ifm-background-color: #fff;
|
|
}
|
|
|
|
html[data-theme='dark'] {
|
|
--ifm-color-primary-lightest: #d1d1ff;
|
|
--ifm-color-primary-lighter: #c9c9ff;
|
|
--ifm-color-primary-light: #c2c0ff;
|
|
--ifm-color-primary: #bab8ff;
|
|
--ifm-color-primary-dark: #a09de4;
|
|
--ifm-color-primary-darker: #8582c9;
|
|
--ifm-color-primary-darkest: #6b67ae;
|
|
|
|
--unleash-color-purple: var(--ifm-color-primary);
|
|
--unleash-color-gray: #333;
|
|
--ifm-menu-color-background-active: var(--unleash-color-gray);
|
|
--ifm-menu-color-background-hover: var(--unleash-color-gray);
|
|
|
|
--ifm-link-color: var(--ifm-color-primary);
|
|
|
|
--unleash-color-admonition-background: var(
|
|
--ifm-color-secondary-contrast-background
|
|
);
|
|
|
|
--unleash-img-background-color: #fff;
|
|
|
|
--docsearch-primary-color: var(--ifm-color-primary-darkest);
|
|
}
|
|
|
|
.visually-hidden {
|
|
border: 0;
|
|
clip: rect(0 0 0 0);
|
|
height: auto;
|
|
margin: 0;
|
|
overflow: hidden;
|
|
padding: 0;
|
|
position: absolute;
|
|
width: 1px;
|
|
white-space: nowrap;
|
|
}
|
|
|
|
main img {
|
|
background: var(--unleash-img-background-color);
|
|
display: block;
|
|
margin: auto;
|
|
border: var(--ifm-global-border-width) solid var(--unleash-color-gray);
|
|
border-radius: var(--ifm-global-radius);
|
|
box-shadow: var(--ifm-global-shadow-lw);
|
|
}
|
|
|
|
[class^='docTitle'] {
|
|
font-size: 2.5rem !important;
|
|
}
|
|
|
|
.navbar-sidebar__back {
|
|
/* hide the 'back to main menu' item in the narrow menu. */
|
|
display: none;
|
|
}
|
|
|
|
li.theme-doc-sidebar-item-category-level-1 > div::before {
|
|
width: 0.3em;
|
|
height: 100%;
|
|
content: ' ';
|
|
background-color: var(--unleash-color-purple);
|
|
border-radius: 2px;
|
|
position: absolute;
|
|
}
|
|
|
|
.docusaurus-highlight-code-line {
|
|
background-color: rgb(72, 77, 91);
|
|
display: block;
|
|
margin: 0 calc(-1 * var(--ifm-pre-padding));
|
|
padding: 0 var(--ifm-pre-padding);
|
|
}
|
|
|
|
.header-github-link:hover {
|
|
opacity: 0.6;
|
|
}
|
|
|
|
.header-github-link:before {
|
|
content: '';
|
|
width: 24px;
|
|
height: 24px;
|
|
display: flex;
|
|
background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E")
|
|
no-repeat;
|
|
}
|
|
|
|
html[data-theme='dark'] .header-github-link:before {
|
|
background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath fill='white' d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E")
|
|
no-repeat;
|
|
}
|
|
|
|
/* Video content container */
|
|
|
|
.unleash-video-container {
|
|
display: grid;
|
|
--gap: 0.5em;
|
|
--border-radius: var(--ifm-alert-border-radius);
|
|
gap: var(--gap);
|
|
margin-bottom: 1em;
|
|
}
|
|
|
|
.unleash-video-container > .videos {
|
|
display: grid;
|
|
grid-template-columns: repeat(auto-fit, minmax(120px, 1fr));
|
|
gap: var(--gap);
|
|
}
|
|
|
|
.unleash-video-container > .admonition {
|
|
box-shadow: none;
|
|
background-color: var(--unleash-color-admonition-background);
|
|
color: var(--unleash-color-admonition-text);
|
|
border-color: var(--unleash-color-admonition-border);
|
|
margin: 0;
|
|
}
|
|
|
|
.unleash-video-container iframe {
|
|
aspect-ratio: 16/9;
|
|
}
|
|
|
|
@media screen and (min-width: 450px) {
|
|
.unleash-video-container {
|
|
grid-template-columns: 1fr min(250px, 25%);
|
|
}
|
|
.unleash-video-container > .videos {
|
|
display: flex;
|
|
flex-direction: column;
|
|
gap: var(--gap);
|
|
}
|
|
}
|
|
|
|
/* end video content container */
|
|
|
|
/* docusaurus-plugin-openapi-docs styling
|
|
|
|
Taken from
|
|
https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/02922a6ad6d635373e01409dac8c17a88da2b72e/demo/src/css/custom.css#L45-L9
|
|
|
|
Based on this thread:
|
|
https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/issues/177
|
|
|
|
*/
|
|
|
|
/* Sidebar Method labels */
|
|
.api-method > .menu__link {
|
|
align-items: center;
|
|
justify-content: start;
|
|
}
|
|
|
|
.api-method > .menu__link::before {
|
|
width: 50px;
|
|
height: 20px;
|
|
font-size: 12px;
|
|
line-height: 20px;
|
|
text-transform: uppercase;
|
|
font-weight: 600;
|
|
border-radius: 0.25rem;
|
|
border: 1px solid;
|
|
border-inline-start-width: 5px;
|
|
margin-right: var(--ifm-spacing-horizontal);
|
|
text-align: center;
|
|
flex-shrink: 0;
|
|
}
|
|
|
|
.get > .menu__link::before {
|
|
content: 'get';
|
|
background-color: var(--ifm-color-info-contrast-background);
|
|
color: var(--ifm-color-info-contrast-foreground);
|
|
border-color: var(--ifm-color-info-dark);
|
|
}
|
|
|
|
.post > .menu__link::before {
|
|
content: 'post';
|
|
background-color: var(--ifm-color-success-contrast-background);
|
|
color: var(--ifm-color-success-contrast-foreground);
|
|
border-color: var(--ifm-color-success-dark);
|
|
}
|
|
|
|
.delete > .menu__link::before {
|
|
content: 'del';
|
|
background-color: var(--ifm-color-danger-contrast-background);
|
|
color: var(--ifm-color-danger-contrast-foreground);
|
|
border-color: var(--ifm-color-danger-dark);
|
|
}
|
|
|
|
.put > .menu__link::before {
|
|
content: 'put';
|
|
background-color: var(--ifm-color-warning-contrast-background);
|
|
color: var(--ifm-color-warning-contrast-foreground);
|
|
border-color: var(--ifm-color-warning-dark);
|
|
}
|
|
|
|
.patch > .menu__link::before {
|
|
content: 'patch';
|
|
background-color: var(--ifm-color-success-contrast-background);
|
|
color: var(--ifm-color-success-contrast-foreground);
|
|
border-color: var(--ifm-color-success-dark);
|
|
}
|
|
|
|
.head > .menu__link::before {
|
|
content: 'head';
|
|
background-color: var(--ifm-color-secondary-contrast-background);
|
|
color: var(--ifm-color-secondary-contrast-foreground);
|
|
border-color: var(--ifm-color-secondary-dark);
|
|
}
|