[v2] added workflow to trigger api docs update (#88)

Author: 0xluk

.github/workflows/api-docs-update-v2.yaml

@@ -0,0 +1,19 @@
+name: Trigger Docs Update for v2
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'v2/api/archive-query-service/v2/query_services.swagger.json' # Only trigger if the swagger file changed
+
+jobs:
+  api-docs-update-trigger:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Dispatch Event
+        uses: peter-evans/repository-dispatch@v3
+        with:
+          token: ${{ secrets.GH_PAT }}
+          repository: qubic/integration
+          event-type: api-docs-update

v2/Makefile

@@ -2,7 +2,7 @@
 PROTO_DIR := $(shell pwd)/api/archive-query-service/v2
 
 # Apple arm64 specific
-OPT_ARGS := $(shell [ "$$(uname -s)" = "Darwin" ] && [ "$$(uname -m)" = "arm64" ] && echo "--proto_path=/opt/homebrew/Cellar/protobuf/25.3_1/include")
+OPT_ARGS := $(shell [ "$$(uname -s)" = "Darwin" ] && [ "$$(uname -m)" = "arm64" ] && echo "--proto_path=/opt/homebrew/Cellar/protobuf/33.1/include")
 
 # Tasks
 .PHONY: all mock-gen proto-gen proto-clean swagger-gen test-cover
@@ -28,12 +28,12 @@ proto-clean:
 	@echo "Cleaning protobuf files..."
 	cd "$(PROTO_DIR)" && \
     rm -f *.pb.go && \
-    rm -f *.go
+    rm -f *.pb.gw.go
 
 swagger-gen:
 	@echo "Generating openapi swagger files..."
 	cd "$(PROTO_DIR)" && \
-	protoc --openapiv2_out=logtostderr=true:. $(OPT_ARGS) \
+	protoc --openapiv2_out=logtostderr=true:. $(OPT_ARGS) -I "$(PROTO_DIR)" \
 		query_services.proto
 
 test-cover:

v2/api/archive-query-service/v2/query_services.swagger.json

@@ -59,7 +59,7 @@
     "/getLastProcessedTick": {
       "get": {
         "summary": "Get last processed tick",
-        "description": "Get the last processed tick and other processing information from the archive.\nAll data queried from the archive is only fully processed up to this tick.\nBefore calling the service you should check the last processed tick to be sure to get\nvalid data and do not request data for future ticks that are not processed yet. You can use\nthe epoch and initial tick information in the response to switch to a new interval.",
+        "description": "Get the last processed tick and other processing information from the archive.\nAll data queried from the archive is only fully processed up to this tick.\nBefore calling the service you should check the last processed tick to be sure to get\nvalid data and do not request data for future ticks that are not processed yet. You  can use\nthe epoch and initial tick information in the response to switch to a new interval.",
         "operationId": "ArchiveQueryService_GetLastProcessedTick",
         "responses": {
           "200": {

v2/cmd/archive-query-service/main.go

@@ -74,7 +74,7 @@ func run() error {
 			DB           int           `conf:"default:0"`
 			PoolSize     int           `conf:"default:10"`
 			MinIdleCons  int           `conf:"default:5"`
-			PoolTimeout  time.Duration `conf:"default:200s"`
+			PoolTimeout  time.Duration `conf:"default:200ms"`
 			ReadTimeout  time.Duration `conf:"default:100ms"`
 			WriteTimeout time.Duration `conf:"default:300ms"`
 		}