Skip to main content

Documentation

Documentation, honest about what exists

Bobby DB documents what is built and labels what is not. Each topic below states its own status rather than presenting a design as a finished reference.

How to read these docs

“Implemented — pilot” means it is built and you can inspect it. “Authorized pilot operators” means it is built and reachable only by an operator the Bobby DB operator has admitted. “Planned” means designed but not built, and “Not yet available” means there is nothing to document yet.

Email and password sign-in exists, and it grants no Bobby DB account, role, workspace access or authority on its own. There is no public registration. No fabricated request, response or behaviour is presented as final anywhere in these docs.

Topics

  • Quickstart

    Authorized pilot operators

    The shortest path from a key to a reference value: open a workspace, seed a collection, cut a release, read it with a key.

    The path is implemented in the governed console. A published walkthrough waits until a pilot operator has run it end to end.

  • Authentication

    Implemented — pilot

    How a person signs in with email and password, and how a machine caller authenticates with an API key.

    Email and password sign-in and tracked API keys are implemented. Signing in grants no Bobby DB account, role or access; admission is granted by the operator.

    Sign-in status

  • Workspaces

    Authorized pilot operators

    The tenant boundary: what a workspace owns, and what never crosses it.

    Implemented as the isolation boundary and reachable by authorized pilot operators only.

    Product design

  • Collections

    Authorized pilot operators

    Visibility, schema modes, and the unit that is drafted, released and served.

    Implemented in the governed console for authorized pilot operators.

    Product design

  • Groups

    Authorized pilot operators

    Organising related keys inside one collection.

    Implemented alongside collections; a field-level reference is still to be written.

  • Entries

    Authorized pilot operators

    Keys, typed JSON-compatible values, and what does not belong in a value.

    Implemented with schema validation; field-level reference still to be written.

    Value model

  • Imports

    Planned

    Bringing bulk content in through parsing, mapping and validation into a draft.

    Designed only. No bulk import pipeline is built.

  • Drafts and Reviews

    Authorized pilot operators

    The editing space and the human gate between editing and publication.

    Draft editing and the review step before a release are implemented for authorized pilot operators.

  • Releases

    Authorized pilot operators

    Immutability, current versus pinned reads, and how corrections are published.

    Immutable releases and pinned reads are implemented. No release has been published in production.

    Pinning behaviour

  • API Keys

    Authorized pilot operators

    Issuance, read and write scopes, one-time display, rotation and revocation.

    Implemented: hashed at rest, shown once, scoped to one workspace, revocable. Issued to authorized pilot operators only.

  • REST API

    Authorized pilot operators

    Base URL, pagination, batch reads, ETag revalidation, idempotency keys and request IDs.

    The versioned surface is implemented behind an API key. It is published in outline rather than as a full reference until the pilot has exercised it.

    Developer architecture

  • MCP

    Not yet available

    The agent delivery surface. Deferred, and not in service.

    Deferred. Its address answers one stated refusal, lists no tool and exposes no data. It will be built only under separate authorization and verification.

    Why MCP is deferred

  • Metering and Limits

    Authorized pilot operators

    How requests are counted per workspace, and what happens at an allowance boundary.

    Per-key rate limiting and usage accounting are implemented at the delivery boundary. The plan allowances on the pricing page remain a proposal, and there is no billing.

    Proposed limits

  • Errors

    Authorized pilot operators

    The stable error codes a client should branch on.

    The refusal and error taxonomy is implemented at the delivery boundary.

    Error taxonomy

  • Security

    Implemented

    The data model boundaries, key handling and what evidence does and does not exist.

    The security position page is written and current.

    Security position

  • Changelog

    Not yet available

    What changed in the platform and in published public collections.

    Not yet available. No release has been published, so there is nothing to log.

Authorized pilot operators

Enough to design against

Rather than a full API reference, these docs publish the architecture and a small set of representative examples until the pilot has exercised every path.

Read shapesynthetic example
{
  "collection": "example-collection",
  "release": "example-release-version",
  "entries": [
    { "key": "example.first.key", "value": { "example": true } }
  ],
  "next_cursor": null,
  "request_id": "example-request-id-0001"
}

Illustrative response shape with invented values. Field names are not final.

Import shapesynthetic example
{
  "target": "example-collection",
  "mode": "draft",
  "mapping": { "source_field": "example.first.key" },
  "rows": [{ "source_field": "example value" }]
}

Illustrative import submission. No import pipeline exists.

Missing a topic you need to evaluate Bobby DB? It is not published because it cannot be documented truthfully yet. Nothing here is generally available, access is granted by the operator, and no support channel is announced on this site.