Merge pull request #11 from Kucoin/release/2025.01.16

Release/2025.01.16

Author: SeamonYao

CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## 2025-01-16(1.1.0)
+- Updated the API sequence to be consistent with the documentation.
+- Updated the license.
+- Added Copy Trading API.
+
+## 2024-12-31(1.0.0)
+
+- Released the official version 1.0.0.

CONTRIBUTING.md

@@ -66,5 +66,8 @@ When making changes to the version of the SDK, ensure the following files are up
      ```bash
      pip install kucoin-universal-sdk==1.0.1
      ```
+     
+4. **CHANGELOG File**
+   - Add release notes to the CHANGELOG
 
 Ensure all version updates are consistent across these files before committing changes.

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 KuCoin
+Copyright (c) 2025 KuCoin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -65,6 +65,9 @@ define generate-code
 	@echo "$(GREEN)lang: $(lang), clean...$(NC)"
 	docker run --rm -v "${PWD}:/local" $(IMAGE_NAME):$(IMAGE_TAG) rm -rf $(outdir)
 
+	@echo "$(GREEN)lang: ${lang}, copy changelog...$(NC)"
+	docker run --rm -v "${PWD}:/local" $(IMAGE_NAME):$(IMAGE_TAG) cp /local/CHANGELOG.md /local/sdk/$(lang)
+
 	@make -f generate.mk generate lang=$(1) subdir=$(2)
 
 	@echo "$(GREEN)lang: $(lang), clean...$(NC)"
@@ -75,6 +78,7 @@ define generate-code
 endef
 
 define generate-postman
+	docker run --rm -v "${PWD}:/local" $(IMAGE_NAME):$(IMAGE_TAG) cp /local/CHANGELOG.md /local/sdk/postman
 	@make -f generate.mk generate-postman
 endef
 

README.md

@@ -32,7 +32,7 @@ The  **KuCoin Universal SDK** is the official SDK provided by KuCoin, offering a
 
 ## 🛠️ Installation
 
-### Latest Version: `1.0.0`
+### Latest Version: `1.1.0`
 
 ### Python Installation
 
@@ -134,6 +134,9 @@ Find usage examples for your desired language by selecting the corresponding lin
 | Python   | [sdk/python/examples/](sdk/python/example/)|
 | Go       | [sdk/go/examples/](sdk/golang/example/) |
 
+## 📋 Changelog
+
+For a detailed list of changes, see the [Changelog](./CHANGELOG.md).
 
 ## 🏗️ Technical Design
 

VERSION

@@ -1 +1 @@
-v1.0.0
+v1.1.0

generator/preprocessor/api_meta.py

@@ -8,7 +8,6 @@
 
 
 class ApiMetaUtil:
-
     doc_id = []
 
     @staticmethod
@@ -43,7 +42,7 @@ def group_api(api_collection, entry) -> dict:
                 raise Exception("illegal customApiFields" + api_name)
 
             x_fields = {
-                'x-api-doc' : api_doc,
+                'x-api-doc': api_doc,
             }
             for k in api_fields:
                 x_fields[f'x-{k}'] = api_fields[k]
@@ -256,7 +255,7 @@ def generate_path_operation(api):
                     result = {
                         'name': query_para['name'],
                         'in': 'query',
-                        'description':  ApiMetaUtil.escape_url(query_para['description'], ApiMetaUtil.doc_id),
+                        'description': ApiMetaUtil.escape_url(query_para['description'], ApiMetaUtil.doc_id),
                         'required': query_para['required'],
                         'schema': schema,
                     }
@@ -361,8 +360,11 @@ def generator_openapi(service, api_collection, entry):
         paths = {}
         schemas = {}
 
+        api_idx = 0
         for api in api_collection:
+            api_idx = api_idx + 1
             path_operation = ApiMetaUtil.generate_path_operation(api)
+            path_operation['operationId'] = "{:03d}".format(api_idx)
             method = api['api']['method']
             path = api['api']['path']
 

sdk/golang/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## 2025-01-16(1.1.0)
+- Updated the API sequence to be consistent with the documentation.
+- Updated the license.
+- Added Copy Trading API.
+
+## 2024-12-31(1.0.0)
+
+- Released the official version 1.0.0.

sdk/golang/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 KuCoin
+Copyright (c) 2025 KuCoin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

sdk/golang/README.md

@@ -9,7 +9,7 @@ For an overview of the project and SDKs in other languages, refer to the [Main R
 
 ## 📦 Installation
 
-### Latest Version: `1.0.0`
+### Latest Version: `1.1.0`
 Install the Golang SDK using `go get`:
 
 ```bash
@@ -88,6 +88,9 @@ Official Documentation: [KuCoin API Docs](https://www.kucoin.com/docs-new)
 
 Explore more examples in the [example/](example/) directory for advanced usage.
 
+## 📋 Changelog
+
+For a detailed list of changes, see the [Changelog](./CHANGELOG.md).
 
 ## 📌 Special Notes on APIs