From 9374ee3c2efab6ea05c87e909f8f0a92e66cdd61 Mon Sep 17 00:00:00 2001 From: Sheen Capadngan Date: Wed, 30 Jul 2025 03:57:59 +0800 Subject: [PATCH] doc: add bootstrap to API reference --- backend/src/server/routes/v1/admin-router.ts | 1 + .../api-reference/endpoints/admin/bootstrap-instance.mdx | 9 +++++++++ docs/docs.json | 6 +++++- 3 files changed, 15 insertions(+), 1 deletion(-) create mode 100644 docs/api-reference/endpoints/admin/bootstrap-instance.mdx diff --git a/backend/src/server/routes/v1/admin-router.ts b/backend/src/server/routes/v1/admin-router.ts index 57aa42fae6..6ad368816b 100644 --- a/backend/src/server/routes/v1/admin-router.ts +++ b/backend/src/server/routes/v1/admin-router.ts @@ -687,6 +687,7 @@ export const registerAdminRouter = async (server: FastifyZodProvider) => { rateLimit: writeLimit }, schema: { + hide: false, body: z.object({ email: z.string().email().trim().min(1), password: z.string().trim().min(1), diff --git a/docs/api-reference/endpoints/admin/bootstrap-instance.mdx b/docs/api-reference/endpoints/admin/bootstrap-instance.mdx new file mode 100644 index 0000000000..ce147bff12 --- /dev/null +++ b/docs/api-reference/endpoints/admin/bootstrap-instance.mdx @@ -0,0 +1,9 @@ +--- +title: "Bootstrap Instance" +openapi: "POST /api/v1/admin/bootstrap" +--- + + + For guidance, check out the docs for [Programmatic + Provisioning](/self-hosting/guides/automated-bootstrapping). + diff --git a/docs/docs.json b/docs/docs.json index ebbc315000..82988328c5 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -717,6 +717,10 @@ { "group": "Endpoints", "pages": [ + { + "group": "Admin", + "pages": ["api-reference/endpoints/admin/bootstrap-instance"] + }, { "group": "Identities", "pages": [ @@ -1393,7 +1397,7 @@ "api-reference/endpoints/app-connections/databricks/delete" ] }, - { + { "group": "Digital Ocean", "pages": [ "api-reference/endpoints/app-connections/digital-ocean/list",