create-zuplo-api 6.51.74 → 6.51.76

package/dist/templates/default-zudoku/config/policies.json

@@ -1,3 +1,13 @@
 {
-  "policies": []
+  "policies": [
+    {
+      "handler": {
+        "export": "MockApiInboundPolicy",
+        "module": "$import(@zuplo/runtime)",
+        "options": {}
+      },
+      "name": "mock-api-inbound",
+      "policyType": "mock-api-inbound"
+    }
+  ]
 }

package/dist/templates/default-zudoku/config/routes.oas.json

@@ -4,5 +4,289 @@
     "version": "1.0.0",
     "title": "My Zuplo API"
   },
-  "paths": {}
+  "paths": {
+    "/todos": {
+      "get": {
+        "summary": "Get all todos",
+        "description": "**Retrieves a complete list of all todo items** from the system. This endpoint returns all todos regardless of their completion status or owner, making it useful for displaying comprehensive todo lists or performing bulk operations.",
+        "responses": {
+          "200": {
+            "description": "A list of todos",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/Todo"
+                  }
+                },
+                "examples": {
+                  "mixed_todos": {
+                    "summary": "A list of todos with different completion states",
+                    "value": [
+                      {
+                        "id": 1,
+                        "title": "Buy groceries",
+                        "completed": false,
+                        "userId": 123
+                      },
+                      {
+                        "id": 2,
+                        "title": "Write documentation",
+                        "completed": true,
+                        "userId": 456
+                      },
+                      {
+                        "id": 3,
+                        "title": "Review pull requests",
+                        "completed": false,
+                        "userId": 123
+                      }
+                    ]
+                  }
+                }
+              }
+            }
+          }
+        },
+        "operationId": "1e0edd2a-8d53-4355-805f-54b7e5555725",
+        "x-zuplo-route": {
+          "corsPolicy": "none",
+          "handler": {
+            "export": "urlForwardHandler",
+            "module": "$import(@zuplo/runtime)",
+            "options": {
+              "baseUrl": "https://echo.zuplo.io"
+            }
+          },
+          "policies": {
+            "inbound": ["mock-api-inbound"]
+          }
+        }
+      },
+      "post": {
+        "summary": "Create a new todo",
+        "description": "**Creates a new todo item** with the provided details. The todo will be assigned a unique ID automatically and can include a title, completion status, and user association. This is the primary endpoint for adding new tasks to the system.",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/CreateTodo"
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "Todo created successfully",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Todo"
+                },
+                "examples": {
+                  "new_todo": {
+                    "summary": "A newly created todo",
+                    "value": {
+                      "id": 4,
+                      "title": "Deploy application",
+                      "completed": false,
+                      "userId": 789
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid request body"
+          }
+        },
+        "operationId": "55ee860b-fe7e-4d66-a228-bb5320c3305d",
+        "x-zuplo-route": {
+          "corsPolicy": "none",
+          "handler": {
+            "export": "urlForwardHandler",
+            "module": "$import(@zuplo/runtime)",
+            "options": {
+              "baseUrl": "https://echo.zuplo.io"
+            }
+          },
+          "policies": {
+            "inbound": ["mock-api-inbound"]
+          }
+        }
+      }
+    },
+    "/todos/{id}": {
+      "put": {
+        "summary": "Update a todo",
+        "description": "**Updates an existing todo item** by its unique identifier. You can modify any combination of the todo's properties including title, completion status, and user assignment. All changes are applied atomically to ensure data consistency.",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "integer"
+            },
+            "description": "The todo ID"
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/UpdateTodo"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Todo updated successfully",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Todo"
+                },
+                "examples": {
+                  "updated_todo": {
+                    "summary": "A todo that has been updated",
+                    "value": {
+                      "id": 1,
+                      "title": "Buy groceries and cook dinner",
+                      "completed": true,
+                      "userId": 123
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid request body"
+          },
+          "404": {
+            "description": "Todo not found"
+          }
+        },
+        "operationId": "4569a607-338e-4d66-80f7-17f911778b1d",
+        "x-zuplo-route": {
+          "corsPolicy": "none",
+          "handler": {
+            "export": "urlForwardHandler",
+            "module": "$import(@zuplo/runtime)",
+            "options": {
+              "baseUrl": "https://echo.zuplo.io"
+            }
+          },
+          "policies": {
+            "inbound": ["mock-api-inbound"]
+          }
+        }
+      },
+      "delete": {
+        "summary": "Delete a todo",
+        "description": "**Permanently removes a todo item** from the system using its unique identifier. This operation cannot be undone, so use with caution. The endpoint will return a 404 error if the specified todo does not exist.",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "integer"
+            },
+            "description": "The todo ID"
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "Todo deleted successfully"
+          },
+          "404": {
+            "description": "Todo not found"
+          }
+        },
+        "operationId": "888a8d15-aa30-45fe-8957-b07a8bcdd7ca",
+        "x-zuplo-route": {
+          "corsPolicy": "none",
+          "handler": {
+            "export": "urlForwardHandler",
+            "module": "$import(@zuplo/runtime)",
+            "options": {
+              "baseUrl": "https://echo.zuplo.io"
+            }
+          },
+          "policies": {
+            "inbound": ["mock-api-inbound"]
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "Todo": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "integer",
+            "description": "The todo ID"
+          },
+          "title": {
+            "type": "string",
+            "description": "The todo title"
+          },
+          "completed": {
+            "type": "boolean",
+            "description": "Whether the todo is completed"
+          },
+          "userId": {
+            "type": "integer",
+            "description": "The user ID who owns the todo"
+          }
+        },
+        "required": ["id", "title", "completed", "userId"]
+      },
+      "CreateTodo": {
+        "type": "object",
+        "properties": {
+          "title": {
+            "type": "string",
+            "description": "The todo title"
+          },
+          "completed": {
+            "type": "boolean",
+            "description": "Whether the todo is completed",
+            "default": false
+          },
+          "userId": {
+            "type": "integer",
+            "description": "The user ID who owns the todo"
+          }
+        },
+        "required": ["title", "userId"]
+      },
+      "UpdateTodo": {
+        "type": "object",
+        "properties": {
+          "title": {
+            "type": "string",
+            "description": "The todo title"
+          },
+          "completed": {
+            "type": "boolean",
+            "description": "Whether the todo is completed"
+          },
+          "userId": {
+            "type": "integer",
+            "description": "The user ID who owns the todo"
+          }
+        }
+      }
+    }
+  }
 }

package/dist/templates/default-zudoku/docs/pages/introduction.mdx

@@ -1,15 +1,126 @@
 ---
-title: Welcome to Zudoku
+description: Welcome to your new Zudoku documentation site.
+sidebar_label: My Developer Portal
+sidebar_icon: panel-top
+category: ""
 ---
 
-Thanks for choosing to use Zudoku to power your API documentation!
+<img src="./banner.jpg" />
 
-## Edit this page
+# Welcome to Better API Documentation
 
-To edit this page, open the `index.mdx` file in the `pages` directory.
+Welcome to your new developer portal that makes sense. 🎉
 
-## Additional Configuration
+This is your new developer portal, built with ["Zudoku by Zuplo"](https://github.com/zuplo/zudoku) and designed to elevate your API documentation experience. We've streamlined the setup process so you can focus on what matters most: creating exceptional developer experiences.
 
-You can find the full configuration for your Zudoku site in the `zudoku.config.ts` file.
+Think of this as your API's professional showcase—presenting your endpoints and documentation in the best possible light. Whether you're launching innovative new features or improving existing services, this portal provides the foundation for clear, accessible, and engaging developer documentation.
 
-For further information on how to customize your site, check out the [Zudoku documentation](https://zudoku.dev/docs).
+Let's explore what we've configured for you and how you can customize it to perfectly match your needs.
+
+## Let's Review Your Configuration
+
+The developer portal is configured in the `zudoku.config.tsx` file. We've created a starter configuration to get you up and running quickly.
+Let's walk you through everything we've set up so you know how to customize it:
+
+<Stepper>
+
+1. **Change the Basics**
+
+   First, you may want to change the title and banner we've put in place. These are part of the `page` section in your configuration.
+
+   :::tip
+   **Have a company logo?** Learn how you can [add your logo](https://zuplo.com/docs/dev-portal/zudoku/configuration/page#logo) in our documentation.
+   :::
+
+   ```jsx
+   {
+    // ...
+    "page": {
+      "pageTitle": "My Developer Portal",
+      "banner": {
+        "message": (
+          <div className="w-full text-center">
+            <strong>Congrats!</strong> 🙌 You just created your first developer
+            portal.
+          </div>
+        ),
+        "color": "info",
+        "dismissible": true,
+      }
+   }
+   ```
+
+1. **API Reference**
+
+   Your [API Reference](/api) is generated from your Zuplo OpenAPI file in `../routes.oas.json`—you can add other APIs whenever you need them.
+   Improve your documentation by adding more details to the OpenAPI file.
+
+   ```json
+   {
+     // ...
+     "apis": {
+       "type": "file",
+       "input": "../config/routes.oas.json",
+       "navigationId": "api"
+     }
+   }
+   ```
+
+1. **Authentication & Login**
+
+   We've configured your project to use [Auth0](https://auth0.com) as an authentication provider with our demo account. We support many authentication providers—check the [documentation on how to configure](https://zuplo.com/docs/dev-portal/zudoku/configuration/authentication#authentication-providers) each one.
+
+   :::caution
+   You must change the authentication provider before taking this to **production**. Using our demo provider is not secure for production use.
+   :::
+
+   ```json
+   {
+     // ...
+     "authentication": {
+       "type": "auth0",
+       "domain": "auth.zuplo.io",
+       "clientId": "kWQs12Q9Og4w6zzI82qJSa3klN1sMtvz",
+       "audience": "https://api.example.com/"
+     }
+   }
+   ```
+
+1. **API Keys**
+
+   We've enabled API Keys on your developer portal. This connects to the API Key Service in Zuplo.
+   To add API Keys for your users, create a consumer with the matching email address in **Services => API Key Service** in Zuplo, or [create a Consumer using the Zuplo API](https://zuplo.com/docs/api/api-keys-consumers#creates-a-consumer).
+
+   ```json
+   {
+     // ...
+     "apiKeys": {
+       "enabled": true
+     }
+   }
+   ```
+
+</Stepper>
+
+## Make It Yours
+
+You can customize the look and feel of your documentation site by modifying the `theme` section in `zudoku.config.tsx`. Why not try changing the primary color of your site?
+
+```json
+{
+  // ...
+  "theme": {
+    "light": {
+      "primary": "316 100% 50%",
+      "primaryForeground": "360 100% 100%"
+    },
+    "dark": {
+      "primary": "316 100% 50%",
+      "primaryForeground": "360 100% 100%"
+    }
+  }
+  // ...
+}
+```
+
+We have extensive customization options available. From colors to fonts and borders, find the [full list of options](https://zuplo.com/docs/dev-portal/zudoku/customization/colors-theme) in our documentation.

package/dist/templates/default-zudoku/docs/tsconfig.json

@@ -11,5 +11,6 @@
     "isolatedModules": true,
     "useUnknownInCatchVariables": false,
     "jsx": "react-jsx"
-  }
+  },
+  "include": ["src", "zudoku.config.tsx"]
 }

package/dist/templates/default-zudoku/docs/zudoku.config.tsx

@@ -0,0 +1,82 @@
+import type { ZudokuConfig } from "zudoku";
+
+const config: ZudokuConfig = {
+  page: {
+    pageTitle: "My Developer Portal",
+    banner: {
+      message: (
+        <div className="w-full text-center">
+          <strong>Congrats!</strong> 🙌 You just created your first developer
+          portal.
+        </div>
+      ),
+      color: "info",
+      dismissible: true,
+    },
+  },
+  basePath: "/docs",
+  topNavigation: [
+    { id: "docs", label: "Documentation" },
+    { id: "api", label: "API Reference" },
+  ],
+  sidebar: {
+    docs: [
+      {
+        type: "category",
+        label: "Getting Started",
+        icon: "sparkles",
+        items: [
+          "/introduction",
+          {
+            type: "link",
+            icon: "folder-cog",
+            badge: {
+              label: "New",
+              color: "purple",
+            },
+            label: "API Reference",
+            href: "/api",
+          },
+        ],
+      },
+      {
+        type: "category",
+        label: "Useful Links",
+        collapsible: false,
+        icon: "link",
+        items: [
+          {
+            type: "link",
+            label: "Zuplo Docs",
+            href: "https://zuplo.com/docs/dev-portal/introduction",
+          },
+          {
+            type: "link",
+            label: "Developer Portal Docs",
+            href: "https://zuplo.com/docs/dev-portal/introduction",
+          },
+        ],
+      },
+    ],
+  },
+  redirects: [{ from: "/", to: "/introduction" }],
+  apis: {
+    type: "file",
+    input: "../config/routes.oas.json",
+    navigationId: "api",
+  },
+  docs: {
+    files: "/pages/**/*.mdx",
+  },
+  authentication: {
+    type: "auth0",
+    domain: "auth.zuplo.io",
+    clientId: "v0cOpST3pX6NIs1VGLVvNjaN3mSBomKk",
+    audience: "https://api.example.com/",
+  },
+  apiKeys: {
+    enabled: true,
+  },
+};
+
+export default config;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-zuplo-api",
-  "version": "6.51.74",
+  "version": "6.51.76",
   "keywords": [
     "api",
     "openapi",

package/dist/templates/default-zudoku/docs/pages/example.mdx

@@ -1,9 +0,0 @@
----
-title: "Example page"
----
-
-:::tip
-
-Edit this page by opening the `example.mdx` file in the `pages/docs` directory.
-
-:::

package/dist/templates/default-zudoku/docs/zudoku.config.ts

@@ -1,28 +0,0 @@
-import type { ZudokuConfig } from "zudoku";
-
-const config: ZudokuConfig = {
-  topNavigation: [
-    { id: "docs", label: "Documentation" },
-    { id: "api", label: "API Reference" },
-  ],
-  sidebar: {
-    docs: [
-      {
-        type: "category",
-        label: "Overview",
-        items: ["/introduction", "/example"],
-      },
-    ],
-  },
-  redirects: [{ from: "/", to: "/introduction" }],
-  apis: {
-    type: "file",
-    input: "../config/routes.oas.json",
-    navigationId: "api",
-  },
-  docs: {
-    files: "/pages/**/*.{md,mdx}",
-  },
-};
-
-export default config;