Skip to content

HTTP API: Add some missing defaults/enums #718

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

Simran-B
Copy link
Contributor

@Simran-B Simran-B commented Jun 24, 2025

Description

TODOs:

  • If the default value depends on a startup option, should we refrain from specifying one in the OpenAPI description?
    For example, replicationFactor is 1 by default in a cluster (and ignored in single server), but this depends on the --cluster.default-replication-factor startup options for user collections and on --cluster.system-replication-factor for system collections. If the startup options aren't set, then the default is indeed 1, but otherwise it has the value of the respective startup option. Should we therefore omit default: 1 and describe how the default value is determined in description?

Upstream PRs

  • 3.10:
  • 3.11:
  • 3.12:
  • 3.13:

@Simran-B Simran-B self-assigned this Jun 24, 2025
Copy link
Contributor

Deploy Preview Available Via
https://deploy-preview-718--docs-hugo.netlify.app

@cla-bot cla-bot bot added the cla-signed label Jun 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant