feat: add optional dockerImage field to database schemas#4013
Merged
Siumauricio merged 1 commit intocanaryfrom Mar 16, 2026
Merged
Conversation
- Updated MariaDB, MongoDB, MySQL, PostgreSQL, and Redis schemas to include an optional dockerImage field for enhanced configuration flexibility.
|
Documentation Updates 1 document(s) were updated by changes in this PR: READMEView Changes@@ -252,6 +252,24 @@
- Results are ordered by creation date (descending)
- Members only see services they have access to
- Returns total count for pagination UI
+
+## Database Service Update Endpoints
+
+All database services support update operations with flexible configuration options. The following database services share a common update interface:
+- **postgres.update** (apiUpdatePostgres)
+- **mysql.update** (apiUpdateMySql)
+- **mariadb.update** (apiUpdateMariaDB)
+- **mongo.update** (apiUpdateMongo)
+- **redis.update** (apiUpdateRedis)
+
+**Common Parameters:**
+
+All database update endpoints accept their respective ID field (e.g., `postgresId`, `mysqlId`, `mariadbId`, `mongoId`, `redisId`) as a required parameter, along with optional configuration fields.
+
+**Optional Configuration:**
+- `dockerImage` (optional string) - Specifies a custom Docker image for the database service. This allows users to use specific versions or custom-built images instead of the default image for the database type. Available for all five database services (PostgreSQL, MySQL, MariaDB, MongoDB, and Redis).
+
+Additional service-specific parameters are available depending on the database type. The `dockerImage` field provides enhanced configuration flexibility for advanced use cases such as version pinning or using specialized database distributions.
## Whitelabeling Endpoints
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What is this PR about?
Please describe in a short paragraph what this PR is about.
Checklist
Before submitting this PR, please make sure that:
canarybranch.Issues related (if applicable)
closes #3983
Screenshots (if applicable)
Greptile Summary
Adds an explicit
dockerImage: z.string().optional()override in the.extend()block of all five database update schemas (apiUpdateMariaDB,apiUpdateMongo,apiUpdateMySql,apiUpdatePostgres,apiUpdateRedis). This removes the.default()value that was inherited fromcreateSchema.partial(), preventing the default docker image tag from being silently applied during update operations whendockerImageis not included in the payload.mariadb.ts,mongo.ts,mysql.ts,postgres.ts, andredis.tsdockerImageto its schema default (e.g.,"mariadb:6") instead of preserving the user's custom imageshow-custom-command.tsx) always sendsdockerImagein its update payload, so this is a defensive fix for API consumers that may omit itConfidence Score: 5/5
Last reviewed commit: bb521f3