create-zuplo-api 6.53.0 → 6.54.0

package/dist/templates/default/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/config/routes.oas.json

@@ -5,25 +5,279 @@
     "title": "My Zuplo API"
   },
   "paths": {
-    "/hello": {
-      "x-zuplo-path": {
-        "pathMode": "open-api"
-      },
+    "/todos": {
       "get": {
-        "summary": "Hello World",
-        "description": "This is the first route to say hello",
+        "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": "default",
-            "module": "$import(./modules/hello-world)",
-            "options": {}
+            "export": "urlForwardHandler",
+            "module": "$import(@zuplo/runtime)",
+            "options": {
+              "baseUrl": "https://todo-mock-main-b63f096.zuplo.app"
+            }
+          }
+        },
+        "tags": ["Todo"]
+      },
+      "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
+                    }
+                  }
+                }
+              }
+            }
           },
-          "policies": {
-            "inbound": []
+          "400": {
+            "description": "Invalid request body"
           }
         },
-        "operationId": "004ff0e0-30cf-41a7-9e9f-zuplo35e3f725"
+        "operationId": "55ee860b-fe7e-4d66-a228-bb5320c3305d",
+        "x-zuplo-route": {
+          "corsPolicy": "none",
+          "handler": {
+            "export": "urlForwardHandler",
+            "module": "$import(@zuplo/runtime)",
+            "options": {
+              "baseUrl": "https://todo-mock-main-b63f096.zuplo.app"
+            }
+          }
+        },
+        "tags": ["Todo"]
+      }
+    },
+    "/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://todo-mock-main-b63f096.zuplo.app"
+            }
+          }
+        },
+        "tags": ["Todo"]
+      },
+      "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://todo-mock-main-b63f096.zuplo.app"
+            }
+          }
+        },
+        "tags": ["Todo"]
+      }
+    }
+  },
+  "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/vscode/settings.json

@@ -15,13 +15,6 @@
     {
       "fileMatch": ["docs/sidebar.json"],
       "url": "https://cdn.zuplo.com/schemas/sidebar.json"
-    },
-    {
-      "fileMatch": ["zuplo.jsonc"],
-      "url": "https://cdn.zuplo.com/schemas/zuplo.json",
-      "schema": {
-        "allowTrailingCommas": true
-      }
     }
   ]
 }

package/package.json

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

package/dist/templates/default/config/dev-portal.json

@@ -1,5 +0,0 @@
-{
-  "$schema": "https://cdn.zuplo.com/schemas/dev-portal.json",
-  "enabled": true,
-  "enableAuthentication": true
-}

package/dist/templates/default/docs/index.md

@@ -1,43 +0,0 @@
-# My API
-
-You can write full markdown in these documents. Syntax highlighting and full
-Github Flavored markdown are supported. To learn more about customizing the
-documentation of this developer portal
-[see the documentation](https://zuplo.com/docs/developer-portal/adding-pages).
-
-```ts
-const response = await fetch("https://echo.zuplo.io", {
-  headers: {
-    "content-type": "application/json",
-  },
-});
-
-const data = await response.json();
-console.log(data);
-```
-
-## Labore et Dolore
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
-incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis
-nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
-Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu
-fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
-culpa qui officia deserunt mollit anim id est laborum.
-
-| Item            | Description                                  | Quanity |
-| --------------- | -------------------------------------------- | ------- |
-| ullamco laboris | reprehenderit in voluptate velit esse cillum | 21      |
-| Excepteur sint  | tempor incididunt ut labore                  | 1       |
-| anim id est     | irure dolor in reprehenderit in voluptate    | 82      |
-| non proiden     | cupidatat non proident, sunt in              | 53      |
-
-## Aliquip pariatur
-
-Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia
-deserunt mollit anim id est laborum.
-
-- **Item 1** - ullamco laboris nisi ut aliquip ex ea commodo
-- **Item 2** - ullamco laboris nisi ut aliquip ex ea commodo
-- **Item 3** - ullamco laboris nisi ut aliquip ex ea commodo
-- **Item 4** - ullamco laboris nisi ut aliquip ex ea commodo

package/dist/templates/default/docs/sidebar.json

@@ -1,13 +0,0 @@
-{
-  "docs": [
-    {
-      "type": "doc",
-      "id": "index",
-      "label": "Index"
-    },
-    {
-      "type": "api-ref",
-      "label": "API Reference"
-    }
-  ]
-}

package/dist/templates/default/docs/theme.css

@@ -1,29 +0,0 @@
-/* Learn about theming here: https://zuplo.com/docs/developer-portal/theme */
-
-:root {
-  --logo-url: url(https://cdn.zuplo.com/dev-portal/v2/made-with-zuplo.svg);
-}
-
-.light {
-  --background-primary: white;
-  --font-family-primary: "-apple-system", "BlinkMacSystemFont", "Segoe UI",
-    "Roboto", "Helvetica Neue", "Ubuntu", "sans-serif";
-  --text-color-h1: rgb(42 47 69);
-  --text-color-h2: rgb(42 47 69);
-  --text-color-primary: rgb(79 86 107);
-}
-
-.dark {
-  --background-primary: #1a1f36;
-  --font-family-primary: "-apple-system", "BlinkMacSystemFont", "Segoe UI",
-    "Roboto", "Helvetica Neue", "Ubuntu", "sans-serif";
-  --text-color-h1: #f7fafc;
-  --text-color-h2: #f7fafc;
-  --text-color-primary: rgb(193 201 210);
-}
-
-/* The logo image */
-.theme-logo {
-  content: var(--logo-url);
-  margin: 20px;
-}

package/dist/templates/default-zudoku/README-template.md

@@ -1,29 +0,0 @@
-## Zuplo API
-
-This is a Zuplo API that was created with
-[`create-zuplo-api`](https://zuplo.com/docs).
-
-## Getting Started
-
-First, run the development server:
-
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-```
-
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the
-result.
-
-You can start editing the API by modifying `config/routes.oas.json`. The dev
-server will automatically reload the API with your changes.
-
-## Learn More
-
-To learn more about Zuplo, you can visit the
-[Zuplo documentation](https://zuplo.com/docs).
-
-To connect with the community join [Discord](https://discord.zuplo.com).

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

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