@unispechq/unispec-schema 0.4.0 → 0.4.2

package/examples/valid/mixed-complete.json

@@ -0,0 +1,799 @@
+{
+	"unispecVersion": "0.1.0",
+	"service": {
+		"name": "social-media-platform",
+		"description": "Complete social media platform with REST, GraphQL, and WebSocket protocols",
+		"version": "2.0.0",
+		"baseUrl": "https://api.social.example.com",
+		"contact": {
+			"name": "Platform Support",
+			"email": "support@social.example.com",
+			"url": "https://social.example.com/support"
+		},
+		"license": {
+			"name": "MIT",
+			"url": "https://opensource.org/licenses/MIT"
+		},
+		"tags": ["social", "media", "platform", "multi-protocol"],
+		"servers": [
+			{
+				"url": "https://api.social.example.com",
+				"description": "Production API server"
+			},
+			{
+				"url": "https://staging-api.social.example.com",
+				"description": "Staging API server"
+			}
+		],
+		"securitySchemes": {
+			"bearerAuth": {
+				"type": "http",
+				"scheme": "bearer",
+				"bearerFormat": "JWT",
+				"description": "JWT authentication for all protocols"
+			},
+			"apiKeyAuth": {
+				"type": "apiKey",
+				"name": "X-API-Key",
+				"in": "header",
+				"description": "API key for server-to-server communication"
+			}
+		},
+		"rateLimit": {
+			"requestsPerMinute": 1000,
+			"requestsPerHour": 50000,
+			"perUser": true,
+			"perApiKey": true
+		},
+		"compliance": ["GDPR", "SOC2"],
+		"dataClassification": "confidential",
+		"protocols": {
+			"rest": {
+				"headers": [
+					{
+						"name": "Content-Type",
+						"description": "Request content type",
+						"required": true
+					},
+					{
+						"name": "Accept",
+						"description": "Response content type",
+						"required": true
+					}
+				],
+				"routes": [
+					{
+						"name": "uploadMedia",
+						"summary": "Upload media file",
+						"tags": ["media"],
+						"description": "Upload images, videos, and other media files",
+						"path": "/media/upload",
+						"method": "POST",
+						"requestBody": {
+							"description": "Media file and metadata",
+							"required": true,
+							"content": {
+								"multipart/form-data": {
+									"schemaRef": "MediaUploadRequest"
+								}
+							}
+						},
+						"responses": {
+							"201": {
+								"description": "Media uploaded successfully",
+								"content": {
+									"application/json": {
+										"schemaRef": "MediaResponse"
+									}
+								}
+							},
+							"400": {
+								"description": "Invalid file format or size",
+								"content": {
+									"application/json": {
+										"schemaRef": "ErrorResponse"
+									}
+								}
+							},
+							"413": {
+								"description": "File too large",
+								"content": {
+									"application/json": {
+										"schemaRef": "ErrorResponse"
+									}
+								}
+							}
+						},
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						]
+					},
+					{
+						"name": "getMedia",
+						"summary": "Get media by ID",
+						"tags": ["media"],
+						"description": "Retrieve media file and metadata",
+						"path": "/media/{id}",
+						"method": "GET",
+						"pathParams": [
+							{
+								"name": "id",
+								"description": "Media ID",
+								"required": true,
+								"schemaRef": "MediaId"
+							}
+						],
+						"responses": {
+							"200": {
+								"description": "Media file and metadata",
+								"content": {
+									"application/json": {
+										"schemaRef": "MediaResponse"
+									}
+								}
+							},
+							"404": {
+								"description": "Media not found",
+								"content": {
+									"application/json": {
+										"schemaRef": "ErrorResponse"
+									}
+								}
+							}
+						},
+						"security": [
+							{
+								"bearerAuth": []
+							},
+							{
+								"apiKeyAuth": []
+							}
+						]
+					},
+					{
+						"name": "deleteMedia",
+						"summary": "Delete media",
+						"tags": ["media"],
+						"description": "Delete media file",
+						"path": "/media/{id}",
+						"method": "DELETE",
+						"pathParams": [
+							{
+								"name": "id",
+								"description": "Media ID",
+								"required": true,
+								"schemaRef": "MediaId"
+							}
+						],
+						"responses": {
+							"204": {
+								"description": "Media deleted successfully"
+							},
+							"404": {
+								"description": "Media not found",
+								"content": {
+									"application/json": {
+										"schemaRef": "ErrorResponse"
+									}
+								}
+							}
+						},
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						]
+					}
+				]
+			},
+			"graphql": {
+				"url": "/graphql",
+				"schema": "type User {\n  id: ID!\n  username: String!\n  email: String!\n  profile: UserProfile!\n  posts: [Post!]!\n  followers: [User!]!\n  following: [User!]!\n  createdAt: String!\n  updatedAt: String!\n}\n\ntype UserProfile {\n  displayName: String!\n  bio: String\n  avatar: String\n  location: String\n  website: String\n  birthDate: String\n}\n\ntype Post {\n  id: ID!\n  author: User!\n  content: String!\n  media: [Media!]!\n  likes: [User!]!\n  comments: [Comment!]!\n  tags: [String!]!\n  visibility: PostVisibility!\n  createdAt: String!\n  updatedAt: String!\n}\n\ntype Media {\n  id: ID!\n  url: String!\n  type: MediaType!\n  width: Int\n  height: Int\n  size: Int!\n  alt: String\n}\n\ntype Comment {\n  id: ID!\n  author: User!\n  post: Post!\n  content: String!\n  likes: [User!]!\n  createdAt: String!\n  updatedAt: String!\n}\n\nenum PostVisibility {\n  PUBLIC\n  FRIENDS\n  PRIVATE\n}\n\nenum MediaType {\n  IMAGE\n  VIDEO\n  AUDIO\n  DOCUMENT\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!, username: String): User\n  me: User\n  posts(page: Int = 1, limit: Int = 20, authorId: ID, tags: [String!]): PostConnection!\n  post(id: ID!): Post\n  feed(page: Int = 1, limit: Int = 20): PostConnection!\n  trending: [Post!]!\n}\n\ntype Mutation {\n  createUser(input: CreateUserInput!): User!\n  updateUser(input: UpdateUserInput!): User!\n  createPost(input: CreatePostInput!): Post!\n  updatePost(id: ID!, input: UpdatePostInput!): Post!\n  deletePost(id: ID!): Boolean!\n  likePost(id: ID!): Post!\n  unlikePost(id: ID!): Post!\n  createComment(postId: ID!, content: String!): Comment!\n  deleteComment(id: ID!): Boolean!\n  followUser(userId: ID!): User!\n  unfollowUser(userId: ID!): User!\n  login(email: String!, password: String!): AuthPayload!\n  logout: Boolean!\n}\n\ntype Subscription {\n  postCreated(authorId: ID): Post!\n  postUpdated(postId: ID): Post!\n  postLiked(postId: ID): Post!\n  commentAdded(postId: ID): Comment!\n  userFollowed(userId: ID): User!\n  notificationReceived: Notification!\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\ntype Notification {\n  id: ID!\n  type: NotificationType!\n  user: User!\n  message: String!\n  data: JSON\n  read: Boolean!\n  createdAt: String!\n}\n\nenum NotificationType {\n  LIKE\n  COMMENT\n  FOLLOW\n  MENTION\n  POST\n}\n\nscalar JSON\n\ninput CreateUserInput {\n  username: String!\n  email: String!\n  password: String!\n  profile: UserProfileInput!\n}\n\ninput UpdateUserInput {\n  profile: UserProfileInput\n}\n\ninput UserProfileInput {\n  displayName: String\n  bio: String\n  avatar: String\n  location: String\n  website: String\n  birthDate: String\n}\n\ninput CreatePostInput {\n  content: String!\n  mediaIds: [ID!]\n  tags: [String!]\n  visibility: PostVisibility = PUBLIC\n}\n\ninput UpdatePostInput {\n  content: String\n  tags: [String!]\n  visibility: PostVisibility\n}\n",
+				"headers": [
+					{
+						"name": "Authorization",
+						"description": "Bearer token for authentication",
+						"required": true
+					}
+				],
+				"queries": [
+					{
+						"name": "users",
+						"description": "Get paginated list of users",
+						"args": [
+							{
+								"name": "page",
+								"type": "Int",
+								"description": "Page number",
+								"defaultValue": 1
+							},
+							{
+								"name": "limit",
+								"type": "Int",
+								"description": "Items per page",
+								"defaultValue": 20
+							},
+							{
+								"name": "search",
+								"type": "String",
+								"description": "Search term"
+							}
+						],
+						"returnType": "UserConnection!",
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						]
+					},
+					{
+						"name": "user",
+						"description": "Get user by ID or username",
+						"args": [
+							{
+								"name": "id",
+								"type": "ID",
+								"description": "User ID"
+							},
+							{
+								"name": "username",
+								"type": "String",
+								"description": "Username"
+							}
+						],
+						"returnType": "User",
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						]
+					},
+					{
+						"name": "posts",
+						"description": "Get paginated list of posts",
+						"args": [
+							{
+								"name": "page",
+								"type": "Int",
+								"description": "Page number",
+								"defaultValue": 1
+							},
+							{
+								"name": "limit",
+								"type": "Int",
+								"description": "Items per page",
+								"defaultValue": 20
+							},
+							{
+								"name": "authorId",
+								"type": "ID",
+								"description": "Filter by author"
+							},
+							{
+								"name": "tags",
+								"type": ["String!"],
+								"description": "Filter by tags"
+							}
+						],
+						"returnType": "PostConnection!",
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						]
+					},
+					{
+						"name": "feed",
+						"description": "Get personalized feed",
+						"args": [
+							{
+								"name": "page",
+								"type": "Int",
+								"description": "Page number",
+								"defaultValue": 1
+							},
+							{
+								"name": "limit",
+								"type": "Int",
+								"description": "Items per page",
+								"defaultValue": 20
+							}
+						],
+						"returnType": "PostConnection!",
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						]
+					}
+				],
+				"mutations": [
+					{
+						"name": "createPost",
+						"description": "Create a new post",
+						"args": [
+							{
+								"name": "input",
+								"type": "CreatePostInput!",
+								"description": "Post data"
+							}
+						],
+						"returnType": "Post!",
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						]
+					},
+					{
+						"name": "likePost",
+						"description": "Like a post",
+						"args": [
+							{
+								"name": "id",
+								"type": "ID!",
+								"description": "Post ID"
+							}
+						],
+						"returnType": "Post!",
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						]
+					},
+					{
+						"name": "followUser",
+						"description": "Follow a user",
+						"args": [
+							{
+								"name": "userId",
+								"type": "ID!",
+								"description": "User ID to follow"
+							}
+						],
+						"returnType": "User!",
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						]
+					}
+				],
+				"subscriptions": [
+					{
+						"name": "postCreated",
+						"description": "Subscribe to new posts",
+						"args": [
+							{
+								"name": "authorId",
+								"type": "ID",
+								"description": "Filter by author"
+							}
+						],
+						"returnType": "Post!",
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						]
+					},
+					{
+						"name": "notificationReceived",
+						"description": "Subscribe to notifications",
+						"returnType": "Notification!",
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						]
+					}
+				]
+			},
+			"websocket": {
+				"url": "/ws",
+				"headers": [
+					{
+						"name": "Authorization",
+						"description": "JWT token for WebSocket authentication",
+						"required": true
+					}
+				],
+				"channels": [
+					{
+						"name": "notifications",
+						"description": "Real-time notifications",
+						"namespace": "social",
+						"direction": "subscribe",
+						"tags": ["notifications", "real-time"],
+						"reconnectStrategy": {
+							"maxAttempts": 10,
+							"delay": 2000,
+							"backoffMultiplier": 1.5
+						},
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						],
+						"messages": [
+							{
+								"name": "newNotification",
+								"description": "New notification received",
+								"direction": "subscribe",
+								"schemaRef": "WebSocketNotification"
+							},
+							{
+								"name": "notificationRead",
+								"description": "Mark notification as read",
+								"direction": "publish",
+								"schemaRef": "NotificationReadEvent"
+							}
+						]
+					},
+					{
+						"name": "liveFeed",
+						"description": "Real-time feed updates",
+						"namespace": "social",
+						"direction": "subscribe",
+						"tags": ["feed", "posts", "real-time"],
+						"reconnectStrategy": {
+							"maxAttempts": 5,
+							"delay": 1000,
+							"backoffMultiplier": 2
+						},
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						],
+						"messages": [
+							{
+								"name": "newPost",
+								"description": "New post in feed",
+								"direction": "subscribe",
+								"schemaRef": "FeedPostEvent"
+							},
+							{
+								"name": "postUpdate",
+								"description": "Post updated in feed",
+								"direction": "subscribe",
+								"schemaRef": "FeedPostEvent"
+							},
+							{
+								"name": "postLike",
+								"description": "Post like notification",
+								"direction": "subscribe",
+								"schemaRef": "PostLikeEvent"
+							}
+						]
+					},
+					{
+						"name": "chat",
+						"description": "Real-time messaging",
+						"namespace": "messaging",
+						"direction": "both",
+						"tags": ["chat", "messaging", "real-time"],
+						"connectionParams": {
+							"userId": {
+								"description": "Current user ID"
+							}
+						},
+						"reconnectStrategy": {
+							"maxAttempts": 20,
+							"delay": 1000,
+							"backoffMultiplier": 1.2
+						},
+						"security": [
+							{
+								"bearerAuth": []
+							}
+						],
+						"messages": [
+							{
+								"name": "chatMessage",
+								"description": "Chat message",
+								"direction": "both",
+								"schemaRef": "ChatMessage"
+							},
+							{
+								"name": "typingIndicator",
+								"description": "User typing indicator",
+								"direction": "publish",
+								"schemaRef": "TypingIndicator"
+							},
+							{
+								"name": "userOnline",
+								"description": "User came online",
+								"direction": "subscribe",
+								"schemaRef": "UserPresenceEvent"
+							},
+							{
+								"name": "userOffline",
+								"description": "User went offline",
+								"direction": "subscribe",
+								"schemaRef": "UserPresenceEvent"
+							}
+						]
+					}
+				]
+			}
+		},
+		"schemas": {
+			"MediaId": {
+				"type": "string",
+				"pattern": "^[0-9a-fA-F]{24}$",
+				"description": "MongoDB ObjectId for media"
+			},
+			"MediaUploadRequest": {
+				"type": "object",
+				"required": ["file"],
+				"properties": {
+					"file": {
+						"type": "string",
+						"format": "binary",
+						"description": "Media file to upload"
+					},
+					"alt": {
+						"type": "string",
+						"maxLength": 200,
+						"description": "Alternative text for accessibility"
+					},
+					"tags": {
+						"type": "array",
+						"items": {
+							"type": "string"
+						},
+						"description": "Media tags"
+					}
+				}
+			},
+			"MediaResponse": {
+				"type": "object",
+				"properties": {
+					"id": {
+						"$ref": "#/service/schemas/MediaId"
+					},
+					"url": {
+						"type": "string",
+						"format": "uri",
+						"description": "Media file URL"
+					},
+					"type": {
+						"type": "string",
+						"enum": ["image", "video", "audio", "document"],
+						"description": "Media type"
+					},
+					"width": {
+						"type": "integer",
+						"description": "Media width (for images/videos)"
+					},
+					"height": {
+						"type": "integer",
+						"description": "Media height (for images/videos)"
+					},
+					"size": {
+						"type": "integer",
+						"description": "File size in bytes"
+					},
+					"alt": {
+						"type": "string",
+						"description": "Alternative text"
+					},
+					"tags": {
+						"type": "array",
+						"items": {
+							"type": "string"
+						},
+						"description": "Media tags"
+					},
+					"createdAt": {
+						"type": "string",
+						"format": "date-time",
+						"description": "Upload timestamp"
+					}
+				}
+			},
+			"ErrorResponse": {
+				"type": "object",
+				"properties": {
+					"error": {
+						"type": "string",
+						"description": "Error code"
+					},
+					"message": {
+						"type": "string",
+						"description": "Human-readable error message"
+					},
+					"details": {
+						"type": "object",
+						"description": "Additional error details"
+					}
+				}
+			},
+			"WebSocketNotification": {
+				"type": "object",
+				"required": ["id", "type", "user", "message", "timestamp"],
+				"properties": {
+					"id": {
+						"type": "string"
+					},
+					"type": {
+						"type": "string",
+						"enum": ["like", "comment", "follow", "mention", "post"]
+					},
+					"user": {
+						"type": "object",
+						"properties": {
+							"id": {
+								"type": "string"
+							},
+							"username": {
+								"type": "string"
+							},
+							"avatar": {
+								"type": "string"
+							}
+						}
+					},
+					"message": {
+						"type": "string"
+					},
+					"data": {
+						"type": "object",
+						"description": "Additional notification data"
+					},
+					"timestamp": {
+						"type": "string",
+						"format": "date-time"
+					}
+				}
+			},
+			"NotificationReadEvent": {
+				"type": "object",
+				"required": ["notificationId", "timestamp"],
+				"properties": {
+					"notificationId": {
+						"type": "string"
+					},
+					"timestamp": {
+						"type": "string",
+						"format": "date-time"
+					}
+				}
+			},
+			"FeedPostEvent": {
+				"type": "object",
+				"required": ["action", "post", "timestamp"],
+				"properties": {
+					"action": {
+						"type": "string",
+						"enum": ["created", "updated", "deleted"]
+					},
+					"post": {
+						"type": "object",
+						"properties": {
+							"id": {
+								"type": "string"
+							},
+							"author": {
+								"type": "object",
+								"properties": {
+									"id": {
+										"type": "string"
+									},
+									"username": {
+										"type": "string"
+									}
+								}
+							},
+							"content": {
+								"type": "string"
+							},
+							"createdAt": {
+								"type": "string",
+								"format": "date-time"
+							}
+						}
+					},
+					"timestamp": {
+						"type": "string",
+						"format": "date-time"
+					}
+				}
+			},
+			"PostLikeEvent": {
+				"type": "object",
+				"required": ["postId", "user", "action", "timestamp"],
+				"properties": {
+					"postId": {
+						"type": "string"
+					},
+					"user": {
+						"type": "object",
+						"properties": {
+							"id": {
+								"type": "string"
+							},
+							"username": {
+								"type": "string"
+							}
+						}
+					},
+					"action": {
+						"type": "string",
+						"enum": ["liked", "unliked"]
+					},
+					"timestamp": {
+						"type": "string",
+						"format": "date-time"
+					}
+				}
+			},
+			"ChatMessage": {
+				"type": "object",
+				"required": ["id", "fromUserId", "toUserId", "content", "timestamp"],
+				"properties": {
+					"id": {
+						"type": "string"
+					},
+					"fromUserId": {
+						"type": "string"
+					},
+					"toUserId": {
+						"type": "string"
+					},
+					"content": {
+						"type": "string",
+						"minLength": 1,
+						"maxLength": 2000
+					},
+					"messageType": {
+						"type": "string",
+						"enum": ["text", "image", "file"],
+						"default": "text"
+					},
+					"timestamp": {
+						"type": "string",
+						"format": "date-time"
+					}
+				}
+			},
+			"TypingIndicator": {
+				"type": "object",
+				"required": ["userId", "isTyping", "timestamp"],
+				"properties": {
+					"userId": {
+						"type": "string"
+					},
+					"isTyping": {
+						"type": "boolean"
+					},
+					"timestamp": {
+						"type": "string",
+						"format": "date-time"
+					}
+				}
+			},
+			"UserPresenceEvent": {
+				"type": "object",
+				"required": ["userId", "status", "timestamp"],
+				"properties": {
+					"userId": {
+						"type": "string"
+					},
+					"status": {
+						"type": "string",
+						"enum": ["online", "offline"]
+					},
+					"timestamp": {
+						"type": "string",
+						"format": "date-time"
+					}
+				}
+			}
+		}
+	}
+}