pip install -r requirements.txt

cp .env.example .env
# Отредактируйте .env под свои настройки {#edit-env-with-your-settings}

# Создание таблиц {#create-tables}
python -m src.api.cli init-db

# Выполнение миграций {#run-migrations}
python -m src.api.cli migrate

python -m src.api.cli create-admin --username admin --password ваш-надёжный-пароль

python -m src.api.cli run --host 0.0.0.0 --port 8000

POST /api/v1/auth/token
Content-Type: application/json

{
  "username": "admin",
  "password": "ваш-пароль"
}

{
  "access_token": "eyJhbGciOiJIUzI1NiIs...",
  "refresh_token": "eyJhbGciOiJIUzI1NiIs...",
  "token_type": "bearer",
  "expires_in": 1800
}

POST /api/v1/auth/refresh
Content-Type: application/json

{
  "refresh_token": "eyJhbGciOiJIUzI1NiIs..."
}

Authorization: Bearer <access_token>

POST /api/v1/auth/api-keys
Authorization: Bearer <token>
Content-Type: application/json

{
  "name": "my-integration",
  "expires_days": 365,
  "scopes": ["scenarios:read", "query:execute"]
}

{
  "id": "key_abc123",
  "name": "my-integration",
  "key": "rak_xxxxxxxxxxxxxxxxxxxx",
  "prefix": "rak_xxxx",
  "scopes": ["scenarios:read", "query:execute"],
  "expires_at": "2025-12-09T00:00:00Z",
  "created_at": "2024-12-09T00:00:00Z"
}

X-API-Key: rak_xxxxxxxxxxxxxxxxxxxx

GET /api/v1/auth/api-keys
Authorization: Bearer <token>

DELETE /api/v1/auth/api-keys/{key_id}
Authorization: Bearer <token>

GET /api/v1/auth/oauth/{provider}/authorize

GET /api/v1/auth/oauth/{provider}/callback?code=xxx&state=xxx

POST /api/v1/auth/ldap
Content-Type: application/json

{
  "username": "jdoe",
  "password": "ldap-пароль"
}

{
  "query": "Как работает MVCC?",
  "language": "ru"
}

{
  "answer": "MVCC (Multi-Version Concurrency Control)...",
  "scenario_id": "onboarding",
  "processing_time_ms": 1523.45
}

{
  "enabled": true,
  "rate_limit": "30/minute",
  "max_query_length": 500,
  "allowed_scenarios": ["onboarding"]
}

{
  "query": "Найти уязвимости к SQL-инъекциям",
  "session_id": "необязательный-id-сессии",
  "scenario_id": "security",
  "language": "en"
}

{
  "answer": "Найдено 3 потенциальные уязвимости к SQL-инъекциям...",
  "scenario_id": "security",
  "confidence": 0.85,
  "evidence": [
    {
      "type": "code",
      "source": "src/executor.c:123",
      "content": "sprintf(query, \"SELECT * FROM %s\", user_input);",
      "relevance": 0.95
    }
  ],
  "session_id": "sess_abc123",
  "request_id": "req_xyz789",
  "processing_time_ms": 2341.5
}

data: {"type": "start", "session_id": "sess_abc123"}

data: {"type": "chunk", "content": "Найдено 3 потенциальные "}

data: {"type": "chunk", "content": "уязвимости к SQL-инъекциям..."}

data: {"type": "end", "scenario_id": "security"}

[
  {
    "id": "onboarding",
    "name": "Onboarding",
    "description": "Начало работы с кодовой базой — поиск функций, построение графов вызовов",
    "category": "Learning",
    "keywords": ["find", "where", "what", "how", "explain"],
    "example_queries": ["Где находится функция main()?", "Что делает exec_simple_query?"]
  },
  {
    "id": "security",
    "name": "Security Audit",
    "description": "Поиск уязвимостей — SQL-инъекции, переполнения буфера",
    "category": "Security",
    "keywords": ["vulnerability", "injection", "unsafe"],
    "example_queries": ["Найти уязвимости к SQL-инъекциям"]
  }
  // ... ещё 14 сценариев
]

{
  "query": "Найти уязвимости к переполнению буфера",
  "session_id": "необязательный-id-сессии",
  "language": "en"
}

{
  "patch_content": "diff --git a/src/file.c b/src/file.c\n...",
  "task_description": "Исправить утечку памяти в обработчике транзакций",
  "dod_items": ["Нет утечек памяти", "Проходят модульные тесты"],
  "output_format": "json"
}

{
  "recommendation": "REQUEST_CHANGES",
  "confidence": 0.82,
  "findings": [
    {
      "category": "error",
      "severity": "high",
      "location": {"file": "src/file.c", "line_start": 45},
      "message": "Потенциальная утечка памяти: выделенная память не освобождается на пути ошибки",
      "suggested_fix": "Добавить free(ptr) перед оператором return"
    }
  ],
  "dod_status": [
    {"description": "Нет утечек памяти", "satisfied": false, "evidence": "Найдена 1 потенциальная утечка"}
  ],
  "summary": "Найдена 1 проблема высокой серьёзности, которую необходимо устранить."
}

{
  "owner": "postgres",
  "repo": "postgres",
  "pr_number": 123,
  "github_token": "ghp_xxx"
}

{
  "project_id": "123",
  "mr_iid": 456,
  "gitlab_token": "glpat-xxx",
  "gitlab_url": "https://gitlab.com"
}

{
  "query": "SELECT name, file FROM nodes_method WHERE name LIKE '%transaction%' LIMIT 10",
  "timeout_ms": 30000
}

{
  "results": [
    {"name": "StartTransaction", "file": "xact.c"},
    {"name": "CommitTransaction", "file": "xact.c"}
  ],
  "row_count": 2,
  "execution_time_ms": 45.2
}

{
  "languages": [
    {
      "id": "c",
      "name": "C",
      "extensions": [".c", ".h", ".cpp", ".hpp"],
      "joern_command": "c2cpg",
      "joern_flag": "C"
    },
    {
      "id": "java",
      "name": "JAVA",
      "extensions": [".java"],
      "joern_command": "javasrc2cpg",
      "joern_flag": "JAVASRC"
    }
  ]
}

{
  "repo_url": "https://github.com/llvm/llvm-project",
  "branch": "main",
  "shallow_clone": true,
  "language": null,
  "mode": "full",
  "include_paths": ["llvm/lib", "llvm/include"],
  "exclude_paths": ["test", "tests"],
  "create_domain_plugin": true,
  "import_docs": true,
  "joern_memory_gb": 16,
  "batch_size": 10000
}

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "pending",
  "message": "Импорт запущен. Используйте job_id для отслеживания прогресса."
}

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "project_name": "llvm-project",
  "status": "in_progress",
  "steps": [
    {"name": "Clone Repository", "status": "completed", "progress": 100},
    {"name": "Detect Language", "status": "completed", "progress": 100},
    {"name": "Create CPG", "status": "in_progress", "progress": 45, "message": "Создание узлов CPG..."},
    {"name": "Export to DuckDB", "status": "pending", "progress": 0},
    {"name": "Validate CPG", "status": "pending", "progress": 0},
    {"name": "Import Documentation", "status": "pending", "progress": 0},
    {"name": "Setup Domain Plugin", "status": "pending", "progress": 0}
  ],
  "current_step": "joern_import",
  "overall_progress": 35,
  "created_at": "2024-12-09T10:00:00Z",
  "updated_at": "2024-12-09T10:05:00Z"
}

const ws = new WebSocket('ws://localhost:8000/ws/chat?token=<jwt_token>');

ws.onmessage = (event) => {
  const data = JSON.parse(event.data);
  console.log('Получено:', data);
};

ws.send(JSON.stringify({
  type: 'query',
  query: 'Найти уязвимости к SQL-инъекциям',
  scenario_id: 'security'
}));

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1702123456

RATE_LIMIT_STORAGE=redis://localhost:6379

# Создание базы данных {#create-database}
createdb codegraph

# Установка строки подключения {#set-connection-string}
export DATABASE_URL="postgresql+asyncpg://postgres:password@localhost:5432/codegraph"

# Применить все миграции {#apply-all-migrations}
python -m src.api.cli migrate

# Перейти к определённой ревизии {#migrate-to-specific-revision}
python -m src.api.cli migrate --revision abc123

# Запустить сервер API {#run-api-server}
python -m src.api.cli run [--host HOST] [--port PORT] [--workers N] [--reload]

# Инициализировать базу данных {#initialize-database}
python -m src.api.cli init-db

# Выполнить миграции {#run-migrations}
python -m src.api.cli migrate [--revision REV]

# Создать учётную запись администратора {#create-admin-user}
python -m src.api.cli create-admin --username USER --password PASS [--email EMAIL]

curl -X POST http://localhost:8000/api/v1/demo/chat \
  -H "Content-Type: application/json" \
  -d '{"query": "Как работает MVCC?", "language": "ru"}'

curl -X POST http://localhost:8000/api/v1/auth/token \
  -H "Content-Type: application/json" \
  -d '{"username": "admin", "password": "secret"}'

export TOKEN="eyJhbGciOiJIUzI1NiIs..."

curl -X POST http://localhost:8000/api/v1/chat \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"query": "Find SQL injection vulnerabilities", "scenario_id": "security"}'

curl http://localhost:8000/api/v1/scenarios \
  -H "Authorization: Bearer $TOKEN"

curl -X POST http://localhost:8000/api/v1/auth/api-keys \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "my-integration", "expires_days": 365}'

curl http://localhost:8000/api/v1/scenarios \
  -H "X-API-Key: rak_xxxxxxxxxxxxxxxxxxxx"

curl -X POST http://localhost:8000/api/v1/review/patch \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "patch_content": "diff --git a/src/file.c ...",
    "task_description": "Fix memory leak",
    "output_format": "json"
  }'

{
  "detail": "Текст ошибки здесь",
  "error_code": "VALIDATION_ERROR",
  "request_id": "req_abc123"
}