2021-04-15 13:22:37 +02:00
|
|
|
|
/** @type {import('@docusaurus/types').DocusaurusConfig} */
|
|
|
|
|
|
module.exports = {
|
2022-02-02 13:45:01 +01:00
|
|
|
|
title: "ZITADEL Docs",
|
2021-12-30 09:01:47 +01:00
|
|
|
|
trailingSlash: false,
|
2022-12-06 20:33:13 +01:00
|
|
|
|
url: "https://zitadel.com",
|
2023-02-23 12:08:06 +01:00
|
|
|
|
baseUrl: "/docs",
|
2024-06-20 14:55:03 +02:00
|
|
|
|
onBrokenLinks: "warn",
|
|
|
|
|
|
onBrokenAnchors: "warn",
|
|
|
|
|
|
onBrokenMarkdownLinks: "throw",
|
2022-02-02 13:45:01 +01:00
|
|
|
|
favicon: "img/favicon.ico",
|
2022-05-16 16:01:46 +02:00
|
|
|
|
organizationName: "zitadel",
|
2022-02-02 13:45:01 +01:00
|
|
|
|
projectName: "zitadel",
|
|
|
|
|
|
scripts: [
|
|
|
|
|
|
{
|
2022-12-06 20:33:13 +01:00
|
|
|
|
src: "/docs/proxy/js/script.js",
|
2022-02-02 13:45:01 +01:00
|
|
|
|
async: true,
|
|
|
|
|
|
defer: true,
|
2022-12-06 20:33:13 +01:00
|
|
|
|
"data-domain": "zitadel.com",
|
|
|
|
|
|
"data-api": "/docs/proxy/api/event",
|
2022-02-02 13:45:01 +01:00
|
|
|
|
},
|
|
|
|
|
|
],
|
2022-11-08 16:15:12 +01:00
|
|
|
|
customFields: {
|
2022-12-05 18:36:12 +01:00
|
|
|
|
description:
|
2023-09-01 11:46:20 +02:00
|
|
|
|
"Documentation for ZITADEL - Identity infrastructure, simplified for you.",
|
2022-11-08 16:15:12 +01:00
|
|
|
|
},
|
2021-04-15 13:22:37 +02:00
|
|
|
|
themeConfig: {
|
2022-12-05 18:36:12 +01:00
|
|
|
|
metadata: [
|
|
|
|
|
|
{
|
|
|
|
|
|
name: "keywords",
|
|
|
|
|
|
content:
|
|
|
|
|
|
"zitadel, documentation, jwt, saml, oauth2, authentication, serverless, login, auth, authorization, sso, openid-connect, oidc, mfa, 2fa, passkeys, fido2, docker",
|
|
|
|
|
|
},
|
2023-01-11 11:45:35 +01:00
|
|
|
|
{
|
|
|
|
|
|
property: "og:type",
|
|
|
|
|
|
content: "website",
|
|
|
|
|
|
},
|
|
|
|
|
|
{ property: "og:url", content: "https://www.zitadel.com/docs" },
|
|
|
|
|
|
{
|
|
|
|
|
|
property: "og:image",
|
2023-02-17 11:48:37 +01:00
|
|
|
|
content: "https://www.zitadel.com/docs/img/preview.png",
|
2023-01-11 11:45:35 +01:00
|
|
|
|
},
|
|
|
|
|
|
{ property: "twitter:card", content: "summary_large_image" },
|
|
|
|
|
|
{ property: "twitter:url", content: "https://www.zitadel.com/docs" },
|
|
|
|
|
|
{ property: "twitter:title", content: "ZITADEL Docs" },
|
|
|
|
|
|
{
|
|
|
|
|
|
property: "twitter:image",
|
2023-02-17 11:48:37 +01:00
|
|
|
|
content: "https://www.zitadel.com/docs/img/preview.png",
|
2023-01-11 11:45:35 +01:00
|
|
|
|
},
|
2022-12-05 18:36:12 +01:00
|
|
|
|
],
|
2022-07-14 11:52:04 +02:00
|
|
|
|
zoom: {
|
2022-10-31 08:00:22 +01:00
|
|
|
|
selector: ".markdown :not(em) > img",
|
2022-07-14 11:52:04 +02:00
|
|
|
|
background: {
|
2022-10-31 08:00:22 +01:00
|
|
|
|
light: "rgb(243, 244, 246)",
|
|
|
|
|
|
dark: "rgb(55, 59, 82)",
|
2022-07-14 11:52:04 +02:00
|
|
|
|
},
|
|
|
|
|
|
// options you can specify via https://github.com/francoischalifour/medium-zoom#usage
|
2022-10-31 08:00:22 +01:00
|
|
|
|
config: {},
|
2022-07-14 11:52:04 +02:00
|
|
|
|
},
|
2021-04-15 13:22:37 +02:00
|
|
|
|
navbar: {
|
2021-10-13 10:06:12 +02:00
|
|
|
|
// title: 'ZITADEL',
|
2021-04-15 13:22:37 +02:00
|
|
|
|
logo: {
|
2022-02-02 13:45:01 +01:00
|
|
|
|
alt: "ZITADEL logo",
|
|
|
|
|
|
src: "img/zitadel-logo-dark.svg",
|
|
|
|
|
|
srcDark: "img/zitadel-logo-light.svg",
|
2024-02-06 16:52:45 +02:00
|
|
|
|
href: "https://zitadel.com",
|
|
|
|
|
|
target: "_blank",
|
2021-04-15 13:22:37 +02:00
|
|
|
|
},
|
|
|
|
|
|
items: [
|
|
|
|
|
|
{
|
2022-02-02 13:45:01 +01:00
|
|
|
|
type: "doc",
|
2024-03-06 20:31:49 +02:00
|
|
|
|
label: "🚀 Quick Start",
|
|
|
|
|
|
docId: "guides/start/quickstart",
|
|
|
|
|
|
position: "left",
|
2025-06-27 13:46:21 -07:00
|
|
|
|
},
|
2024-03-06 20:31:49 +02:00
|
|
|
|
{
|
|
|
|
|
|
type: "doc",
|
2023-03-07 09:33:13 +02:00
|
|
|
|
label: "Documentation",
|
2022-02-02 13:45:01 +01:00
|
|
|
|
docId: "guides/overview",
|
|
|
|
|
|
position: "left",
|
2025-06-27 13:46:21 -07:00
|
|
|
|
},
|
2021-04-15 13:22:37 +02:00
|
|
|
|
{
|
2022-02-02 13:45:01 +01:00
|
|
|
|
type: "doc",
|
|
|
|
|
|
label: "APIs",
|
|
|
|
|
|
docId: "apis/introduction",
|
|
|
|
|
|
position: "left",
|
2021-04-15 13:22:37 +02:00
|
|
|
|
},
|
2022-12-20 11:17:27 +01:00
|
|
|
|
{
|
|
|
|
|
|
type: "doc",
|
|
|
|
|
|
label: "Self-Hosting",
|
|
|
|
|
|
docId: "self-hosting/deploy/overview",
|
|
|
|
|
|
position: "left",
|
|
|
|
|
|
},
|
2021-06-15 11:18:41 +02:00
|
|
|
|
{
|
2022-02-02 13:45:01 +01:00
|
|
|
|
type: "doc",
|
2023-05-12 10:51:17 +02:00
|
|
|
|
docId: "legal",
|
2022-02-02 13:45:01 +01:00
|
|
|
|
label: "Legal",
|
2023-03-07 09:33:13 +02:00
|
|
|
|
position: "right",
|
2021-06-15 11:18:41 +02:00
|
|
|
|
},
|
2021-04-15 13:22:37 +02:00
|
|
|
|
{
|
2022-12-05 18:36:12 +01:00
|
|
|
|
type: "html",
|
2022-02-02 13:45:01 +01:00
|
|
|
|
position: "right",
|
2022-12-05 18:36:12 +01:00
|
|
|
|
value:
|
|
|
|
|
|
'<a href="https://github.com/zitadel/zitadel/discussions" style="text-decoration: none; width: 20px; height: 24px; display: flex"><i class="las la-comments"></i></a>',
|
2021-04-15 13:22:37 +02:00
|
|
|
|
},
|
2022-07-18 17:16:45 +02:00
|
|
|
|
{
|
2022-12-05 18:36:12 +01:00
|
|
|
|
type: "html",
|
2022-07-18 17:16:45 +02:00
|
|
|
|
position: "right",
|
2022-12-05 18:36:12 +01:00
|
|
|
|
value:
|
|
|
|
|
|
'<a href="https://github.com/zitadel/zitadel" style="text-decoration: none; width: 20px; height: 24px; display: flex"><i class="lab la-github"></i></a>',
|
2022-07-18 17:16:45 +02:00
|
|
|
|
},
|
|
|
|
|
|
{
|
2022-12-05 18:36:12 +01:00
|
|
|
|
type: "html",
|
2022-07-18 17:16:45 +02:00
|
|
|
|
position: "right",
|
2022-12-05 18:36:12 +01:00
|
|
|
|
value:
|
|
|
|
|
|
'<a href="https://zitadel.com/chat" style="text-decoration: none; width: 20px; height: 24px; display: flex; margin: 0 .5rem 0 0"><i class="lab la-discord"></i></a>',
|
2022-07-18 17:16:45 +02:00
|
|
|
|
},
|
2021-04-15 13:22:37 +02:00
|
|
|
|
],
|
|
|
|
|
|
},
|
|
|
|
|
|
footer: {
|
|
|
|
|
|
links: [
|
|
|
|
|
|
{
|
2022-02-02 13:45:01 +01:00
|
|
|
|
title: "Community",
|
2021-04-15 13:22:37 +02:00
|
|
|
|
items: [
|
2022-05-23 22:53:43 +02:00
|
|
|
|
{
|
|
|
|
|
|
label: "Chat",
|
|
|
|
|
|
href: "https://zitadel.com/chat",
|
|
|
|
|
|
},
|
2021-04-15 13:22:37 +02:00
|
|
|
|
{
|
2022-02-02 13:45:01 +01:00
|
|
|
|
label: "GitHub Discussions",
|
2022-04-27 01:01:45 +02:00
|
|
|
|
href: "https://github.com/zitadel/zitadel/discussions",
|
2021-04-15 13:22:37 +02:00
|
|
|
|
},
|
|
|
|
|
|
{
|
2022-02-02 13:45:01 +01:00
|
|
|
|
label: "Twitter",
|
2022-05-16 16:01:46 +02:00
|
|
|
|
href: "https://twitter.com/zitadel",
|
2021-04-15 13:22:37 +02:00
|
|
|
|
},
|
|
|
|
|
|
{
|
2022-02-02 13:45:01 +01:00
|
|
|
|
label: "Linkedin",
|
2022-05-16 16:01:46 +02:00
|
|
|
|
href: "https://www.linkedin.com/company/zitadel/",
|
2021-04-15 13:22:37 +02:00
|
|
|
|
},
|
|
|
|
|
|
{
|
2022-02-02 13:45:01 +01:00
|
|
|
|
label: "Blog",
|
2022-05-16 16:01:46 +02:00
|
|
|
|
href: "https://zitadel.com/blog",
|
2021-04-15 13:22:37 +02:00
|
|
|
|
},
|
|
|
|
|
|
],
|
|
|
|
|
|
},
|
|
|
|
|
|
{
|
2022-05-23 22:53:43 +02:00
|
|
|
|
title: "Legal",
|
2021-04-15 13:22:37 +02:00
|
|
|
|
items: [
|
2022-05-23 22:53:43 +02:00
|
|
|
|
{
|
|
|
|
|
|
label: "Terms and Conditions",
|
2022-12-06 20:33:13 +01:00
|
|
|
|
href: "/legal/terms-of-service",
|
2022-05-23 22:53:43 +02:00
|
|
|
|
},
|
2021-04-15 13:22:37 +02:00
|
|
|
|
{
|
2022-05-23 22:53:43 +02:00
|
|
|
|
label: "Privacy Policy",
|
2023-11-16 11:26:25 +02:00
|
|
|
|
href: "/legal/policies/privacy-policy",
|
2022-05-23 22:53:43 +02:00
|
|
|
|
},
|
|
|
|
|
|
],
|
|
|
|
|
|
},
|
|
|
|
|
|
{
|
|
|
|
|
|
title: "About",
|
|
|
|
|
|
items: [
|
|
|
|
|
|
{
|
|
|
|
|
|
label: "Website",
|
|
|
|
|
|
href: "https://zitadel.com",
|
2021-04-15 13:22:37 +02:00
|
|
|
|
},
|
|
|
|
|
|
{
|
2022-02-02 13:45:01 +01:00
|
|
|
|
label: "Contact",
|
2022-05-16 16:01:46 +02:00
|
|
|
|
href: "https://zitadel.com/contact/",
|
2021-04-15 13:22:37 +02:00
|
|
|
|
},
|
|
|
|
|
|
{
|
2022-02-02 13:45:01 +01:00
|
|
|
|
label: "GitHub",
|
2022-05-16 16:01:46 +02:00
|
|
|
|
href: "https://github.com/zitadel",
|
2021-04-15 13:22:37 +02:00
|
|
|
|
},
|
|
|
|
|
|
{
|
2022-02-02 13:45:01 +01:00
|
|
|
|
label: "Status",
|
2022-08-02 20:21:57 +02:00
|
|
|
|
href: "https://status.zitadel.com/",
|
2025-06-27 13:46:21 -07:00
|
|
|
|
},
|
2021-04-15 13:22:37 +02:00
|
|
|
|
],
|
|
|
|
|
|
},
|
|
|
|
|
|
],
|
2022-05-20 16:20:31 +02:00
|
|
|
|
copyright: `Copyright © ${new Date().getFullYear()} ZITADEL Docs - Built with Docusaurus.`,
|
2021-04-15 13:22:37 +02:00
|
|
|
|
},
|
2021-04-27 15:10:13 +02:00
|
|
|
|
prism: {
|
2025-06-27 13:46:21 -07:00
|
|
|
|
additionalLanguages: [
|
|
|
|
|
|
"csharp",
|
|
|
|
|
|
"dart",
|
|
|
|
|
|
"groovy",
|
|
|
|
|
|
"regex",
|
|
|
|
|
|
"java",
|
|
|
|
|
|
"php",
|
|
|
|
|
|
"python",
|
|
|
|
|
|
"protobuf",
|
|
|
|
|
|
"json",
|
|
|
|
|
|
"bash",
|
|
|
|
|
|
],
|
2021-04-27 15:10:13 +02:00
|
|
|
|
},
|
2022-10-31 08:00:22 +01:00
|
|
|
|
colorMode: {
|
|
|
|
|
|
defaultMode: "dark",
|
|
|
|
|
|
disableSwitch: false,
|
|
|
|
|
|
respectPrefersColorScheme: true,
|
|
|
|
|
|
},
|
2024-07-11 07:54:04 +02:00
|
|
|
|
codeblock: {
|
|
|
|
|
|
showGithubLink: true,
|
2025-06-27 13:46:21 -07:00
|
|
|
|
githubLinkLabel: "View on GitHub",
|
2024-07-11 07:54:04 +02:00
|
|
|
|
showRunmeLink: false,
|
2025-06-27 13:46:21 -07:00
|
|
|
|
runmeLinkLabel: "Checkout via Runme",
|
2024-07-11 07:54:04 +02:00
|
|
|
|
},
|
2021-04-15 13:22:37 +02:00
|
|
|
|
},
|
|
|
|
|
|
presets: [
|
|
|
|
|
|
[
|
2023-02-23 12:08:06 +01:00
|
|
|
|
"classic",
|
|
|
|
|
|
/** @type {import('@docusaurus/preset-classic').Options} */
|
|
|
|
|
|
({
|
2021-04-15 13:22:37 +02:00
|
|
|
|
docs: {
|
2022-12-06 20:33:13 +01:00
|
|
|
|
routeBasePath: "/",
|
2022-02-02 13:45:01 +01:00
|
|
|
|
sidebarPath: require.resolve("./sidebars.js"),
|
2022-07-29 10:13:45 +02:00
|
|
|
|
showLastUpdateAuthor: true,
|
|
|
|
|
|
showLastUpdateTime: true,
|
|
|
|
|
|
editUrl: "https://github.com/zitadel/zitadel/edit/main/docs/",
|
2022-02-02 13:45:01 +01:00
|
|
|
|
remarkPlugins: [require("mdx-mermaid")],
|
2025-06-27 13:46:21 -07:00
|
|
|
|
docItemComponent: "@theme/ApiItem",
|
2021-04-15 13:22:37 +02:00
|
|
|
|
},
|
|
|
|
|
|
theme: {
|
2022-02-02 13:45:01 +01:00
|
|
|
|
customCss: require.resolve("./src/css/custom.css"),
|
2021-04-15 13:22:37 +02:00
|
|
|
|
},
|
2025-06-27 13:46:21 -07:00
|
|
|
|
}),
|
2021-04-15 13:22:37 +02:00
|
|
|
|
],
|
|
|
|
|
|
],
|
2022-12-05 18:36:12 +01:00
|
|
|
|
plugins: [
|
2023-02-23 12:08:06 +01:00
|
|
|
|
[
|
2025-06-27 13:46:21 -07:00
|
|
|
|
"@inkeep/cxkit-docusaurus",
|
|
|
|
|
|
{
|
|
|
|
|
|
SearchBar: {
|
|
|
|
|
|
baseSettings: {
|
|
|
|
|
|
apiKey: process.env.INKEEP_API_KEY,
|
|
|
|
|
|
primaryBrandColor: "#ff2069",
|
|
|
|
|
|
organizationDisplayName: "ZITADEL",
|
|
|
|
|
|
},
|
|
|
|
|
|
},
|
|
|
|
|
|
SearchSettings: {
|
|
|
|
|
|
tabs: ["All", "Docs", "GitHub", "Forums", "Discord"],
|
|
|
|
|
|
},
|
|
|
|
|
|
},
|
|
|
|
|
|
],
|
2025-07-07 22:54:10 -07:00
|
|
|
|
[
|
|
|
|
|
|
"@signalwire/docusaurus-plugin-llms-txt",
|
|
|
|
|
|
{
|
|
|
|
|
|
depth: 3,
|
|
|
|
|
|
logLevel: 1,
|
|
|
|
|
|
content: {
|
|
|
|
|
|
excludeRoutes: ["/search"],
|
|
|
|
|
|
enableMarkdownFiles: true,
|
|
|
|
|
|
},
|
|
|
|
|
|
},
|
|
|
|
|
|
],
|
2025-06-27 13:46:21 -07:00
|
|
|
|
[
|
|
|
|
|
|
"docusaurus-plugin-openapi-docs",
|
2023-02-23 12:08:06 +01:00
|
|
|
|
{
|
|
|
|
|
|
id: "apiDocs",
|
|
|
|
|
|
docsPluginId: "classic",
|
|
|
|
|
|
config: {
|
|
|
|
|
|
auth: {
|
|
|
|
|
|
specPath: ".artifacts/openapi/zitadel/auth.swagger.json",
|
2023-05-17 14:47:55 +02:00
|
|
|
|
outputDir: "docs/apis/resources/auth",
|
2023-02-23 12:08:06 +01:00
|
|
|
|
sidebarOptions: {
|
|
|
|
|
|
groupPathsBy: "tag",
|
2024-06-20 14:55:03 +02:00
|
|
|
|
categoryLinkSource: "tag",
|
2023-02-23 12:08:06 +01:00
|
|
|
|
},
|
|
|
|
|
|
},
|
|
|
|
|
|
mgmt: {
|
|
|
|
|
|
specPath: ".artifacts/openapi/zitadel/management.swagger.json",
|
2023-05-17 14:47:55 +02:00
|
|
|
|
outputDir: "docs/apis/resources/mgmt",
|
2023-02-23 12:08:06 +01:00
|
|
|
|
sidebarOptions: {
|
|
|
|
|
|
groupPathsBy: "tag",
|
2024-06-20 14:55:03 +02:00
|
|
|
|
categoryLinkSource: "tag",
|
2023-02-23 12:08:06 +01:00
|
|
|
|
},
|
|
|
|
|
|
},
|
|
|
|
|
|
admin: {
|
|
|
|
|
|
specPath: ".artifacts/openapi/zitadel/admin.swagger.json",
|
2023-05-17 14:47:55 +02:00
|
|
|
|
outputDir: "docs/apis/resources/admin",
|
2023-02-23 12:08:06 +01:00
|
|
|
|
sidebarOptions: {
|
|
|
|
|
|
groupPathsBy: "tag",
|
2024-06-20 14:55:03 +02:00
|
|
|
|
categoryLinkSource: "tag",
|
2023-02-23 12:08:06 +01:00
|
|
|
|
},
|
|
|
|
|
|
},
|
|
|
|
|
|
system: {
|
|
|
|
|
|
specPath: ".artifacts/openapi/zitadel/system.swagger.json",
|
2023-05-17 14:47:55 +02:00
|
|
|
|
outputDir: "docs/apis/resources/system",
|
2023-02-23 12:08:06 +01:00
|
|
|
|
sidebarOptions: {
|
|
|
|
|
|
groupPathsBy: "tag",
|
2024-06-20 14:55:03 +02:00
|
|
|
|
categoryLinkSource: "tag",
|
2023-02-23 12:08:06 +01:00
|
|
|
|
},
|
2023-04-26 07:47:57 +02:00
|
|
|
|
},
|
2024-07-26 12:28:28 +02:00
|
|
|
|
user_v2: {
|
2025-06-27 13:46:21 -07:00
|
|
|
|
specPath:
|
|
|
|
|
|
".artifacts/openapi/zitadel/user/v2/user_service.swagger.json",
|
2024-07-26 12:28:28 +02:00
|
|
|
|
outputDir: "docs/apis/resources/user_service_v2",
|
2023-04-26 07:47:57 +02:00
|
|
|
|
sidebarOptions: {
|
|
|
|
|
|
groupPathsBy: "tag",
|
2024-11-12 15:14:17 +01:00
|
|
|
|
categoryLinkSource: "auto",
|
2023-04-26 07:47:57 +02:00
|
|
|
|
},
|
2023-05-05 17:34:53 +02:00
|
|
|
|
},
|
2024-07-26 12:28:28 +02:00
|
|
|
|
session_v2: {
|
2025-06-27 13:46:21 -07:00
|
|
|
|
specPath:
|
|
|
|
|
|
".artifacts/openapi/zitadel/session/v2/session_service.swagger.json",
|
2024-07-26 12:28:28 +02:00
|
|
|
|
outputDir: "docs/apis/resources/session_service_v2",
|
2023-05-05 17:34:53 +02:00
|
|
|
|
sidebarOptions: {
|
|
|
|
|
|
groupPathsBy: "tag",
|
2024-11-12 15:14:17 +01:00
|
|
|
|
categoryLinkSource: "auto",
|
2023-05-05 17:34:53 +02:00
|
|
|
|
},
|
2023-05-11 11:23:40 +02:00
|
|
|
|
},
|
2024-07-26 12:28:28 +02:00
|
|
|
|
oidc_v2: {
|
2025-06-27 13:46:21 -07:00
|
|
|
|
specPath:
|
|
|
|
|
|
".artifacts/openapi/zitadel/oidc/v2/oidc_service.swagger.json",
|
2024-07-26 12:28:28 +02:00
|
|
|
|
outputDir: "docs/apis/resources/oidc_service_v2",
|
2023-07-10 15:27:00 +02:00
|
|
|
|
sidebarOptions: {
|
|
|
|
|
|
groupPathsBy: "tag",
|
2024-11-12 15:14:17 +01:00
|
|
|
|
categoryLinkSource: "auto",
|
2023-07-10 15:27:00 +02:00
|
|
|
|
},
|
|
|
|
|
|
},
|
2025-01-29 12:29:48 +01:00
|
|
|
|
saml_v2: {
|
2025-06-27 13:46:21 -07:00
|
|
|
|
specPath:
|
|
|
|
|
|
".artifacts/openapi/zitadel/saml/v2/saml_service.swagger.json",
|
2025-01-29 12:29:48 +01:00
|
|
|
|
outputDir: "docs/apis/resources/saml_service_v2",
|
|
|
|
|
|
sidebarOptions: {
|
|
|
|
|
|
groupPathsBy: "tag",
|
|
|
|
|
|
categoryLinkSource: "auto",
|
|
|
|
|
|
},
|
|
|
|
|
|
},
|
2024-07-26 12:28:28 +02:00
|
|
|
|
settings_v2: {
|
2025-06-27 13:46:21 -07:00
|
|
|
|
specPath:
|
|
|
|
|
|
".artifacts/openapi/zitadel/settings/v2/settings_service.swagger.json",
|
2024-07-26 12:28:28 +02:00
|
|
|
|
outputDir: "docs/apis/resources/settings_service_v2",
|
2023-05-11 11:23:40 +02:00
|
|
|
|
sidebarOptions: {
|
|
|
|
|
|
groupPathsBy: "tag",
|
2024-11-12 15:14:17 +01:00
|
|
|
|
categoryLinkSource: "auto",
|
2023-05-11 11:23:40 +02:00
|
|
|
|
},
|
2024-02-15 06:39:10 +01:00
|
|
|
|
},
|
2025-04-02 16:53:06 +02:00
|
|
|
|
action_v2: {
|
2025-06-27 13:46:21 -07:00
|
|
|
|
specPath:
|
|
|
|
|
|
".artifacts/openapi/zitadel/action/v2beta/action_service.swagger.json",
|
2025-04-02 16:53:06 +02:00
|
|
|
|
outputDir: "docs/apis/resources/action_service_v2",
|
2024-08-14 17:18:14 +03:00
|
|
|
|
sidebarOptions: {
|
2025-06-27 13:46:21 -07:00
|
|
|
|
groupPathsBy: "tag",
|
|
|
|
|
|
categoryLinkSource: "auto",
|
2024-08-14 17:18:14 +03:00
|
|
|
|
},
|
|
|
|
|
|
},
|
2025-04-02 16:53:06 +02:00
|
|
|
|
webkey_v2: {
|
2025-06-27 13:46:21 -07:00
|
|
|
|
specPath:
|
feat: exchange gRPC server implementation to connectRPC (#10145)
# Which Problems Are Solved
The current maintained gRPC server in combination with a REST (grpc)
gateway is getting harder and harder to maintain. Additionally, there
have been and still are issues with supporting / displaying `oneOf`s
correctly.
We therefore decided to exchange the server implementation to
connectRPC, which apart from supporting connect as protocol, also also
"standard" gRCP clients as well as HTTP/1.1 / rest like clients, e.g.
curl directly call the server without any additional gateway.
# How the Problems Are Solved
- All v2 services are moved to connectRPC implementation. (v1 services
are still served as pure grpc servers)
- All gRPC server interceptors were migrated / copied to a corresponding
connectRPC interceptor.
- API.ListGrpcServices and API. ListGrpcMethods were changed to include
the connect services and endpoints.
- gRPC server reflection was changed to a `StaticReflector` using the
`ListGrpcServices` list.
- The `grpc.Server` interfaces was split into different combinations to
be able to handle the different cases (grpc server and prefixed gateway,
connect server with grpc gateway, connect server only, ...)
- Docs of services serving connectRPC only with no additional gateway
(instance, webkey, project, app, org v2 beta) are changed to expose that
- since the plugin is not yet available on buf, we download it using
`postinstall` hook of the docs
# Additional Changes
- WebKey service is added as v2 service (in addition to the current
v2beta)
# Additional Context
closes #9483
---------
Co-authored-by: Elio Bischof <elio@zitadel.com>
2025-07-04 10:06:20 -04:00
|
|
|
|
".artifacts/openapi3/zitadel/webkey/v2/webkey_service.openapi.yaml",
|
2025-04-02 16:53:06 +02:00
|
|
|
|
outputDir: "docs/apis/resources/webkey_service_v2",
|
2024-02-15 06:39:10 +01:00
|
|
|
|
sidebarOptions: {
|
2025-06-27 13:46:21 -07:00
|
|
|
|
groupPathsBy: "tag",
|
|
|
|
|
|
categoryLinkSource: "auto",
|
2024-02-15 06:39:10 +01:00
|
|
|
|
},
|
2024-02-15 11:22:48 +01:00
|
|
|
|
},
|
2024-02-28 10:55:54 +02:00
|
|
|
|
feature_v2: {
|
2025-06-27 13:46:21 -07:00
|
|
|
|
specPath:
|
|
|
|
|
|
".artifacts/openapi/zitadel/feature/v2/feature_service.swagger.json",
|
2024-02-28 10:55:54 +02:00
|
|
|
|
outputDir: "docs/apis/resources/feature_service_v2",
|
|
|
|
|
|
sidebarOptions: {
|
2025-06-27 13:46:21 -07:00
|
|
|
|
groupPathsBy: "tag",
|
|
|
|
|
|
categoryLinkSource: "auto",
|
2024-02-28 10:55:54 +02:00
|
|
|
|
},
|
|
|
|
|
|
},
|
2024-08-15 06:37:06 +02:00
|
|
|
|
org_v2: {
|
2025-06-27 13:46:21 -07:00
|
|
|
|
specPath:
|
|
|
|
|
|
".artifacts/openapi/zitadel/org/v2/org_service.swagger.json",
|
2024-08-15 06:37:06 +02:00
|
|
|
|
outputDir: "docs/apis/resources/org_service_v2",
|
|
|
|
|
|
sidebarOptions: {
|
|
|
|
|
|
groupPathsBy: "tag",
|
|
|
|
|
|
categoryLinkSource: "auto",
|
|
|
|
|
|
},
|
|
|
|
|
|
},
|
2024-08-14 20:18:29 +02:00
|
|
|
|
idp_v2: {
|
2025-06-27 13:46:21 -07:00
|
|
|
|
specPath:
|
|
|
|
|
|
".artifacts/openapi/zitadel/idp/v2/idp_service.swagger.json",
|
2024-08-14 20:18:29 +02:00
|
|
|
|
outputDir: "docs/apis/resources/idp_service_v2",
|
2025-05-21 14:40:47 +02:00
|
|
|
|
sidebarOptions: {
|
|
|
|
|
|
groupPathsBy: "tag",
|
|
|
|
|
|
categoryLinkSource: "auto",
|
|
|
|
|
|
},
|
|
|
|
|
|
},
|
2025-06-02 18:27:53 +02:00
|
|
|
|
org_v2beta: {
|
2025-06-27 13:46:21 -07:00
|
|
|
|
specPath:
|
feat: exchange gRPC server implementation to connectRPC (#10145)
# Which Problems Are Solved
The current maintained gRPC server in combination with a REST (grpc)
gateway is getting harder and harder to maintain. Additionally, there
have been and still are issues with supporting / displaying `oneOf`s
correctly.
We therefore decided to exchange the server implementation to
connectRPC, which apart from supporting connect as protocol, also also
"standard" gRCP clients as well as HTTP/1.1 / rest like clients, e.g.
curl directly call the server without any additional gateway.
# How the Problems Are Solved
- All v2 services are moved to connectRPC implementation. (v1 services
are still served as pure grpc servers)
- All gRPC server interceptors were migrated / copied to a corresponding
connectRPC interceptor.
- API.ListGrpcServices and API. ListGrpcMethods were changed to include
the connect services and endpoints.
- gRPC server reflection was changed to a `StaticReflector` using the
`ListGrpcServices` list.
- The `grpc.Server` interfaces was split into different combinations to
be able to handle the different cases (grpc server and prefixed gateway,
connect server with grpc gateway, connect server only, ...)
- Docs of services serving connectRPC only with no additional gateway
(instance, webkey, project, app, org v2 beta) are changed to expose that
- since the plugin is not yet available on buf, we download it using
`postinstall` hook of the docs
# Additional Changes
- WebKey service is added as v2 service (in addition to the current
v2beta)
# Additional Context
closes #9483
---------
Co-authored-by: Elio Bischof <elio@zitadel.com>
2025-07-04 10:06:20 -04:00
|
|
|
|
".artifacts/openapi3/zitadel/org/v2beta/org_service.openapi.yaml",
|
2025-06-02 18:27:53 +02:00
|
|
|
|
outputDir: "docs/apis/resources/org_service_v2beta",
|
|
|
|
|
|
sidebarOptions: {
|
|
|
|
|
|
groupPathsBy: "tag",
|
|
|
|
|
|
categoryLinkSource: "auto",
|
|
|
|
|
|
},
|
|
|
|
|
|
},
|
2025-05-21 14:40:47 +02:00
|
|
|
|
project_v2beta: {
|
2025-06-27 13:46:21 -07:00
|
|
|
|
specPath:
|
feat: exchange gRPC server implementation to connectRPC (#10145)
# Which Problems Are Solved
The current maintained gRPC server in combination with a REST (grpc)
gateway is getting harder and harder to maintain. Additionally, there
have been and still are issues with supporting / displaying `oneOf`s
correctly.
We therefore decided to exchange the server implementation to
connectRPC, which apart from supporting connect as protocol, also also
"standard" gRCP clients as well as HTTP/1.1 / rest like clients, e.g.
curl directly call the server without any additional gateway.
# How the Problems Are Solved
- All v2 services are moved to connectRPC implementation. (v1 services
are still served as pure grpc servers)
- All gRPC server interceptors were migrated / copied to a corresponding
connectRPC interceptor.
- API.ListGrpcServices and API. ListGrpcMethods were changed to include
the connect services and endpoints.
- gRPC server reflection was changed to a `StaticReflector` using the
`ListGrpcServices` list.
- The `grpc.Server` interfaces was split into different combinations to
be able to handle the different cases (grpc server and prefixed gateway,
connect server with grpc gateway, connect server only, ...)
- Docs of services serving connectRPC only with no additional gateway
(instance, webkey, project, app, org v2 beta) are changed to expose that
- since the plugin is not yet available on buf, we download it using
`postinstall` hook of the docs
# Additional Changes
- WebKey service is added as v2 service (in addition to the current
v2beta)
# Additional Context
closes #9483
---------
Co-authored-by: Elio Bischof <elio@zitadel.com>
2025-07-04 10:06:20 -04:00
|
|
|
|
".artifacts/openapi3/zitadel/project/v2beta/project_service.openapi.yaml",
|
2025-05-21 14:40:47 +02:00
|
|
|
|
outputDir: "docs/apis/resources/project_service_v2",
|
2024-08-14 20:18:29 +02:00
|
|
|
|
sidebarOptions: {
|
|
|
|
|
|
groupPathsBy: "tag",
|
|
|
|
|
|
categoryLinkSource: "auto",
|
|
|
|
|
|
},
|
|
|
|
|
|
},
|
feat: exchange gRPC server implementation to connectRPC (#10145)
# Which Problems Are Solved
The current maintained gRPC server in combination with a REST (grpc)
gateway is getting harder and harder to maintain. Additionally, there
have been and still are issues with supporting / displaying `oneOf`s
correctly.
We therefore decided to exchange the server implementation to
connectRPC, which apart from supporting connect as protocol, also also
"standard" gRCP clients as well as HTTP/1.1 / rest like clients, e.g.
curl directly call the server without any additional gateway.
# How the Problems Are Solved
- All v2 services are moved to connectRPC implementation. (v1 services
are still served as pure grpc servers)
- All gRPC server interceptors were migrated / copied to a corresponding
connectRPC interceptor.
- API.ListGrpcServices and API. ListGrpcMethods were changed to include
the connect services and endpoints.
- gRPC server reflection was changed to a `StaticReflector` using the
`ListGrpcServices` list.
- The `grpc.Server` interfaces was split into different combinations to
be able to handle the different cases (grpc server and prefixed gateway,
connect server with grpc gateway, connect server only, ...)
- Docs of services serving connectRPC only with no additional gateway
(instance, webkey, project, app, org v2 beta) are changed to expose that
- since the plugin is not yet available on buf, we download it using
`postinstall` hook of the docs
# Additional Changes
- WebKey service is added as v2 service (in addition to the current
v2beta)
# Additional Context
closes #9483
---------
Co-authored-by: Elio Bischof <elio@zitadel.com>
2025-07-04 10:06:20 -04:00
|
|
|
|
application_v2: {
|
|
|
|
|
|
specPath: ".artifacts/openapi3/zitadel/app/v2beta/app_service.openapi.yaml",
|
|
|
|
|
|
outputDir: "docs/apis/resources/application_service_v2",
|
|
|
|
|
|
sidebarOptions: {
|
|
|
|
|
|
groupPathsBy: "tag",
|
|
|
|
|
|
categoryLinkSource: "auto",
|
|
|
|
|
|
},
|
|
|
|
|
|
},
|
2025-05-21 10:50:44 +02:00
|
|
|
|
instance_v2: {
|
2025-06-27 13:46:21 -07:00
|
|
|
|
specPath:
|
feat: exchange gRPC server implementation to connectRPC (#10145)
# Which Problems Are Solved
The current maintained gRPC server in combination with a REST (grpc)
gateway is getting harder and harder to maintain. Additionally, there
have been and still are issues with supporting / displaying `oneOf`s
correctly.
We therefore decided to exchange the server implementation to
connectRPC, which apart from supporting connect as protocol, also also
"standard" gRCP clients as well as HTTP/1.1 / rest like clients, e.g.
curl directly call the server without any additional gateway.
# How the Problems Are Solved
- All v2 services are moved to connectRPC implementation. (v1 services
are still served as pure grpc servers)
- All gRPC server interceptors were migrated / copied to a corresponding
connectRPC interceptor.
- API.ListGrpcServices and API. ListGrpcMethods were changed to include
the connect services and endpoints.
- gRPC server reflection was changed to a `StaticReflector` using the
`ListGrpcServices` list.
- The `grpc.Server` interfaces was split into different combinations to
be able to handle the different cases (grpc server and prefixed gateway,
connect server with grpc gateway, connect server only, ...)
- Docs of services serving connectRPC only with no additional gateway
(instance, webkey, project, app, org v2 beta) are changed to expose that
- since the plugin is not yet available on buf, we download it using
`postinstall` hook of the docs
# Additional Changes
- WebKey service is added as v2 service (in addition to the current
v2beta)
# Additional Context
closes #9483
---------
Co-authored-by: Elio Bischof <elio@zitadel.com>
2025-07-04 10:06:20 -04:00
|
|
|
|
".artifacts/openapi3/zitadel/instance/v2beta/instance_service.openapi.yaml",
|
2025-05-21 10:50:44 +02:00
|
|
|
|
outputDir: "docs/apis/resources/instance_service_v2",
|
|
|
|
|
|
sidebarOptions: {
|
|
|
|
|
|
groupPathsBy: "tag",
|
|
|
|
|
|
categoryLinkSource: "auto",
|
|
|
|
|
|
},
|
|
|
|
|
|
},
|
2025-07-04 18:12:59 +02:00
|
|
|
|
authorization_v2: {
|
|
|
|
|
|
specPath:
|
|
|
|
|
|
".artifacts/openapi3/zitadel/authorization/v2beta/authorization_service.openapi.yaml",
|
|
|
|
|
|
outputDir: "docs/apis/resources/authorization_service_v2",
|
|
|
|
|
|
sidebarOptions: {
|
|
|
|
|
|
groupPathsBy: "tag",
|
|
|
|
|
|
categoryLinkSource: "auto",
|
|
|
|
|
|
},
|
|
|
|
|
|
},
|
|
|
|
|
|
internal_permission_v2: {
|
|
|
|
|
|
specPath:
|
|
|
|
|
|
".artifacts/openapi3/zitadel/internal_permission/v2beta/internal_permission_service.openapi.yaml",
|
|
|
|
|
|
outputDir: "docs/apis/resources/internal_permission_service_v2",
|
|
|
|
|
|
sidebarOptions: {
|
|
|
|
|
|
groupPathsBy: "tag",
|
|
|
|
|
|
categoryLinkSource: "auto",
|
|
|
|
|
|
},
|
|
|
|
|
|
},
|
2024-02-15 11:22:48 +01:00
|
|
|
|
},
|
2023-02-23 12:08:06 +01:00
|
|
|
|
},
|
|
|
|
|
|
],
|
2022-12-05 18:36:12 +01:00
|
|
|
|
require.resolve("docusaurus-plugin-image-zoom"),
|
|
|
|
|
|
async function myPlugin(context, options) {
|
|
|
|
|
|
return {
|
|
|
|
|
|
name: "docusaurus-tailwindcss",
|
|
|
|
|
|
configurePostCss(postcssOptions) {
|
|
|
|
|
|
// Appends TailwindCSS and AutoPrefixer.
|
|
|
|
|
|
postcssOptions.plugins.push(require("tailwindcss"));
|
|
|
|
|
|
postcssOptions.plugins.push(require("autoprefixer"));
|
|
|
|
|
|
return postcssOptions;
|
|
|
|
|
|
},
|
|
|
|
|
|
};
|
|
|
|
|
|
},
|
|
|
|
|
|
],
|
2025-06-27 13:46:21 -07:00
|
|
|
|
themes: [
|
|
|
|
|
|
"docusaurus-theme-github-codeblock",
|
|
|
|
|
|
"docusaurus-theme-openapi-docs",
|
|
|
|
|
|
],
|
chore: update docusaurus to 3.8.0 (#9974)
> [!IMPORTANT]
> We need to change the ENV `VERCEL_FORCE_NO_BUILD_CACHE` to `0` which
is currently `1` to enable the cache on all deployments
This pull request includes several updates to the documentation and
benchmarking components, focusing on improving performance, error
handling, and compatibility with newer versions of Docusaurus. The key
changes include the removal of outdated configurations, updates to
dependencies, and enhancements to the `BenchmarkChart` component for
better error handling and data validation.
### Documentation and Configuration Updates:
* **Removed outdated Babel and Webpack configurations**: The
`babel.config.js` file was deleted, and the Webpack configuration was
removed from `docusaurus.config.js` to align with the latest Docusaurus
setup.
[[1]](diffhunk://#diff-2ed4f5b03d34a87ef641e9e36af4a98a1c0ddaf74d07ce93665957be69b7b09aL1-L4)
[[2]](diffhunk://#diff-28742c737e523f302e6de471b7fc27284dc8cf720be639e6afe4c17a550cd654L204-L225)
* **Added experimental features in Docusaurus**: Introduced a `future`
section in `docusaurus.config.js` to enable experimental features like
`swcJsLoader`, `rspackBundler`, and `lightningCssMinimizer`, while
disabling problematic settings due to known issues.
### Dependency Updates:
* **Upgraded Docusaurus and related packages**: Updated dependencies in
`package.json` to use Docusaurus version `^3.8.0` and newer versions of
associated plugins and themes for improved performance and
compatibility.
[[1]](diffhunk://#diff-adfa337ce44dc2902621da20152a048dac41878cf3716dfc4cc56d03aa212a56L25-R39)
[[2]](diffhunk://#diff-adfa337ce44dc2902621da20152a048dac41878cf3716dfc4cc56d03aa212a56L66-R67)
### Component Enhancements:
* **Improved `BenchmarkChart` error handling**: Refactored the
`BenchmarkChart` component to validate input data, handle errors
gracefully, and provide meaningful fallback messages when data is
missing or invalid.
[[1]](diffhunk://#diff-ce9fccf51f6b863dd58a39f361a9cf980b10357bccc7381f928788483b30cb0eL4-R21)
[[2]](diffhunk://#diff-ce9fccf51f6b863dd58a39f361a9cf980b10357bccc7381f928788483b30cb0eR72-R76)
* **Fixed edge cases in chart rendering**: Addressed issues like invalid
timestamps, undefined `p99` values, and empty data sets to ensure robust
chart generation.
[[1]](diffhunk://#diff-ce9fccf51f6b863dd58a39f361a9cf980b10357bccc7381f928788483b30cb0eL19-L29)
[[2]](diffhunk://#diff-ce9fccf51f6b863dd58a39f361a9cf980b10357bccc7381f928788483b30cb0eL38-R61)
### Documentation Benchmark Updates:
* **Simplified imports in benchmark files**: Replaced the use of
`raw-loader` with direct imports for benchmark data in multiple `.mdx`
files to streamline the documentation setup.
[[1]](diffhunk://#diff-a9710709396e5ff6756aedf89dfcbd62aeea15368ba33bf3932ebf33046a29e8L66-R66)
[[2]](diffhunk://#diff-0a9b6103c97c58792450bfd2d337bbb8a6b72df2ae326cc56ebc96e01c0acd6bL35-R35)
[[3]](diffhunk://#diff-38f45388e065c57f1282a43bb319354da3c218e96d95ca20f4d11709f48491b8L36-R36)
[[4]](diffhunk://#diff-b8e792ebe42fcb16a493e35d23b58a91c2117d949953487e70f379c64e5cb7c0L36-R36)
[[5]](diffhunk://#diff-3778acfa893504004008b162fa95f21f1c7c40dcf1868bbbaaa504ac5d51901aL38-R38)
2025-05-30 01:15:28 -07:00
|
|
|
|
future: {
|
|
|
|
|
|
v4: false, // Disabled because of some problems related to https://github.com/facebook/docusaurus/issues/11040
|
|
|
|
|
|
experimental_faster: {
|
|
|
|
|
|
swcJsLoader: false, // Disabled because of memory usage > 8GB which is a problem on vercel default runners
|
|
|
|
|
|
swcJsMinimizer: true,
|
2025-06-27 13:46:21 -07:00
|
|
|
|
swcHtmlMinimizer: true,
|
chore: update docusaurus to 3.8.0 (#9974)
> [!IMPORTANT]
> We need to change the ENV `VERCEL_FORCE_NO_BUILD_CACHE` to `0` which
is currently `1` to enable the cache on all deployments
This pull request includes several updates to the documentation and
benchmarking components, focusing on improving performance, error
handling, and compatibility with newer versions of Docusaurus. The key
changes include the removal of outdated configurations, updates to
dependencies, and enhancements to the `BenchmarkChart` component for
better error handling and data validation.
### Documentation and Configuration Updates:
* **Removed outdated Babel and Webpack configurations**: The
`babel.config.js` file was deleted, and the Webpack configuration was
removed from `docusaurus.config.js` to align with the latest Docusaurus
setup.
[[1]](diffhunk://#diff-2ed4f5b03d34a87ef641e9e36af4a98a1c0ddaf74d07ce93665957be69b7b09aL1-L4)
[[2]](diffhunk://#diff-28742c737e523f302e6de471b7fc27284dc8cf720be639e6afe4c17a550cd654L204-L225)
* **Added experimental features in Docusaurus**: Introduced a `future`
section in `docusaurus.config.js` to enable experimental features like
`swcJsLoader`, `rspackBundler`, and `lightningCssMinimizer`, while
disabling problematic settings due to known issues.
### Dependency Updates:
* **Upgraded Docusaurus and related packages**: Updated dependencies in
`package.json` to use Docusaurus version `^3.8.0` and newer versions of
associated plugins and themes for improved performance and
compatibility.
[[1]](diffhunk://#diff-adfa337ce44dc2902621da20152a048dac41878cf3716dfc4cc56d03aa212a56L25-R39)
[[2]](diffhunk://#diff-adfa337ce44dc2902621da20152a048dac41878cf3716dfc4cc56d03aa212a56L66-R67)
### Component Enhancements:
* **Improved `BenchmarkChart` error handling**: Refactored the
`BenchmarkChart` component to validate input data, handle errors
gracefully, and provide meaningful fallback messages when data is
missing or invalid.
[[1]](diffhunk://#diff-ce9fccf51f6b863dd58a39f361a9cf980b10357bccc7381f928788483b30cb0eL4-R21)
[[2]](diffhunk://#diff-ce9fccf51f6b863dd58a39f361a9cf980b10357bccc7381f928788483b30cb0eR72-R76)
* **Fixed edge cases in chart rendering**: Addressed issues like invalid
timestamps, undefined `p99` values, and empty data sets to ensure robust
chart generation.
[[1]](diffhunk://#diff-ce9fccf51f6b863dd58a39f361a9cf980b10357bccc7381f928788483b30cb0eL19-L29)
[[2]](diffhunk://#diff-ce9fccf51f6b863dd58a39f361a9cf980b10357bccc7381f928788483b30cb0eL38-R61)
### Documentation Benchmark Updates:
* **Simplified imports in benchmark files**: Replaced the use of
`raw-loader` with direct imports for benchmark data in multiple `.mdx`
files to streamline the documentation setup.
[[1]](diffhunk://#diff-a9710709396e5ff6756aedf89dfcbd62aeea15368ba33bf3932ebf33046a29e8L66-R66)
[[2]](diffhunk://#diff-0a9b6103c97c58792450bfd2d337bbb8a6b72df2ae326cc56ebc96e01c0acd6bL35-R35)
[[3]](diffhunk://#diff-38f45388e065c57f1282a43bb319354da3c218e96d95ca20f4d11709f48491b8L36-R36)
[[4]](diffhunk://#diff-b8e792ebe42fcb16a493e35d23b58a91c2117d949953487e70f379c64e5cb7c0L36-R36)
[[5]](diffhunk://#diff-3778acfa893504004008b162fa95f21f1c7c40dcf1868bbbaaa504ac5d51901aL38-R38)
2025-05-30 01:15:28 -07:00
|
|
|
|
lightningCssMinimizer: true,
|
|
|
|
|
|
mdxCrossCompilerCache: true,
|
|
|
|
|
|
ssgWorkerThreads: false, // Disabled because of some problems related to https://github.com/facebook/docusaurus/issues/11040
|
|
|
|
|
|
rspackBundler: true,
|
|
|
|
|
|
rspackPersistentCache: true,
|
|
|
|
|
|
},
|
|
|
|
|
|
},
|
2021-04-15 13:22:37 +02:00
|
|
|
|
};
|