@lukoweb/apitogo 0.1.67 → 0.1.68

package/docs/components/playground.mdx

@@ -34,15 +34,14 @@ type PlaygroundProps = {
 
 ## Examples
 
-### Zuplo Echo
+### httpbin example
 
-In this example, we're using the Zuplo Echo API to test the `POST /hello-world/{name}` endpoint.
+Example against [httpbin](https://httpbin.org/) `POST /post`:
 
 <OpenPlaygroundButton
-  server="https://echo.zuplo.io/"
-  url="/hello-world/{name}"
+  server="https://httpbin.org/"
+  url="/post"
   headers={[{ name: "X-APIToGo-Playground", defaultValue: "Hello World" }]}
-  pathParams={[{ name: "name", defaultValue: "John" }]}
   queryParams={[
     { name: "age", defaultValue: "30" },
     { name: "city", defaultValue: "New York" },
@@ -53,15 +52,14 @@ In this example, we're using the Zuplo Echo API to test the `POST /hello-world/{
 
 ```tsx
 <OpenPlaygroundButton
-  server="https://echo.zuplo.io/"
-  url="/hello-world/{name}"
+  server="https://httpbin.org/"
+  url="/post"
   headers={[
     {
       name: "X-APIToGo-Playground",
       defaultValue: "Hello World",
     },
   ]}
-  pathParams={[{ name: "name", defaultValue: "John" }]}
   queryParams={[
     { name: "age", defaultValue: "30" },
     { name: "city", defaultValue: "New York" },

package/docs/components/slot.mdx

@@ -97,11 +97,11 @@ declare module "@lukoweb/apitogo" {
 ## Integration with Configuration
 
 The Slot component works with configuration-based slots. Content defined in your
-`apitogo.config.tsx` and content injected via `Slot.Source` components will be combined according to
+`apitogo.config.json` and content injected via `Slot.Source` components will be combined according to
 the `type` parameter.
 
 ```tsx
-// In apitogo.config.tsx
+// In your site config
 slots: {
   "page-header": <div>Config header</div>
 }

package/docs/concepts/auth-provider-api-identities.md

@@ -1,14 +1,11 @@
 ---
 title: Authentication Providers & API Identities
 sidebar_label: Authentication and Identities
-zuplo: false
 ---
 
-When building an API documentation portal, you often need to provide a way for users to authenticate
-their API requests. This typically involves managing API keys and different authentication
-identities. However, implementing a secure and user-friendly system for API key management can be
-complex and time-consuming. APIToGo provides a powerful solution to this problem through its API
-Keys and Identities system.
+When building an API documentation portal, you often need a way for users to authenticate API
+requests — API keys and other identities — separately from how they sign in to the portal.
+APIToGo splits **portal authentication** from **API identities**.
 
 ## Authentication Providers and API Identities
 
@@ -23,7 +20,8 @@ Before diving into API Identities, it's important to understand that APIToGo sep
 authentication from API authentication. Authentication providers handle how users sign in to your
 documentation portal, while API Identities manage how these users interact with your APIs.
 
-Authentication providers (like Auth0 or custom JWT) handle:
+Portal products use [`dev-portal`](../configuration/authentication.md) auth (backend-delegated
+OIDC). SPA providers (Auth0, Clerk, …) are advanced for standalone docs sites. Providers handle:
 
 - User authentication for the documentation portal
 - Session management
@@ -70,14 +68,12 @@ demo API.
 
 :::note
 
-This example shows how to implement API Identities in APIToGo. If you're using Zuplo and you are
-using the built-in API Key management system, you don't need to implement this yourself. Zuplo will
-handle API Identities for you.
+For APItoGo-hosted portals, subscription keys come from the platform after `dev-portal` sign-in.
+Implement custom API Identities when the playground should attach your own keys or JWTs.
 
 :::
 
-To add API Identities to your APIToGo configuration, you need to implement the `ApiIdentityPlugin`
-interface. Here's an example:
+To add API Identities, implement the `ApiIdentityPlugin` interface:
 
 ```typescript
 import { createApiIdentityPlugin } from "@lukoweb/apitogo/plugins";

package/docs/configuration/ai-assistants.md

@@ -14,7 +14,7 @@ behavior using the top-level `aiAssistants` configuration.
 
 To remove all AI assistant options:
 
-```ts title=apitogo.config.ts
+```ts title=config
 const config = {
   aiAssistants: false,
   // ...
@@ -23,7 +23,7 @@ const config = {
 
 ## Use Only Specific Presets
 
-```ts title=apitogo.config.ts
+```ts title=config
 const config = {
   aiAssistants: ["claude"], // Only show Claude
   // ...
@@ -37,7 +37,7 @@ Available presets: `"claude"`, `"chatgpt"`
 You can add custom entries with a label and URL. Use `{pageUrl}` as a placeholder in the URL string,
 or provide a callback for full control:
 
-```ts title=apitogo.config.ts
+```ts title=config
 const config = {
   aiAssistants: [
     "claude", // built-in preset

package/docs/configuration/api-catalog.md

@@ -11,7 +11,7 @@ creates an overview of all your APIs and lets you organize them into categories
 The first step to enable the API Catalog, you need to add a `catalogs` object to your APIToGo
 configuration file.
 
-```js title=apitogo.config.ts
+```js title=config
 const config = {
   // ...
   catalogs: {
@@ -25,7 +25,7 @@ const config = {
 You can then add your APIs to the catalog by adding the `categories` property to your API
 configuration.
 
-```js title=apitogo.config.ts
+```js title=config
 const config = {
   // ...
   apis: [
@@ -61,7 +61,7 @@ const config = {
 You can select which APIs are shown in the catalog by using the `items` property. The `items`
 property is an array of navigation IDs of the APIs you want to show in the catalog.
 
-```js title=apitogo.config.ts
+```js title=config
 const config = {
   // ...
   catalogs: {
@@ -94,7 +94,7 @@ const config = {
 You can filter which APIs are shown in the catalog by using the `filterItems` property. The function
 receives the items and context as arguments.
 
-```js title=apitogo.config.ts
+```js title=config
 const config = {
   // ...
   catalogs: {

package/docs/configuration/api-reference.md

@@ -18,7 +18,7 @@ local file path. The OpenAPI document can be in either JSON or YAML format.
 You can reference a local OpenAPI document by setting the `type` to `file` and providing the path to
 the file.
 
-```ts title=apitogo.config.ts
+```ts title=config
 const config = {
   // ...
   apis: {
@@ -45,12 +45,12 @@ If your OpenAPI document is accessible elsewhere via URL you can use this config
 the `input` value to the URL of your own OpenAPI document (you can use the Rick & Morty API document
 if you want to test and play around):
 
-```ts title=apitogo.config.ts
+```ts title=config
 const config = {
   // ...
   apis: {
     type: "url",
-    input: "https://rickandmorty.zuplo.io/openapi.json",
+    input: "https://petstore3.swagger.io/api/v3/openapi.json",
     path: "/api",
   },
   // ...
@@ -71,7 +71,7 @@ hosting the document has the correct CORS policy in place to allow the APIToGo s
 When using `type: "file"`, you can provide an array of file paths to create versioned API
 documentation. Version metadata is automatically extracted from each OpenAPI schema at build time:
 
-```ts title=apitogo.config.ts
+```ts title=config
 const config = {
   apis: {
     type: "file",
@@ -87,7 +87,7 @@ const config = {
 
 If you need to override version metadata, you can specify it explicitly:
 
-```ts title=apitogo.config.ts
+```ts title=config
 const config = {
   apis: {
     type: "file",
@@ -118,7 +118,7 @@ You can specify:
 You can also mix strings and objects in the array - use strings for defaults and objects when you
 need to customize:
 
-```ts title=apitogo.config.ts
+```ts title=config
 const config = {
   apis: {
     type: "file",
@@ -140,7 +140,7 @@ const config = {
 If you have one schema containing multiple API versions (e.g. `/v1/...` and `/v2/...` paths), you
 can split it into separate versions by appending query parameters to the input path:
 
-```ts title=apitogo.config.ts
+```ts title=config
 const config = {
   apis: {
     type: "file",
@@ -161,7 +161,7 @@ When using `type: "url"`, you can provide an array of version configurations. Si
 schemas cannot be processed at build time, you must explicitly specify the version identifier and
 optional label:
 
-```ts title=apitogo.config.ts
+```ts title=config
 const config = {
   apis: {
     type: "url",
@@ -192,7 +192,7 @@ Each URL version object requires:
 
 The `options` field allows you to customize the API reference behavior:
 
-```ts title=apitogo.config.ts
+```ts title=config
 const config = {
   apis: {
     type: "file",
@@ -244,7 +244,7 @@ Available options:
 Instead of setting options for each API individually, you can use `defaults.apis` to set global
 defaults that apply to all APIs:
 
-```ts title=apitogo.config.ts
+```ts title=config
 const config = {
   defaults: {
     apis: {
@@ -282,7 +282,7 @@ customize or disable these using the top-level `aiAssistants` configuration. See
 Use `generateCodeSnippet` to generate custom code snippets instead of the default HTTP examples.
 This is useful when you want to show SDK usage or language-specific implementations.
 
-```tsx title=apitogo.config.tsx
+```tsx title=config
 const config: ApitogoConfig = {
   apis: {
     type: "file",

package/docs/configuration/authentication-auth0.md

@@ -6,6 +6,13 @@ description:
   integration steps for secure API documentation access.
 ---
 
+:::caution{title="SPA / advanced"}
+
+Portal products on APItoGo use [`dev-portal`](./authentication.md) authentication. Use Auth0 SPA
+integration only for standalone docs sites that talk to Auth0 directly.
+
+:::
+
 Auth0 is a flexible authentication and authorization platform that integrates seamlessly with
 APIToGo. This guide walks you through setting up Auth0 authentication for your documentation site.
 
@@ -66,7 +73,7 @@ If you don't have an Auth0 account, you can sign up for a
    Add the Auth0 configuration to your [APIToGo configuration file](./overview.md):
 
    ```typescript
-   // apitogo.config.ts
+   // site config
    export default {
      // ... other configuration
      authentication: {

package/docs/configuration/authentication-azure-ad.md

@@ -6,6 +6,13 @@ description:
   enabling secure single sign-on for your organization.
 ---
 
+:::caution{title="SPA / advanced"}
+
+Portal products on APItoGo use [`dev-portal`](./authentication.md) authentication. Use Azure AD SPA
+integration only for standalone docs sites that talk to Entra ID directly.
+
+:::
+
 Azure Active Directory (now Microsoft Entra ID) provides enterprise-grade authentication and
 authorization for organizations using Microsoft's cloud identity platform. This guide shows you how
 to integrate Azure AD with your APIToGo documentation site.
@@ -69,7 +76,7 @@ to integrate Azure AD with your APIToGo documentation site.
    Add the configuration to your [APIToGo configuration file](./overview.md):
 
    ```typescript
-   // apitogo.config.ts
+   // site config
    export default {
      // ... other configuration
      authentication: {

package/docs/configuration/authentication-clerk.md

@@ -6,6 +6,13 @@ description:
   experience with modern UI components and extensive customization options.
 ---
 
+:::caution{title="SPA / advanced"}
+
+Portal products on APItoGo use [`dev-portal`](./authentication.md) authentication. Use Clerk SPA
+integration only for standalone docs sites that talk to Clerk directly.
+
+:::
+
 Clerk is a modern authentication platform that provides beautiful, customizable UI components and a
 developer-friendly experience. This guide walks you through integrating Clerk authentication with
 your APIToGo documentation site.
@@ -54,7 +61,7 @@ that provides 10,000 monthly active users.
    Add the Clerk configuration to your [APIToGo configuration file](./overview.md):
 
    ```typescript
-   // apitogo.config.ts
+   // site config
    export default {
      // ... other configuration
      authentication: {

package/docs/configuration/authentication-firebase.md

@@ -6,6 +6,13 @@ description:
   infrastructure with multiple sign-in providers.
 ---
 
+:::caution{title="SPA / advanced"}
+
+Portal products on APItoGo use [`dev-portal`](./authentication.md) authentication. Use Firebase SPA
+integration only for standalone docs sites that talk to Firebase directly.
+
+:::
+
 Firebase Authentication provides a comprehensive identity solution from Google, supporting
 email/password authentication and federated identity providers like Google, Facebook, Twitter, and
 more. This guide shows you how to integrate Firebase Authentication with your APIToGo documentation
@@ -34,7 +41,7 @@ site.
 
 Add the Firebase configuration to your [APIToGo configuration file](./overview.md):
 
-```typescript title="apitogo.config.ts"
+```typescript title="config"
 export default {
   authentication: {
     type: "firebase",

package/docs/configuration/authentication-pingfederate.md

@@ -6,6 +6,13 @@ description:
   enterprise-grade single sign-on.
 ---
 
+:::caution{title="SPA / advanced"}
+
+Portal products on APItoGo use [`dev-portal`](./authentication.md) authentication. Use PingFederate
+SPA integration only for standalone docs sites that talk to PingFederate directly.
+
+:::
+
 PingFederate is an enterprise federation server that enables secure single sign-on (SSO) and API
 security for organizations. This guide walks you through integrating PingFederate with APIToGo using
 OpenID Connect.
@@ -50,7 +57,7 @@ OpenID Connect.
    Add the PingFederate configuration to your [APIToGo configuration file](./overview.md):
 
    ```typescript
-   // apitogo.config.ts
+   // site config
    export default {
      // ... other configuration
      authentication: {

package/docs/configuration/authentication-supabase.md

@@ -6,6 +6,13 @@ description:
   providers for secure documentation access.
 ---
 
+:::caution{title="SPA / advanced"}
+
+Portal products on APItoGo use [`dev-portal`](./authentication.md) authentication. Use Supabase SPA
+integration only for standalone docs sites that talk to Supabase directly.
+
+:::
+
 Supabase is an open-source Firebase alternative that provides authentication, database, and storage
 services. This guide shows you how to integrate Supabase authentication with your APIToGo
 documentation site.
@@ -40,7 +47,7 @@ You'll need a Supabase project. If you don't have one,
 
    Add the Supabase configuration to your [APIToGo configuration file](./overview.md):
 
-   ```ts title="apitogo.config.ts"
+   ```ts title="config"
    export default {
      // ... other configuration
      authentication: {
@@ -55,7 +62,7 @@ You'll need a Supabase project. If you don't have one,
 
    You can configure multiple providers:
 
-   ```ts title="apitogo.config.ts"
+   ```ts title="config"
    export default {
      // ... other configuration
      authentication: {
@@ -116,7 +123,7 @@ default in Supabase. To disable email/password authentication and only use OAuth
 
 All available configuration options for Supabase authentication:
 
-```ts title="apitogo.config.ts"
+```ts title="config"
 authentication: {
   type: "supabase",