fix invalid swagger and upgrade to go 1.23 (#253)

tidbcloud · Nov 21, 2024 · 2e57e1a · 2e57e1a
1 parent 64b4ca4
commit 2e57e1a
Show file tree

Hide file tree

Showing 12 changed files with 210 additions and 54 deletions.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -28,9 +28,9 @@ jobs:
           go-version-file: './go.mod'
 
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v3.3.0
+        uses: golangci/golangci-lint-action@v6
         with:
-          version: v1.56.2
+          version: v1.62.0
 
   fmt:
     name: fmt

diff --git a/.golangci.yml b/.golangci.yml
@@ -7,7 +7,6 @@ linters:
     - bodyclose
     - durationcheck
     - errcheck
-    - exportloopref
     - goimports
     - gosec
     - gosimple
@@ -31,6 +30,7 @@ linters-settings:
     confidence: "low"
     excludes:
       - G101
+      - G115
       - G404
       # exclude warnings of using crypto/sha1
       - G505

diff --git a/Makefile b/Makefile
@@ -31,7 +31,7 @@ generate-pingchat-client: ## Generate PingChat client
 	@echo "==> Generating PingChat client"
 	rm -rf pkg/tidbcloud/pingchat
 	cd tools/openapi-generator && npx openapi-generator-cli generate --inline-schema-options RESOLVE_INLINE_ENUMS=true --additional-properties=withGoMod=false,enumClassPrefix=true --global-property=apiTests=false,apiDocs=false,modelDocs=false,modelTests=false -i ../../pkg/tidbcloud/pingchat.swagger.json -g go -o ../../pkg/tidbcloud/pingchat --package-name pingchat
-	go fmt ./pkg/tidbcloud/pingchat/...
+	cd pkg && go fmt ./tidbcloud/pingchat/...
 
 .PHONY: addcopy
 addcopy: ## Add copyright to all files
@@ -44,7 +44,7 @@ generate-v1beta1-client: install-openapi-generator ## Generate v1beta1 client
 	cd tools/openapi-generator && npx openapi-generator-cli generate --inline-schema-options RESOLVE_INLINE_ENUMS=true --additional-properties=withGoMod=false,enumClassPrefix=true,disallowAdditionalPropertiesIfNotPresent=false --global-property=apiTests=false,apiDocs=false,modelDocs=false,modelTests=false -i ../../pkg/tidbcloud/v1beta1/serverless/branch.swagger.json -g go -o ../../pkg/tidbcloud/v1beta1/serverless/branch --package-name branch
 	@echo "==> Generating serverless cluster client"
 	rm -rf pkg/tidbcloud/v1beta1/serverless/cluster
-	cd tools/openapi-generator && npx openapi-generator-cli generate --inline-schema-options RESOLVE_INLINE_ENUMS=true --additional-properties=withGoMod=false,enumClassPrefix=true,disallowAdditionalPropertiesIfNotPresent=false --global-property=apiTests=false,apiDocs=false,modelDocs=false,modelTests=false -i ../../pkg/tidbcloud/v1beta1/serverless/cluster.swagger.json -g go -o ../../pkg/tidbcloud/v1beta1/serverless/cluster --package-name cluster --skip-validate-spec
+	cd tools/openapi-generator && npx openapi-generator-cli generate --inline-schema-options RESOLVE_INLINE_ENUMS=true --additional-properties=withGoMod=false,enumClassPrefix=true,disallowAdditionalPropertiesIfNotPresent=false --global-property=apiTests=false,apiDocs=false,modelDocs=false,modelTests=false -i ../../pkg/tidbcloud/v1beta1/serverless/cluster.swagger.json -g go -o ../../pkg/tidbcloud/v1beta1/serverless/cluster --package-name cluster
 	@echo "==> Generating serverless export client"
 	rm -rf pkg/tidbcloud/v1beta1/serverless/export
 	cd tools/openapi-generator && npx openapi-generator-cli generate --inline-schema-options RESOLVE_INLINE_ENUMS=true --additional-properties=withGoMod=false,enumClassPrefix=true,disallowAdditionalPropertiesIfNotPresent=false --global-property=apiTests=false,apiDocs=false,modelDocs=false,modelTests=false -i ../../pkg/tidbcloud/v1beta1/serverless/export.swagger.json -g go -o ../../pkg/tidbcloud/v1beta1/serverless/export --package-name export
@@ -57,7 +57,7 @@ generate-v1beta1-client: install-openapi-generator ## Generate v1beta1 client
 	@echo "==> Generating serverless import client"
 	rm -rf pkg/tidbcloud/v1beta1/serverless/imp
 	cd tools/openapi-generator && npx openapi-generator-cli generate --inline-schema-options RESOLVE_INLINE_ENUMS=true --additional-properties=withGoMod=false,enumClassPrefix=true,disallowAdditionalPropertiesIfNotPresent=false --global-property=apiTests=false,apiDocs=false,modelDocs=false,modelTests=false -i ../../pkg/tidbcloud/v1beta1/serverless/import.swagger.json -g go -o ../../pkg/tidbcloud/v1beta1/serverless/imp --package-name imp
-	go fmt ./pkg/tidbcloud/v1beta1/...
+	cd pkg && go fmt ./tidbcloud/v1beta1/...
 
 .PHONY: install-openapi-generator
 install-openapi-generator:

diff --git a/go.mod b/go.mod
@@ -1,6 +1,6 @@
 module github.com/tidbcloud/tidbcloud-cli
 
-go 1.22
+go 1.23
 
 require (
 	github.com/AlecAivazis/survey/v2 v2.3.6

diff --git a/pkg/go.mod b/pkg/go.mod
@@ -1,3 +1,3 @@
 module github.com/tidbcloud/tidbcloud-cli/pkg
 
-go 1.22
+go 1.23
diff --git a/pkg/tidbcloud/v1beta1/serverless/cluster.swagger.json b/pkg/tidbcloud/v1beta1/serverless/cluster.swagger.json
@@ -107,10 +107,7 @@
             "in": "body",
             "required": true,
             "schema": {
-              "$ref": "#/definitions/tidb_cloud_open_apiserverlessv1beta1Cluster",
-              "required": [
-                "cluster"
-              ]
+              "$ref": "#/definitions/tidb_cloud_open_apiserverlessv1beta1Cluster"
             }
           }
         ],
@@ -378,6 +375,14 @@
     }
   },
   "definitions": {
+    "ClusterHighAvailabilityType": {
+      "type": "string",
+      "enum": [
+        "ZONAL",
+        "REGIONAL"
+      ],
+      "title": "- ZONAL: High availability within a single zone\n - REGIONAL: High availability across multiple zones within a region"
+    },
     "ClusterSpendingLimit": {
       "type": "object",
       "properties": {
@@ -648,6 +653,9 @@
             }
           ]
         },
+        "highAvailabilityType": {
+          "$ref": "#/definitions/ClusterHighAvailabilityType"
+        },
         "version": {
           "type": "string",
           "description": "Output_only. The TiDB version of the cluster.",
@@ -727,10 +735,7 @@
           ]
         }
       },
-      "description": "Message for requesting to create a TiDB Cloud Serverless cluster.",
-      "required": [
-        "cluster"
-      ]
+      "description": "Message for requesting to create a TiDB Cloud Serverless cluster."
     },
     "tidb_cloud_open_apiserverlessv1beta1ListClustersResponse": {
       "type": "object",

diff --git a/pkg/tidbcloud/v1beta1/serverless/cluster/.openapi-generator/FILES b/pkg/tidbcloud/v1beta1/serverless/cluster/.openapi-generator/FILES
@@ -7,6 +7,7 @@ api_serverless_service.go
 client.go
 configuration.go
 git_push.sh
+model_cluster_high_availability_type.go
 model_cluster_spending_limit.go
 model_commonv1beta1_cluster_state.go
 model_commonv1beta1_region.go

diff --git a/pkg/tidbcloud/v1beta1/serverless/cluster/README.md b/pkg/tidbcloud/v1beta1/serverless/cluster/README.md
@@ -91,6 +91,7 @@ Class | Method | HTTP request | Description
 
 ## Documentation For Models
 
+ - [ClusterHighAvailabilityType](docs/ClusterHighAvailabilityType.md)
  - [ClusterSpendingLimit](docs/ClusterSpendingLimit.md)
  - [Commonv1beta1ClusterState](docs/Commonv1beta1ClusterState.md)
  - [Commonv1beta1Region](docs/Commonv1beta1Region.md)

diff --git a/pkg/tidbcloud/v1beta1/serverless/cluster/api/openapi.yaml b/pkg/tidbcloud/v1beta1/serverless/cluster/api/openapi.yaml
@@ -304,6 +304,14 @@ paths:
       - ServerlessService
 components:
   schemas:
+    ClusterHighAvailabilityType:
+      enum:
+      - ZONAL
+      - REGIONAL
+      title: |-
+        - ZONAL: High availability within a single zone
+         - REGIONAL: High availability across multiple zones within a region
+      type: string
     ClusterSpendingLimit:
       description: Message for spending limit configuration.
       properties:
@@ -652,6 +660,7 @@ components:
         spendingLimit: "{}"
         createdBy: createdBy
         createTime: 2000-01-23T04:56:07.000+00:00
+        highAvailabilityType: ZONAL
         name: name
         userPrefix: userPrefix
         state: "{}"
@@ -700,6 +709,8 @@ components:
           - $ref: '#/components/schemas/v1beta1ClusterEncryptionConfig'
           description: Optional. Encryption settings for the cluster.
           type: object
+        highAvailabilityType:
+          $ref: '#/components/schemas/ClusterHighAvailabilityType'
         version:
           description: Output_only. The TiDB version of the cluster.
           readOnly: true
@@ -761,8 +772,6 @@ components:
           - $ref: '#/components/schemas/tidb_cloud_open_apiserverlessv1beta1Cluster'
           description: Required. The cluster to be created.
           type: object
-      required:
-      - cluster
       type: object
     tidb_cloud_open_apiserverlessv1beta1ListClustersResponse:
       description: Responses message to the request for listing of TiDB Cloud Serverless
@@ -786,6 +795,7 @@ components:
           spendingLimit: "{}"
           createdBy: createdBy
           createTime: 2000-01-23T04:56:07.000+00:00
+          highAvailabilityType: ZONAL
           name: name
           userPrefix: userPrefix
           state: "{}"
@@ -806,6 +816,7 @@ components:
           spendingLimit: "{}"
           createdBy: createdBy
           createTime: 2000-01-23T04:56:07.000+00:00
+          highAvailabilityType: ZONAL
           name: name
           userPrefix: userPrefix
           state: "{}"
@@ -881,6 +892,7 @@ components:
           spendingLimit: "{}"
           createdBy: createdBy
           createTime: 2000-01-23T04:56:07.000+00:00
+          highAvailabilityType: ZONAL
           name: name
           userPrefix: userPrefix
           state: "{}"
@@ -901,6 +913,7 @@ components:
           spendingLimit: "{}"
           createdBy: createdBy
           createTime: 2000-01-23T04:56:07.000+00:00
+          highAvailabilityType: ZONAL
           name: name
           userPrefix: userPrefix
           state: "{}"
@@ -933,6 +946,7 @@ components:
           spendingLimit: "{}"
           createdBy: createdBy
           createTime: 2000-01-23T04:56:07.000+00:00
+          highAvailabilityType: ZONAL
           name: name
           userPrefix: userPrefix
           state: "{}"
@@ -953,6 +967,7 @@ components:
           spendingLimit: "{}"
           createdBy: createdBy
           createTime: 2000-01-23T04:56:07.000+00:00
+          highAvailabilityType: ZONAL
           name: name
           userPrefix: userPrefix
           state: "{}"

diff --git a/pkg/tidbcloud/v1beta1/serverless/cluster/model_cluster_high_availability_type.go b/pkg/tidbcloud/v1beta1/serverless/cluster/model_cluster_high_availability_type.go
diff --git a/...idbcloud/v1beta1/serverless/cluster/model_tidb_cloud_open_apiserverlessv1beta1_cluster.go b/...idbcloud/v1beta1/serverless/cluster/model_tidb_cloud_open_apiserverlessv1beta1_cluster.go