mkdocs.yml

Rama main · réplica de lectura del repositorio original.

site_name: QueryAPIGate
site_description: Turn SQL into a REST API - run queries against MySQL, PostgreSQL, ClickHouse, SQLite or H2 over HTTP.
site_url: https://AnanthaRajuC.github.io/QueryAPIGate/
repo_url: https://github.com/AnanthaRajuC/QueryAPIGate
repo_name: AnanthaRajuC/QueryAPIGate
edit_uri: edit/main/

# The pages below are one-line files (--8<-- "path/to/the/real/file.md") that pull the actual content in at
# build time via pymdownx.snippets, so there is exactly one place to edit each document (this repo's own
# root-level files and documentation/ folder, read normally on GitHub) - docs/ only mirrors their paths so
# the relative links between them keep working unchanged on the built site too. The one exception is
# docs/index.md, which pulls in LANDING.md rather than README.md - the site's homepage is deliberately a
# tighter, docs-first page, distinct from the GitHub-oriented README (screenshots, badges, full feature
# list); LANDING.md links out to the README on GitHub for that fuller picture.
docs_dir: docs

nav:
  - Home: index.md
  - Why QueryAPIGate: documentation/WHY.md
  - Features: documentation/FEATURES.md
  - Installation: documentation/INSTALLATION_AND_SETUP.md
  - Configuration: documentation/CONFIGURATION.md
  - Deployment (Docker): documentation/DEPLOYMENT.md
  - Performance: documentation/PERFORMANCE.md
  - A Rust data plane (v5, 0.44): documentation/PERFORMANCE_V5.md
  - Performance on PostgreSQL (v4, 0.43): documentation/PERFORMANCE_V4.md
  - Performance on PostgreSQL (v3): documentation/PERFORMANCE_V3.md
  - Performance on MySQL (v2, 0.43): documentation/PERFORMANCE_MYSQL_V2.md
  - Performance on MySQL (v1): documentation/PERFORMANCE_MYSQL_V1.md
  - Performance on PostgreSQL (v2, superseded): documentation/PERFORMANCE_V2.md
  - Example APIs: documentation/EXAMPLES.md
  - A tour of the Console: documentation/SCREENSHOTS.md
  - API reference: documentation/API.md
  - MCP server: documentation/MCP.md
  - Database connections: documentation/DATABASE_CONNECTION_CONFIGURATION.md
  - Query metadata: documentation/QUERY_METADATA_MANAGEMENT.md
  - Technology stack: documentation/TECHNOLOGY_STACK.MD
  - Security: SECURITY.md
  - Threat model: documentation/THREAT_MODEL.md
  - Where data goes: documentation/DATA_PROTECTION.md
  - Architecture decisions:
      - Overview: documentation/adr/README.md
      - 0001 Console and Management API: documentation/adr/0001-console-and-management-api.md
      - 0002 Event ids: documentation/adr/0002-event-ids.md
      - 0003 Named administrators: documentation/adr/0003-named-administrators.md
      - 0004 Exports to object storage: documentation/adr/0004-exports-to-object-storage.md
      - 0005 Column masking: documentation/adr/0005-column-masking.md
      - 0006 AI agents: documentation/adr/0006-ai-agents.md
      - 0007 Console sign-in through SSO: documentation/adr/0007-console-sign-in-through-sso.md
      - 0008 MCP write tools with approval: documentation/adr/0008-mcp-write-tools-with-approval.md
      - 0009 Key rotation: documentation/adr/0009-key-rotation.md
      - 0010 Tracing and security headers: documentation/adr/0010-tracing-and-security-headers.md
      - 0011 Per-key limits and quotas: documentation/adr/0011-per-key-limits-and-quotas.md
      - 0012 Tamper-evident audit log: documentation/adr/0012-tamper-evident-audit-log-and-siem.md
      - 0013 Helm chart: documentation/adr/0013-helm-chart.md
      - 0014 Configuration as code: documentation/adr/0014-configuration-as-code.md
      - 0015 Secrets managers: documentation/adr/0015-secrets-managers-and-short-lived-credentials.md
      - 0016 Data flows and FIPS: documentation/adr/0016-data-flows-and-fips.md
      - 0017 What graduates for 1.0.0-rc1: documentation/adr/0017-what-graduates-for-1-0-0-rc1.md
      - 0018 Signed releases: documentation/adr/0018-signed-releases.md
      - 0019 The SIEM stream against real receivers: documentation/adr/0019-the-siem-stream-against-real-receivers.md
      - 0020 The event log: documentation/adr/0020-the-event-log.md
      - 0021 Live events and secrets graduate: documentation/adr/0021-live-events-and-secrets-graduate.md
      - 0022 MongoDB streaming and graduation: documentation/adr/0022-mongodb-streaming-and-graduation.md
      - 0023 Workspaces: documentation/adr/0023-workspaces.md
      - 0024 Fail-closed auditing: documentation/adr/0024-fail-closed-auditing.md
      - 0025 Semantic retrieval: documentation/adr/0025-semantic-retrieval.md
      - 0026 Trino connections: documentation/adr/0026-trino-connections.md
      - 0027 Fewer round trips per query: documentation/adr/0027-fewer-round-trips-per-query.md
      - 0028 Rust data plane prototype: documentation/adr/0028-rust-data-plane-prototype.md
      - 0029 ClickHouse run store: documentation/adr/0029-clickhouse-run-store.md
      - 0030 Shipping the data plane: documentation/adr/0030-shipping-the-data-plane.md
      - 0031 The image's Python: documentation/adr/0031-the-image-s-python.md
      - 0032 Rate-limited keys on the data plane: documentation/adr/0032-dataplane-rate-limits.md
      - 0033 Live queries: documentation/adr/0033-live-queries.md
  - Contributing: CONTRIBUTING.md
  - Code of conduct: CODE_OF_CONDUCT.md
  - Changelog: CHANGELOG.md
  - Roadmap: BACKLOG.md

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      toggle: {icon: material/brightness-7, name: Switch to dark mode}
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      toggle: {icon: material/brightness-4, name: Switch to light mode}
  features:
    - navigation.tabs
    - navigation.top
    - navigation.instant
    - content.code.copy
    - content.action.edit
    - search.suggest

markdown_extensions:
  - admonition
  - tables
  - toc:
      permalink: true
  - pymdownx.snippets:
      base_path: ["."]
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight