@clidey/dory 0.21.4 → 0.23.0

package/dist/api-reference/openapi.json

@@ -0,0 +1,366 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "Products API",
+    "version": "1.0.0",
+    "description": "API for managing products"
+  },
+  "servers": [
+    {
+      "url": "https://api.example.com/v1",
+      "description": "Production server"
+    }
+  ],
+  "components": {
+    "securitySchemes": {
+      "ApiKeyAuth": {
+        "type": "apiKey",
+        "in": "header",
+        "name": "X-API-Key"
+      }
+    },
+    "schemas": {
+      "Product": {
+        "type": "object",
+        "required": ["name", "price", "category"],
+        "properties": {
+          "id": {
+            "type": "string",
+            "format": "uuid",
+            "description": "Unique identifier for the product"
+          },
+          "name": {
+            "type": "string",
+            "description": "Name of the product"
+          },
+          "description": {
+            "type": "string",
+            "description": "Detailed description of the product"
+          },
+          "price": {
+            "type": "number",
+            "format": "float",
+            "minimum": 0,
+            "description": "Price of the product"
+          },
+          "category": {
+            "type": "string",
+            "description": "Category of the product"
+          },
+          "inStock": {
+            "type": "boolean",
+            "default": true,
+            "description": "Whether the product is in stock"
+          },
+          "createdAt": {
+            "type": "string",
+            "format": "date-time",
+            "description": "Creation timestamp"
+          },
+          "updatedAt": {
+            "type": "string",
+            "format": "date-time",
+            "description": "Last update timestamp"
+          }
+        }
+      },
+      "Error": {
+        "type": "object",
+        "properties": {
+          "code": {
+            "type": "string",
+            "description": "Error code"
+          },
+          "message": {
+            "type": "string",
+            "description": "Error message"
+          }
+        }
+      }
+    }
+  },
+  "paths": {
+    "/products": {
+      "get": {
+        "summary": "List all products",
+        "description": "Retrieve a paginated list of products",
+        "security": [
+          {
+            "ApiKeyAuth": []
+          }
+        ],
+        "parameters": [
+          {
+            "name": "page",
+            "in": "query",
+            "description": "Page number",
+            "required": false,
+            "schema": {
+              "type": "integer",
+              "default": 1,
+              "minimum": 1
+            }
+          },
+          {
+            "name": "limit",
+            "in": "query",
+            "description": "Number of items per page",
+            "required": false,
+            "schema": {
+              "type": "integer",
+              "default": 10,
+              "minimum": 1,
+              "maximum": 100
+            }
+          },
+          {
+            "name": "category",
+            "in": "query",
+            "description": "Filter by category",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "data": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/Product"
+                      }
+                    },
+                    "total": {
+                      "type": "integer"
+                    },
+                    "page": {
+                      "type": "integer"
+                    },
+                    "limit": {
+                      "type": "integer"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        }
+      },
+      "post": {
+        "summary": "Create a new product",
+        "description": "Create a new product with the provided details",
+        "security": [
+          {
+            "ApiKeyAuth": []
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "required": ["name", "price", "category"],
+                "properties": {
+                  "name": {
+                    "type": "string"
+                  },
+                  "description": {
+                    "type": "string"
+                  },
+                  "price": {
+                    "type": "number",
+                    "minimum": 0
+                  },
+                  "category": {
+                    "type": "string"
+                  },
+                  "inStock": {
+                    "type": "boolean"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "Product created successfully",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Product"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid input",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/products/{id}": {
+      "parameters": [
+        {
+          "name": "id",
+          "in": "path",
+          "required": true,
+          "schema": {
+            "type": "string",
+            "format": "uuid"
+          },
+          "description": "Product ID"
+        }
+      ],
+      "get": {
+        "summary": "Get product by ID",
+        "description": "Retrieve a specific product by its ID",
+        "security": [
+          {
+            "ApiKeyAuth": []
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Product"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Product not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        }
+      },
+      "put": {
+        "summary": "Update product",
+        "description": "Update an existing product by its ID",
+        "security": [
+          {
+            "ApiKeyAuth": []
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string"
+                  },
+                  "description": {
+                    "type": "string"
+                  },
+                  "price": {
+                    "type": "number",
+                    "minimum": 0
+                  },
+                  "category": {
+                    "type": "string"
+                  },
+                  "inStock": {
+                    "type": "boolean"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Product updated successfully",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Product"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Product not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        }
+      },
+      "delete": {
+        "summary": "Delete product",
+        "description": "Delete a product by its ID",
+        "security": [
+          {
+            "ApiKeyAuth": []
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "Product deleted successfully"
+          },
+          "404": {
+            "description": "Product not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Error"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/dist/api-reference/operations/create.mdx

@@ -0,0 +1,5 @@
+---
+title: 'POST /products'
+description: 'Create a new product'
+openapi: 'POST /products'
+---

package/dist/api-reference/operations/delete.mdx

@@ -0,0 +1,5 @@
+---
+title: 'DELETE /products/{id}'
+description: 'Delete a product'
+openapi: 'DELETE /products/{id}'
+---

package/dist/api-reference/operations/get.mdx

@@ -0,0 +1,5 @@
+---
+title: 'GET /products'
+description: 'Get a list of products'
+openapi: 'GET /products'
+---

package/dist/api-reference/operations/update.mdx

@@ -0,0 +1,5 @@
+---
+title: 'PUT /products/{id}'
+description: 'Update a product'
+openapi: 'PUT /products/{id}'
+---

package/dist/api-reference/websocket-operations/receive-chat-message.mdx

@@ -0,0 +1,5 @@
+---
+title: 'SUBSCRIBE /chat'
+description: 'Subscribe to receive chat messages from other users'
+asyncapi: 'subscribe /chat'
+---

package/dist/api-reference/websocket-operations/receive-notifications.mdx

@@ -0,0 +1,5 @@
+---
+title: 'SUBSCRIBE /notifications'
+description: 'Subscribe to receive system notifications'
+asyncapi: 'subscribe /notifications'
+---

package/dist/api-reference/websocket-operations/receive-presence-update.mdx

@@ -0,0 +1,5 @@
+---
+title: 'SUBSCRIBE /presence'
+description: 'Subscribe to receive user presence updates'
+asyncapi: 'subscribe /presence'
+---

package/dist/api-reference/websocket-operations/send-chat-message.mdx

@@ -0,0 +1,5 @@
+---
+title: 'PUBLISH /chat'
+description: 'Send a chat message to other users'
+asyncapi: 'publish /chat'
+---

package/dist/api-reference/websocket-operations/send-presence-update.mdx

@@ -0,0 +1,5 @@
+---
+title: 'PUBLISH /presence'
+description: 'Send a presence update'
+asyncapi: 'publish /presence'
+---

package/dist/dory.json

@@ -0,0 +1,64 @@
+{
+  "name": "Docucod",
+  "favicon": "./favicon.svg",
+  "colors": {
+    "primary": "#0ea5e9",
+    "light": "#0C8BC6",
+    "dark": "#0284c7"
+  },
+  "fonts": {
+    "family": "Montserrat",
+    "source": "https://fonts.gstatic.com/s/googlesansflex/v5/t5sJIQcYNIWbFgDgAAzZ34auoVyXkJCOvp3SFWJbN5hF8Ju1x6sKCyp0l9sI40swNJwGpVd4AZzz0v6lJ4qFXNZhGjLvDSkV4USKMo6qQzwliVdHAy9jxTDHg_ugnAakpwGc-cxgUqDCIUI.woff2",
+    "format": "woff2"
+  },
+  "navigation": {
+    "tabs": [
+      {
+        "tab": "Documentation",
+        "groups": [
+          {
+            "group": "Getting Started",
+            "pages": [
+              "introduction"
+            ]
+          },
+          {
+            "group": "Features",
+            "pages": [
+              "features"
+            ]
+          },
+          {
+            "group": "Playground",
+            "pages": [
+              "websocket-playground-demo"
+            ]
+          },
+          {
+            "group": "API Reference",
+            "pages": [
+              "api-reference/operations/create",
+              "api-reference/operations/get",
+              "api-reference/operations/update",
+              "api-reference/operations/delete"
+            ]
+          },
+          {
+            "group": "WebSocket API Reference",
+            "pages": [
+              "api-reference/websocket-operations/send-chat-message",
+              "api-reference/websocket-operations/receive-chat-message",
+              "api-reference/websocket-operations/receive-notifications",
+              "api-reference/websocket-operations/send-presence-update",
+              "api-reference/websocket-operations/receive-presence-update"
+            ]
+          }
+        ]
+      }
+    ]
+  },
+  "logo": {
+    "light": "./logo/logo.svg",
+    "dark": "./logo/logo.svg"
+  }
+}