turash/docs/concept/schemas/websocket_event.json
Damir Mukimov 000eab4740
Major repository reorganization and missing backend endpoints implementation
Repository Structure:
- Move files from cluttered root directory into organized structure
- Create archive/ for archived data and scraper results
- Create bugulma/ for the complete application (frontend + backend)
- Create data/ for sample datasets and reference materials
- Create docs/ for comprehensive documentation structure
- Create scripts/ for utility scripts and API tools

Backend Implementation:
- Implement 3 missing backend endpoints identified in gap analysis:
  * GET /api/v1/organizations/{id}/matching/direct - Direct symbiosis matches
  * GET /api/v1/users/me/organizations - User organizations
  * POST /api/v1/proposals/{id}/status - Update proposal status
- Add complete proposal domain model, repository, and service layers
- Create database migration for proposals table
- Fix CLI server command registration issue

API Documentation:
- Add comprehensive proposals.md API documentation
- Update README.md with Users and Proposals API sections
- Document all request/response formats, error codes, and business rules

Code Quality:
- Follow existing Go backend architecture patterns
- Add proper error handling and validation
- Match frontend expected response schemas
- Maintain clean separation of concerns (handler -> service -> repository)
2025-11-25 06:01:16 +01:00

127 lines
3.3 KiB
JSON

{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://cityresourcegraph.com/schemas/websocket_event.json",
"title": "WebSocket Event",
"description": "Schema for real-time WebSocket events",
"type": "object",
"properties": {
"event_type": {
"type": "string",
"enum": ["match_found", "resource_updated", "price_changed", "notification", "system_status"],
"description": "Type of event"
},
"event_id": {
"type": "string",
"format": "uuid",
"description": "Unique event identifier"
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "Event timestamp"
},
"user_id": {
"type": "string",
"format": "uuid",
"description": "Target user (if applicable)"
},
"data": {
"oneOf": [
{"$ref": "#/definitions/match_event"},
{"$ref": "#/definitions/resource_event"},
{"$ref": "#/definitions/notification_event"},
{"$ref": "#/definitions/system_event"}
]
}
},
"required": ["event_type", "event_id", "timestamp", "data"],
"definitions": {
"match_event": {
"type": "object",
"properties": {
"match": {
"$ref": "https://cityresourcegraph.com/schemas/match_response.json#/definitions/match"
},
"reason": {
"type": "string",
"enum": ["new_resource", "improved_match", "price_change"],
"description": "Why this match was triggered"
}
},
"required": ["match"]
},
"resource_event": {
"type": "object",
"properties": {
"resource_id": {
"type": "string",
"format": "uuid"
},
"changes": {
"type": "object",
"description": "Changed fields and new values"
},
"affected_matches": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Match IDs affected by this change"
}
},
"required": ["resource_id", "changes"]
},
"notification_event": {
"type": "object",
"properties": {
"title": {
"type": "string",
"maxLength": 200
},
"message": {
"type": "string",
"maxLength": 1000
},
"priority": {
"type": "string",
"enum": ["low", "medium", "high", "urgent"],
"default": "medium"
},
"action_url": {
"type": "string",
"format": "uri"
},
"expires_at": {
"type": "string",
"format": "date-time"
}
},
"required": ["title", "message"]
},
"system_event": {
"type": "object",
"properties": {
"component": {
"type": "string",
"enum": ["api", "matching_engine", "database", "cache", "queue"]
},
"status": {
"type": "string",
"enum": ["healthy", "degraded", "down", "maintenance"]
},
"message": {
"type": "string",
"maxLength": 500
},
"estimated_resolution": {
"type": "string",
"format": "date-time"
}
},
"required": ["component", "status"]
}
},
"additionalProperties": false
}