@unispechq/unispec-schema 0.4.2 → 0.4.3

package/examples/valid/spec/graphql-simple.json

@@ -0,0 +1,48 @@
+{
+  "unispecVersion": "1.0.0",
+  "service": {
+    "name": "blog-service",
+    "description": "A blog service with GraphQL API",
+    "version": "1.0.0",
+    "baseUrl": "https://blog.example.com",
+    "protocols": {
+      "graphql": {
+        "url": "/graphql",
+        "schema": "type User { id: ID! username: String! email: String! posts: [Post!]! } type Post { id: ID! title: String! content: String! author: User! createdAt: String! } type Query { user(id: ID!): User posts: [Post!]! } type Mutation { createPost(title: String!, content: String!): Post! }",
+        "queries": [
+          {
+            "name": "user",
+            "description": "Get user by ID",
+            "args": [
+              {
+                "name": "id",
+                "type": "ID!",
+                "description": "User ID"
+              }
+            ],
+            "returnType": "User"
+          }
+        ],
+        "mutations": [
+          {
+            "name": "createPost",
+            "description": "Create a new post",
+            "args": [
+              {
+                "name": "title",
+                "type": "String!",
+                "description": "Post title"
+              },
+              {
+                "name": "content",
+                "type": "String!",
+                "description": "Post content"
+              }
+            ],
+            "returnType": "Post!"
+          }
+        ]
+      }
+    }
+  }
+}

package/examples/valid/spec/mixed-complete.json

@@ -0,0 +1,163 @@
+{
+  "unispecVersion": "1.0.0",
+  "service": {
+    "name": "ecommerce-service",
+    "description": "A complete e-commerce service with multiple protocols",
+    "version": "2.1.0",
+    "baseUrl": "https://api.ecommerce.com",
+    "contact": {
+      "name": "API Team",
+      "email": "api@ecommerce.com"
+    },
+    "license": {
+      "name": "Apache 2.0",
+      "url": "https://opensource.org/licenses/Apache-2.0"
+    },
+    "tags": [
+      "ecommerce",
+      "rest",
+      "graphql",
+      "websocket"
+    ],
+    "protocols": {
+      "rest": {
+        "routes": [
+          {
+            "name": "getProducts",
+            "summary": "Get all products",
+            "path": "/products",
+            "method": "GET",
+            "responses": {
+              "200": {
+                "description": "Products retrieved successfully"
+              }
+            }
+          },
+          {
+            "name": "createOrder",
+            "summary": "Create new order",
+            "path": "/orders",
+            "method": "POST",
+            "requestBody": {
+              "required": true,
+              "content": {
+                "application/json": {
+                  "schemaRef": "CreateOrderRequest"
+                }
+              }
+            },
+            "responses": {
+              "201": {
+                "description": "Order created successfully"
+              }
+            }
+          }
+        ]
+      },
+      "graphql": {
+        "url": "/graphql",
+        "schema": "type Product { id: ID! name: String! price: Float! } type Order { id: ID! products: [Product!]! total: Float! } type Query { products: [Product!]! order(id: ID!): Order }",
+        "queries": [
+          {
+            "name": "products",
+            "description": "Get all products",
+            "returnType": "[Product!]!"
+          }
+        ],
+        "mutations": [
+          {
+            "name": "createOrder",
+            "description": "Create a new order",
+            "args": [
+              {
+                "name": "productIds",
+                "type": "[ID!]!"
+              }
+            ],
+            "returnType": "Order!"
+          }
+        ]
+      },
+      "websocket": {
+        "url": "/ws",
+        "channels": [
+          {
+            "name": "orderUpdates",
+            "description": "Real-time order updates",
+            "direction": "subscribe",
+            "messages": [
+              {
+                "name": "orderStatusUpdate",
+                "description": "Order status update",
+                "schemaRef": "OrderStatusUpdate"
+              }
+            ]
+          }
+        ]
+      }
+    },
+    "schemas": {
+      "CreateOrderRequest": {
+        "description": "Request to create an order",
+        "jsonSchema": {
+          "type": "object",
+          "properties": {
+            "productIds": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "customerId": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "productIds",
+            "customerId"
+          ]
+        }
+      },
+      "OrderStatusUpdate": {
+        "description": "Order status update message",
+        "jsonSchema": {
+          "type": "object",
+          "properties": {
+            "orderId": {
+              "type": "string"
+            },
+            "status": {
+              "type": "string",
+              "enum": [
+                "pending",
+                "processing",
+                "shipped",
+                "delivered"
+              ]
+            },
+            "timestamp": {
+              "type": "string",
+              "format": "date-time"
+            }
+          },
+          "required": [
+            "orderId",
+            "status",
+            "timestamp"
+          ]
+        }
+      }
+    },
+    "securitySchemes": {
+      "bearerAuth": {
+        "type": "http",
+        "scheme": "bearer",
+        "bearerFormat": "JWT"
+      }
+    },
+    "rateLimit": {
+      "requestsPerMinute": 100,
+      "perUser": true
+    }
+  }
+}

package/examples/valid/spec/rest-simple.json

@@ -0,0 +1,45 @@
+{
+  "unispecVersion": "1.0.0",
+  "service": {
+    "name": "user-service",
+    "description": "A simple user management service with REST API",
+    "version": "1.2.3",
+    "baseUrl": "https://api.example.com",
+    "protocols": {
+      "rest": {
+        "routes": [
+          {
+            "name": "getUsers",
+            "summary": "Get all users",
+            "path": "/users",
+            "method": "GET",
+            "responses": {
+              "200": {
+                "description": "List of users retrieved successfully"
+              }
+            }
+          },
+          {
+            "name": "createUser",
+            "summary": "Create a new user",
+            "path": "/users",
+            "method": "POST",
+            "requestBody": {
+              "required": true,
+              "content": {
+                "application/json": {
+                  "schemaRef": "CreateUserRequest"
+                }
+              }
+            },
+            "responses": {
+              "201": {
+                "description": "User created successfully"
+              }
+            }
+          }
+        ]
+      }
+    }
+  }
+}

package/examples/valid/spec/websocket-simple.json

@@ -0,0 +1,71 @@
+{
+  "unispecVersion": "1.0.0",
+  "service": {
+    "name": "chat-service",
+    "description": "A chat service with WebSocket API",
+    "version": "1.0.0",
+    "baseUrl": "https://chat.example.com",
+    "protocols": {
+      "websocket": {
+        "url": "/ws",
+        "channels": [
+          {
+            "name": "messages",
+            "description": "Chat messages channel",
+            "namespace": "chat",
+            "direction": "both",
+            "messages": [
+              {
+                "name": "sendMessage",
+                "description": "Send a message",
+                "direction": "publish",
+                "schemaRef": "ChatMessage"
+              },
+              {
+                "name": "receiveMessage",
+                "description": "Receive a message",
+                "direction": "subscribe",
+                "schemaRef": "ChatMessage"
+              }
+            ]
+          }
+        ]
+      }
+    },
+    "schemas": {
+      "ChatMessage": {
+        "description": "Chat message",
+        "jsonSchema": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "string",
+              "format": "uuid"
+            },
+            "userId": {
+              "type": "string",
+              "format": "uuid"
+            },
+            "username": {
+              "type": "string"
+            },
+            "message": {
+              "type": "string"
+            },
+            "timestamp": {
+              "type": "string",
+              "format": "date-time"
+            }
+          },
+          "required": [
+            "id",
+            "userId",
+            "username",
+            "message",
+            "timestamp"
+          ]
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@unispechq/unispec-schema",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "description": "Official UniSpec JSON Schemas",
   "type": "module",
   "main": "index.cjs",
   "module": "index.mjs",
   "types": "index.d.ts",
   "scripts": {
-    "lint": "pnpm run biome check --write --unsafe",
+    "lint": "biome check --write --unsafe",
     "release:patch": "node scripts/release.js patch",
     "release:minor": "node scripts/release.js minor",
     "release:major": "node scripts/release.js major"

package/examples/invalid/config/additional-properties.json

@@ -1,26 +0,0 @@
-{
-	"unispecVersion": "0.1.0",
-	"service": {
-		"name": "config-api",
-		"description": "API with additional properties",
-		"invalidProperty": "should not exist",
-		"protocols": {
-			"rest": {
-				"routes": [
-					{
-						"name": "getUsers",
-						"path": "/users",
-						"method": "GET",
-						"responses": {
-							"200": {
-								"description": "Success",
-								"invalidProperty": "should not exist"
-							}
-						}
-					}
-				],
-				"invalidProperty": "should not exist"
-			}
-		}
-	}
-}

package/examples/invalid/graphql-additional-properties.json

@@ -1,22 +0,0 @@
-{
-	"unispecVersion": "0.1.0",
-	"service": {
-		"name": "invalid-graphql-api",
-		"description": "GraphQL API with additional properties",
-		"protocols": {
-			"graphql": {
-				"url": "/graphql",
-				"schema": "type Query {\n  users: [User!]!\n}\n\ntype User {\n  id: ID!\n  name: String!\n}\n",
-				"queries": [
-					{
-						"name": "users",
-						"description": "Get users",
-						"returnType": "[User!]!",
-						"invalidProperty": "should not exist"
-					}
-				],
-				"invalidProperty": "should not exist"
-			}
-		}
-	}
-}

package/examples/invalid/graphql-missing-arg-type.json

@@ -1,26 +0,0 @@
-{
-	"unispecVersion": "0.1.0",
-	"service": {
-		"name": "invalid-graphql-api",
-		"description": "GraphQL API with missing argument type",
-		"protocols": {
-			"graphql": {
-				"url": "/graphql",
-				"schema": "type Query {\n  users(limit: Int): [User!]!\n}\n\ntype User {\n  id: ID!\n  name: String!\n}\n",
-				"queries": [
-					{
-						"name": "users",
-						"description": "Get users",
-						"args": [
-							{
-								"name": "limit",
-								"description": "Limit number of results"
-							}
-						],
-						"returnType": "[User!]!"
-					}
-				]
-			}
-		}
-	}
-}

package/examples/invalid/graphql-missing-name.json

@@ -1,19 +0,0 @@
-{
-	"unispecVersion": "0.1.0",
-	"service": {
-		"name": "invalid-graphql-api",
-		"description": "GraphQL API with missing operation name",
-		"protocols": {
-			"graphql": {
-				"url": "/graphql",
-				"schema": "type Query {\n  users: [User!]!\n}\n\ntype User {\n  id: ID!\n  name: String!\n}\n",
-				"queries": [
-					{
-						"description": "Get users",
-						"returnType": "[User!]!"
-					}
-				]
-			}
-		}
-	}
-}

package/examples/invalid/graphql-missing-schema.json

@@ -1,19 +0,0 @@
-{
-	"unispecVersion": "0.1.0",
-	"service": {
-		"name": "invalid-graphql-api",
-		"description": "GraphQL API missing required schema field",
-		"protocols": {
-			"graphql": {
-				"url": "/graphql",
-				"queries": [
-					{
-						"name": "users",
-						"description": "Get users",
-						"returnType": "[User!]!"
-					}
-				]
-			}
-		}
-	}
-}

package/examples/invalid/mixed-invalid-protocol.json

@@ -1,26 +0,0 @@
-{
-	"unispecVersion": "0.1.0",
-	"service": {
-		"name": "invalid-mixed-api",
-		"description": "Mixed protocol API with invalid protocol",
-		"protocols": {
-			"rest": {
-				"routes": [
-					{
-						"name": "getUsers",
-						"path": "/users",
-						"method": "GET",
-						"responses": {
-							"200": {
-								"description": "Success"
-							}
-						}
-					}
-				]
-			},
-			"invalidProtocol": {
-				"someProperty": "value"
-			}
-		}
-	}
-}

package/examples/invalid/mixed-missing-graphql-schema.json

@@ -1,33 +0,0 @@
-{
-	"unispecVersion": "0.1.0",
-	"service": {
-		"name": "invalid-mixed-api",
-		"description": "Mixed protocol API missing GraphQL schema",
-		"protocols": {
-			"rest": {
-				"routes": [
-					{
-						"name": "getUsers",
-						"path": "/users",
-						"method": "GET",
-						"responses": {
-							"200": {
-								"description": "Success"
-							}
-						}
-					}
-				]
-			},
-			"graphql": {
-				"url": "/graphql",
-				"queries": [
-					{
-						"name": "users",
-						"description": "Get users",
-						"returnType": "[User!]!"
-					}
-				]
-			}
-		}
-	}
-}

package/examples/invalid/mixed-multiple-errors.json

@@ -1,41 +0,0 @@
-{
-	"unispecVersion": "0.1.0",
-	"service": {
-		"description": "API with multiple errors",
-		"protocols": {
-			"rest": {
-				"routes": [
-					{
-						"name": "",
-						"method": "INVALID",
-						"responses": {
-							"200": {
-								"description": "Success"
-							}
-						}
-					}
-				]
-			},
-			"graphql": {
-				"queries": [
-					{
-						"description": "Missing name",
-						"returnType": "[User!]!"
-					}
-				]
-			},
-			"websocket": {
-				"channels": [
-					{
-						"messages": [
-							{
-								"description": "Missing name",
-								"direction": "invalid"
-							}
-						]
-					}
-				]
-			}
-		}
-	}
-}

package/examples/invalid/rest-additional-properties.json

@@ -1,25 +0,0 @@
-{
-	"unispecVersion": "0.1.0",
-	"service": {
-		"name": "extra-props-api",
-		"description": "API with additional properties",
-		"protocols": {
-			"rest": {
-				"routes": [
-					{
-						"name": "getUsers",
-						"path": "/users",
-						"method": "GET",
-						"invalidProperty": "should not exist",
-						"responses": {
-							"200": {
-								"description": "Success",
-								"invalidProperty": "should not exist"
-							}
-						}
-					}
-				]
-			}
-		}
-	}
-}

package/examples/invalid/rest-invalid-identifiers.json

@@ -1,29 +0,0 @@
-{
-	"unispecVersion": "0.1.0",
-	"service": {
-		"name": "invalid-name-with-spaces",
-		"description": "API with invalid service name",
-		"protocols": {
-			"rest": {
-				"routes": [
-					{
-						"name": "route with spaces",
-						"path": "/test",
-						"method": "GET",
-						"queryParams": [
-							{
-								"name": "param with spaces",
-								"required": false
-							}
-						],
-						"responses": {
-							"200": {
-								"description": "Success"
-							}
-						}
-					}
-				]
-			}
-		}
-	}
-}

package/examples/invalid/rest-invalid-method.json

@@ -1,23 +0,0 @@
-{
-	"unispecVersion": "0.1.0",
-	"service": {
-		"name": "invalid-method-api",
-		"description": "API with invalid HTTP method",
-		"protocols": {
-			"rest": {
-				"routes": [
-					{
-						"name": "invalidMethod",
-						"path": "/test",
-						"method": "INVALID",
-						"responses": {
-							"200": {
-								"description": "Success"
-							}
-						}
-					}
-				]
-			}
-		}
-	}
-}

package/examples/invalid/rest-missing-required.json

@@ -1,21 +0,0 @@
-{
-	"unispecVersion": "0.1.0",
-	"service": {
-		"description": "API with missing required fields",
-		"protocols": {
-			"rest": {
-				"routes": [
-					{
-						"name": "getUsers",
-						"method": "GET",
-						"responses": {
-							"200": {
-								"description": "Success"
-							}
-						}
-					}
-				]
-			}
-		}
-	}
-}