Skip to content

docs: add missing Database fields to Developer API schema #920

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.

Sign up for GitHub

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
context7 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add missing Database fields to Developer API schema #920

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions devops/developer-api/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1745,6 +1745,10 @@ components:
type: string
description: Name of the database
example: MyRedis
database_type:
type: string
description: Type of the database, either Regional or Global
example: Regional
region:
type: string
description: The region where database is hosted
Expand Down Expand Up @@ -1772,10 +1776,24 @@ components:
type: string
description: Endpoint identifier or hostname of the database (may be a slug like "beloved-stallion-58500" or a full host)
example: beloved-stallion-58500
rest_token:
type: string
description: REST token for the database. Pass the `credentials=hide` query parameter to Get Database to omit it from the response.
read_only_rest_token:
type: string
description: Read-only REST token for the database. Pass the `credentials=hide` query parameter to Get Database to omit it from the response.
password:
type: string
description: Password of the database. Pass the `credentials=hide` query parameter to Get Database to omit it from the response.
tls:
type: boolean
description: TLS/SSL is enabled or not
example: true
db_daily_bandwidth_limit:
type: integer
description: Daily bandwidth limit for the database (in bytes)
format: int64
example: 10737418240
db_max_clients:
type: integer
description: Max number of concurrent clients can be opened on this database currently
Expand Down Expand Up @@ -1934,6 +1952,10 @@ components:
type: string
description: Owner identifier of the database (may be email or marketplace-scoped email)
example: "example@upstash.com"
user_email:
type: string
description: User email for the database
example: "example@upstash.com"
daily_backup_enabled:
type: boolean
description: Whether daily backup is enabled
Expand Down
Loading