feat: [DBOPS-1543]: flyway schema changes and migration type (#694)

bikramHarness · Harness · commit b6b43ceb76ee · 2025-11-19T06:26:59.000Z
* d43330 feat: [DBOPS-1543]: flyway schema changes and migration type

* 3aea1d feat: [DBOPS-1543]: flyway schema changes and migration type

* a2986a feat: [DBOPS-1543]: flyway schema changes and migration type
diff --git a/harness/dbops/README.md b/harness/dbops/README.md
@@ -64,6 +64,7 @@ Class | Method | HTTP request | Description
  - [MigrationStateInstance](docs/MigrationStateInstance.md)
  - [MigrationStateInstanceIn](docs/MigrationStateInstanceIn.md)
  - [MigrationStateOut](docs/MigrationStateOut.md)
+ - [MigrationType](docs/MigrationType.md)
  - [ModelError](docs/ModelError.md)
  - [NgTag](docs/NgTag.md)
  - [OrderInstance](docs/OrderInstance.md)
diff --git a/harness/dbops/api/swagger.yaml b/harness/dbops/api/swagger.yaml
@@ -1592,6 +1592,8 @@ components:
           $ref: "#/components/schemas/DBSchemaType"
         changeLogScript:
           $ref: "#/components/schemas/ChangeLogScript"
+        migrationType:
+          $ref: "#/components/schemas/MigrationType"
       description: 'Database Schema Request '
       x-examples:
         Example 1:
@@ -1611,6 +1613,7 @@ components:
       - created
       - identifier
       - instanceCount
+      - migrationType
       - name
       - type
       type: object
@@ -1657,6 +1660,8 @@ components:
           $ref: "#/components/schemas/ChangeLogScript"
         type:
           $ref: "#/components/schemas/DBSchemaType"
+        migrationType:
+          $ref: "#/components/schemas/MigrationType"
       description: Database Schema Response
       example:
         identifier: identifier
@@ -1870,6 +1875,11 @@ components:
           description: path excluding the repo till the archive file
           x-stoplight:
             id: 53mqhpfa5038m
+        toml:
+          type: string
+          description: config file for Flyway migration type
+          x-stoplight:
+            id: 7m9n0umenjjhf
       additionalProperties: false
       description: |
         location of the changelog file containing schema changes in a git repository
@@ -2487,6 +2497,11 @@ components:
           example: folder/changelog.yaml
           x-stoplight:
             id: sn916ihq297p3
+        toml:
+          type: string
+          description: config file for Flyway migration type
+          x-stoplight:
+            id: s0cp5j17j45dk
       description: if schemaType is Script location of the changelog file after using
         a custom script to download
       example:
@@ -2506,6 +2521,15 @@ components:
       - Script
       x-stoplight:
         id: 21ikm27shlnsf
+    MigrationType:
+      title: MigrationType
+      type: string
+      description: DB Migration tool type
+      enum:
+      - Liquibase
+      - Flyway
+      x-stoplight:
+        id: 2vj413xlt5qrp
   responses:
     DBSchemaListResponse:
       description: Response body for List Database Schema
diff --git a/harness/dbops/docs/ChangeLogScript.md b/harness/dbops/docs/ChangeLogScript.md
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **Command** | **string** | command script used to download the changelog file | [default to null]
 **Shell** | **string** | shell type | [default to null]
 **Location** | **string** | location of the changelog file | [default to null]
+**Toml** | **string** | config file for Flyway migration type | [optional] [default to null]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/harness/dbops/docs/Changelog.md b/harness/dbops/docs/Changelog.md
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **Location** | **string** | path to the change log file | [default to null]
 **Repo** | **string** | repo name of the git based connector when ConnectionType is Account | [optional] [default to null]
 **ArchivePath** | **string** | path excluding the repo till the archive file | [optional] [default to null]
+**Toml** | **string** | config file for Flyway migration type | [optional] [default to null]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/harness/dbops/docs/DbSchemaIn.md b/harness/dbops/docs/DbSchemaIn.md
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **Service** | **string** | harness service corresponding to database schema  | [optional] [default to null]
 **Type_** | [***DbSchemaType**](DBSchemaType.md) |  | [optional] [default to null]
 **ChangeLogScript** | [***ChangeLogScript**](ChangeLogScript.md) |  | [optional] [default to null]
+**MigrationType** | [***MigrationType**](MigrationType.md) |  | [optional] [default to null]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/harness/dbops/docs/DbSchemaOut.md b/harness/dbops/docs/DbSchemaOut.md
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
 **SchemaSourceType** | **string** |  | [optional] [default to null]
 **ChangeLogScript** | [***ChangeLogScript**](ChangeLogScript.md) |  | [optional] [default to null]
 **Type_** | [***DbSchemaType**](DBSchemaType.md) |  | [default to null]
+**MigrationType** | [***MigrationType**](MigrationType.md) |  | [default to null]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 
diff --git a/harness/dbops/docs/MigrationType.md b/harness/dbops/docs/MigrationType.md
@@ -0,0 +1,8 @@
+# MigrationType
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
diff --git a/harness/dbops/model_change_log_script.go b/harness/dbops/model_change_log_script.go
@@ -19,4 +19,6 @@ type ChangeLogScript struct {
 	Shell string `json:"shell"`
 	// location of the changelog file
 	Location string `json:"location"`
+	// config file for Flyway migration type
+	Toml string `json:"toml,omitempty"`
 }
diff --git a/harness/dbops/model_changelog.go b/harness/dbops/model_changelog.go
@@ -19,4 +19,6 @@ type Changelog struct {
 	Repo string `json:"repo,omitempty"`
 	// path excluding the repo till the archive file
 	ArchivePath string `json:"archivePath,omitempty"`
+	// config file for Flyway migration type
+	Toml string `json:"toml,omitempty"`
 }
diff --git a/harness/dbops/model_db_schema_in.go b/harness/dbops/model_db_schema_in.go
@@ -22,4 +22,5 @@ type DbSchemaIn struct {
 	Service         string           `json:"service,omitempty"`
 	Type_           *DbSchemaType    `json:"type,omitempty"`
 	ChangeLogScript *ChangeLogScript `json:"changeLogScript,omitempty"`
+	MigrationType   *MigrationType   `json:"migrationType,omitempty"`
 }
diff --git a/harness/dbops/model_db_schema_out.go b/harness/dbops/model_db_schema_out.go
@@ -29,4 +29,5 @@ type DbSchemaOut struct {
 	SchemaSourceType string           `json:"schemaSourceType,omitempty"`
 	ChangeLogScript  *ChangeLogScript `json:"changeLogScript,omitempty"`
 	Type_            *DbSchemaType    `json:"type"`
+	MigrationType    *MigrationType   `json:"migrationType"`
 }
diff --git a/harness/dbops/model_migration_type.go b/harness/dbops/model_migration_type.go
@@ -0,0 +1,19 @@
+/*
+ * Harness NextGen Software Delivery Platform API Reference
+ *
+ * This is the Open Api Spec 3 for the DB Service
+ *
+ * API version: 1.0
+ * Contact: contact@harness.io
+ * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
+ */
+package dbops
+
+// MigrationType : DB Migration tool type
+type MigrationType string
+
+// List of MigrationType
+const (
+	LIQUIBASE_MigrationType MigrationType = "Liquibase"
+	FLYWAY_MigrationType    MigrationType = "Flyway"
+)

Original file line number	Diff line number	Diff line change
`@@ -19,4 +19,6 @@ type ChangeLogScript struct {`
`19`	`19`	Shell string `json:"shell"`
`20`	`20`	`// location of the changelog file`
`21`	`21`	Location string `json:"location"`
	`22`	`+ // config file for Flyway migration type`
	`23`	+ Toml string `json:"toml,omitempty"`
`22`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,4 +19,6 @@ type Changelog struct {`
`19`	`19`	Repo string `json:"repo,omitempty"`
`20`	`20`	`// path excluding the repo till the archive file`
`21`	`21`	ArchivePath string `json:"archivePath,omitempty"`
	`22`	`+ // config file for Flyway migration type`
	`23`	+ Toml string `json:"toml,omitempty"`
`22`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,4 +22,5 @@ type DbSchemaIn struct {`
`22`	`22`	Service string `json:"service,omitempty"`
`23`	`23`	Type_ *DbSchemaType `json:"type,omitempty"`
`24`	`24`	ChangeLogScript *ChangeLogScript `json:"changeLogScript,omitempty"`
	`25`	+ MigrationType *MigrationType `json:"migrationType,omitempty"`
`25`	`26`	`}`