@unispechq/unispec-schema 0.4.0 → 0.4.2

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

@@ -0,0 +1,41 @@
+{
+	"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

@@ -0,0 +1,25 @@
+{
+	"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

@@ -0,0 +1,29 @@
+{
+	"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

@@ -0,0 +1,23 @@
+{
+	"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

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

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

@@ -0,0 +1,27 @@
+{
+	"unispecVersion": "0.1.0",
+	"service": {
+		"name": "invalid-websocket-api",
+		"description": "WebSocket API with additional properties",
+		"protocols": {
+			"websocket": {
+				"url": "/ws",
+				"channels": [
+					{
+						"name": "notifications",
+						"description": "Notification channel",
+						"invalidProperty": "should not exist",
+						"messages": [
+							{
+								"name": "message",
+								"description": "Message",
+								"invalidProperty": "should not exist",
+								"schemaRef": "Message"
+							}
+						]
+					}
+				]
+			}
+		}
+	}
+}

package/examples/invalid/websocket-invalid-direction.json

@@ -0,0 +1,27 @@
+{
+	"unispecVersion": "0.1.0",
+	"service": {
+		"name": "invalid-websocket-api",
+		"description": "WebSocket API with invalid direction",
+		"protocols": {
+			"websocket": {
+				"url": "/ws",
+				"channels": [
+					{
+						"name": "invalid-channel",
+						"description": "Channel with invalid direction",
+						"direction": "invalid",
+						"messages": [
+							{
+								"name": "message",
+								"description": "Message with invalid direction",
+								"direction": "invalid",
+								"schemaRef": "Message"
+							}
+						]
+					}
+				]
+			}
+		}
+	}
+}

package/examples/invalid/websocket-missing-channel-name.json

@@ -0,0 +1,25 @@
+{
+	"unispecVersion": "0.1.0",
+	"service": {
+		"name": "invalid-websocket-api",
+		"description": "WebSocket API with invalid channel",
+		"protocols": {
+			"websocket": {
+				"url": "/ws",
+				"channels": [
+					{
+						"description": "Channel without name",
+						"direction": "both",
+						"messages": [
+							{
+								"name": "message",
+								"direction": "both",
+								"schemaRef": "Message"
+							}
+						]
+					}
+				]
+			}
+		}
+	}
+}

package/examples/invalid/websocket-missing-message-name.json

@@ -0,0 +1,25 @@
+{
+	"unispecVersion": "0.1.0",
+	"service": {
+		"name": "invalid-websocket-api",
+		"description": "WebSocket API with invalid message",
+		"protocols": {
+			"websocket": {
+				"url": "/ws",
+				"channels": [
+					{
+						"name": "notifications",
+						"description": "Notification channel",
+						"messages": [
+							{
+								"description": "Message without name",
+								"direction": "subscribe",
+								"schemaRef": "Notification"
+							}
+						]
+					}
+				]
+			}
+		}
+	}
+}

package/examples/valid/config/complete.json

@@ -0,0 +1,61 @@
+{
+	"unispecVersion": "0.1.0",
+	"service": {
+		"name": "complete-service",
+		"description": "Complete configuration with multiple services",
+		"version": "1.0.0",
+		"baseUrl": "https://api.example.com",
+		"servers": [
+			{
+				"url": "https://staging-api.example.com",
+				"description": "Staging environment"
+			},
+			{
+				"url": "https://prod-api.example.com",
+				"description": "Production environment"
+			}
+		],
+		"contact": {
+			"name": "API Support",
+			"email": "support@example.com"
+		},
+		"license": {
+			"name": "MIT",
+			"url": "https://opensource.org/licenses/MIT"
+		},
+		"protocols": {
+			"rest": {
+				"routes": [
+					{
+						"name": "getUsers",
+						"summary": "List all users",
+						"path": "/users",
+						"method": "GET",
+						"responses": {
+							"200": {
+								"description": "List of users"
+							}
+						}
+					}
+				]
+			},
+			"graphql": {
+				"url": "/graphql",
+				"schema": "type Query {\n  users: [User!]!\n}\n\ntype User {\n  id: ID!\n  name: String!\n}\n"
+			}
+		},
+		"schemas": {
+			"User": {
+				"type": "object",
+				"properties": {
+					"id": {
+						"type": "string"
+					},
+					"name": {
+						"type": "string"
+					}
+				}
+			}
+		}
+	}
+}

package/examples/valid/config/minimal.json

@@ -0,0 +1,8 @@
+{
+	"unispecVersion": "0.1.0",
+	"service": {
+		"name": "minimal-service",
+		"description": "Minimal configuration with single service",
+		"version": "1.0.0"
+	}
+}

package/examples/valid/graphql-complete.json

@@ -0,0 +1,348 @@
+{
+	"unispecVersion": "0.1.0",
+	"service": {
+		"name": "user-graphql-api",
+		"description": "Complete user management GraphQL API",
+		"version": "1.0.0",
+		"baseUrl": "https://api.example.com",
+		"contact": {
+			"name": "GraphQL Support",
+			"email": "graphql@example.com"
+		},
+		"tags": ["users", "graphql", "authentication"],
+		"securitySchemes": {
+			"bearerAuth": {
+				"type": "http",
+				"scheme": "bearer",
+				"bearerFormat": "JWT",
+				"description": "JWT authentication token"
+			}
+		},
+		"protocols": {
+			"graphql": {
+				"url": "/graphql",
+				"schema": "type User {\n  id: ID!\n  email: String!\n  firstName: String!\n  lastName: String!\n  phone: String\n  createdAt: String!\n  updatedAt: String!\n  posts: [Post!]!\n}\n\ntype Post {\n  id: ID!\n  title: String!\n  content: String!\n  author: User!\n  category: String!\n  tags: [String!]!\n  published: Boolean!\n  createdAt: String!\n  updatedAt: String!\n}\n\ntype AuthPayload {\n  token: String!\n  user: User!\n}\n\ntype Query {\n  users(page: Int = 1, limit: Int = 20, search: String): UserConnection!\n  user(id: ID!): User\n  posts(category: String, published: Boolean = true, authorId: ID): PostConnection!\n  post(id: ID!): Post\n  me: User\n}\n\ntype Mutation {\n  createUser(input: CreateUserInput!): User!\n  updateUser(id: ID!, input: UpdateUserInput!): User!\n  deleteUser(id: ID!): Boolean!\n  createPost(input: CreatePostInput!): Post!\n  updatePost(id: ID!, input: UpdatePostInput!): Post!\n  deletePost(id: ID!): Boolean!\n  login(email: String!, password: String!): AuthPayload!\n  logout: Boolean!\n}\n\ntype Subscription {\n  userCreated: User!\n  userUpdated(id: ID): User!\n  postCreated(authorId: ID): Post!\n  postUpdated(id: ID): Post!\n}\n\ntype UserConnection {\n  users: [User!]!\n  pageInfo: PageInfo!\n  totalCount: Int!\n}\n\ntype PostConnection {\n  posts: [Post!]!\n  pageInfo: PageInfo!\n  totalCount: Int!\n}\n\ntype PageInfo {\n  hasNextPage: Boolean!\n  hasPreviousPage: Boolean!\n  startCursor: String\n  endCursor: String\n}\n\ninput CreateUserInput {\n  email: String!\n  password: String!\n  firstName: String!\n  lastName: String!\n  phone: String\n}\n\ninput UpdateUserInput {\n  firstName: String\n  lastName: String\n  phone: String\n}\n\ninput CreatePostInput {\n  title: String!\n  content: String!\n  category: String!\n  tags: [String!]\n  published: Boolean = false\n}\n\ninput UpdatePostInput {\n  title: String\n  content: String\n  category: String\n  tags: [String!]\n  published: Boolean\n}\n",
+				"headers": [
+					{
+						"name": "Authorization",
+						"description": "Bearer token for authentication",
+						"required": true
+					},
+					{
+						"name": "Content-Type",
+						"description": "Request content type",
+						"defaultValue": "application/json"
+					}
+				],
+				"queries": [
+					{
+						"name": "users",
+						"description": "Get paginated list of users",
+						"args": [
+							{
+								"name": "page",
+								"type": "Int",
+								"description": "Page number for pagination",
+								"defaultValue": 1
+							},
+							{
+								"name": "limit",
+								"type": "Int",
+								"description": "Number of items per page",
+								"defaultValue": 20
+							},
+							{
+								"name": "search",
+								"type": "String",
+								"description": "Search term for filtering users"
+							}
+						],
+						"returnType": "UserConnection!",
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						]
+					},
+					{
+						"name": "user",
+						"description": "Get user by ID",
+						"args": [
+							{
+								"name": "id",
+								"type": "ID!",
+								"description": "User ID"
+							}
+						],
+						"returnType": "User!",
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						]
+					},
+					{
+						"name": "posts",
+						"description": "Get paginated list of posts",
+						"args": [
+							{
+								"name": "category",
+								"type": "String",
+								"description": "Filter by category"
+							},
+							{
+								"name": "published",
+								"type": "Boolean",
+								"description": "Filter by published status",
+								"defaultValue": true
+							},
+							{
+								"name": "authorId",
+								"type": "ID",
+								"description": "Filter by author ID"
+							}
+						],
+						"returnType": "PostConnection!",
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						]
+					},
+					{
+						"name": "post",
+						"description": "Get post by ID",
+						"args": [
+							{
+								"name": "id",
+								"type": "ID!",
+								"description": "Post ID"
+							}
+						],
+						"returnType": "Post!",
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						]
+					},
+					{
+						"name": "me",
+						"description": "Get current authenticated user",
+						"returnType": "User!",
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						]
+					}
+				],
+				"mutations": [
+					{
+						"name": "createUser",
+						"description": "Create a new user",
+						"args": [
+							{
+								"name": "input",
+								"type": "CreateUserInput!",
+								"description": "User data for creation"
+							}
+						],
+						"returnType": "User!",
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						]
+					},
+					{
+						"name": "updateUser",
+						"description": "Update an existing user",
+						"args": [
+							{
+								"name": "id",
+								"type": "ID!",
+								"description": "User ID"
+							},
+							{
+								"name": "input",
+								"type": "UpdateUserInput!",
+								"description": "Updated user data"
+							}
+						],
+						"returnType": "User!",
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						]
+					},
+					{
+						"name": "deleteUser",
+						"description": "Delete a user",
+						"args": [
+							{
+								"name": "id",
+								"type": "ID!",
+								"description": "User ID"
+							}
+						],
+						"returnType": "Boolean!",
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						]
+					},
+					{
+						"name": "createPost",
+						"description": "Create a new post",
+						"args": [
+							{
+								"name": "input",
+								"type": "CreatePostInput!",
+								"description": "Post data for creation"
+							}
+						],
+						"returnType": "Post!",
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						]
+					},
+					{
+						"name": "updatePost",
+						"description": "Update an existing post",
+						"args": [
+							{
+								"name": "id",
+								"type": "ID!",
+								"description": "Post ID"
+							},
+							{
+								"name": "input",
+								"type": "UpdatePostInput!",
+								"description": "Updated post data"
+							}
+						],
+						"returnType": "Post!",
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						]
+					},
+					{
+						"name": "deletePost",
+						"description": "Delete a post",
+						"args": [
+							{
+								"name": "id",
+								"type": "ID!",
+								"description": "Post ID"
+							}
+						],
+						"returnType": "Boolean!",
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						]
+					},
+					{
+						"name": "login",
+						"description": "Authenticate user and return JWT token",
+						"args": [
+							{
+								"name": "email",
+								"type": "String!",
+								"description": "User email address"
+							},
+							{
+								"name": "password",
+								"type": "String!",
+								"description": "User password"
+							}
+						],
+						"returnType": "AuthPayload!",
+						"security": []
+					},
+					{
+						"name": "logout",
+						"description": "Logout user",
+						"returnType": "Boolean!",
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						]
+					}
+				],
+				"subscriptions": [
+					{
+						"name": "userCreated",
+						"description": "Subscribe to new user creation events",
+						"returnType": "User!",
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						]
+					},
+					{
+						"name": "userUpdated",
+						"description": "Subscribe to user update events",
+						"args": [
+							{
+								"name": "id",
+								"type": "ID",
+								"description": "Filter by specific user ID"
+							}
+						],
+						"returnType": "User!",
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						]
+					},
+					{
+						"name": "postCreated",
+						"description": "Subscribe to new post creation events",
+						"args": [
+							{
+								"name": "authorId",
+								"type": "ID",
+								"description": "Filter by author ID"
+							}
+						],
+						"returnType": "Post!",
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						]
+					},
+					{
+						"name": "postUpdated",
+						"description": "Subscribe to post update events",
+						"args": [
+							{
+								"name": "id",
+								"type": "ID",
+								"description": "Filter by specific post ID"
+							}
+						],
+						"returnType": "Post!",
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						]
+					}
+				]
+			}
+		}
+	}
+}