Skip to content

Enhance API documentation with authentication guide #959

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mosch wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Enhance API documentation with authentication guide #959

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
029931a
Add rich description and title to OpenAPI spec output
claude Mar 30, 2026
3f455d2
Use markdown blockquote for API key warning in OpenAPI description
claude Mar 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions scripts/update-api.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,29 @@ const merged = {
],
info: {
...data.info,
title: "Zuplo Developer API",
version: "1.0.0",
description:
"This API allows you to manage your Zuplo account, including creating and managing projects, environments, and more.",
description: `The Zuplo Developer API lets you programmatically manage your Zuplo account, projects, environments, tunnels, custom domains, and more. Use it to automate workflows, integrate with CI/CD pipelines, or build custom tooling on top of Zuplo.

## Authentication

All API requests require a **Bearer token** in the \`Authorization\` header:

\`\`\`
Authorization: Bearer YOUR_API_KEY
\`\`\`

### Creating an API Key

1. Navigate to [portal.zuplo.com](https://portal.zuplo.com) and log in.
2. Select the account you want to work with.
3. Go to **Settings** > **API Keys**.
4. Click **Create New Key** or copy an existing key.

API keys are scoped to your account, so a single key works for all projects under that account. If you belong to multiple accounts, make sure to select the correct one before creating a key.

> **⚠️ Warning:** Keep your API key secure. Do not commit it to version control or share it publicly. Use environment variables to store your key in CI/CD environments.
`,
},
paths: addPreviewWarningToPaths(
Object.fromEntries(
Expand Down
Loading