Skip to content

server: introduce versioning and pagination in the HTTP APIs #54022

@knz

Description

@knz

Today the HTTP APis are not versioned and not paginated:

  • not versioned makes it hard to introduce or change functionality even with crdb's own internal client, because the APIs must behave well in mixed-version environments.

    By introducing versioning (e.g .in the URL) we make it easier to extend, substitute and deprecate functionality across multiple releases. IT also helps maintaining backward-compatibility by 3rd party tooling built by users.

  • not paginated causes nodes to crash with OOM errors when the underlying resource is large, e.g. when retrieving log files, range/event logs, jobs tables etc.

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-kv-serverRelating to the KV-level RPC serverC-bugCode not up to spec/doc, specs & docs deemed correct. Solution expected to change code/behavior.S-3-productivitySevere issues that impede the productivity of CockroachDB developers.S-3-ux-surpriseIssue leaves users wondering whether CRDB is behaving properly. Likely to hurt reputation/adoption.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions