Skip to content

Commit 43ad578

Browse files
yurishkuroclaude
andauthored
Remove dead grpc-gateway and zipkin swagger artifacts (#197)
- Remove grpc-gateway protoc step for api_v3: the generated .pb.gw.go goes to a gitignored directory and is not published or used by Jaeger, which implements HTTP-to-gRPC transcoding manually. - Remove proto/api_v3/query_service_http.yaml: it was only used by the grpc-gateway step and is now fully superseded by inline google.api.http annotations in the proto file. - Remove swagger/zipkin2-api.yaml and its swagger-validate target: the file is an upstream copy validated only as a sanity check; no artifact is produced or consumed by Jaeger from it. - Remove SWAGGER/SWAGGER_VER/SWAGGER_IMAGE vars and PROTOC_INTERNAL var, which are now unused. ## AI Usage in this PR (choose one) - [x] **Heavy**: AI generated most or all of the code changes --------- Signed-off-by: Yuri Shkuro <github@ysh.us> Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent b8a3030 commit 43ad578

5 files changed

Lines changed: 5 additions & 1402 deletions

File tree

AGENTS.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ The project uses a `Makefile` that heavily relies on Docker (specifically `jaege
1919
- Removes unused schemas (e.g., transitively imported Gnostic types).
2020
- Patches duplicate `operationId`s (e.g., `QueryService_FindTraces` -> `QueryService_FindTracesPost`).
2121

22+
## Git sign-off
23+
24+
When committing always include -s flag for sign-off footer.
25+
2226
## Working with GitHub CLI (`gh`)
2327

2428
To effectively gather context from Pull Requests, especially for review comments:

Makefile

Lines changed: 1 addition & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@ THRIFT_VER?=0.19
88
THRIFT_IMG?=jaegertracing/thrift:$(THRIFT_VER)
99
THRIFT=docker run --rm -u $(shell id -u) -v "${PWD}:/data" $(THRIFT_IMG) thrift
1010

11-
SWAGGER_VER=0.31.0
12-
SWAGGER_IMAGE=quay.io/goswagger/swagger:$(SWAGGER_VER)
13-
SWAGGER=docker run --rm -u ${shell id -u} -v "${PWD}:/go/src/${PROJECT_ROOT}" -w /go/src/${PROJECT_ROOT} $(SWAGGER_IMAGE)
1411

1512
PROTOC_VER=0.5.1
1613
PROTOC_IMAGE=jaegertracing/protobuf:$(PROTOC_VER)
@@ -71,13 +68,9 @@ $(PRUNE_OPENAPI): $(TOOLS_BIN_DIR)
7168
cd $(TOOLS_MOD_DIR) && go build -o $@ ./prune-openapi
7269

7370
.PHONY: test-code-gen
74-
test-code-gen: thrift-all swagger-validate proto-all proto-zipkin
75-
git diff --exit-code ./swagger/api_v3/query_service.swagger.json
71+
test-code-gen: thrift-all proto-all proto-zipkin
7672
git diff --exit-code ./swagger/api_v3/query_service.openapi.yaml
7773

78-
.PHONY: swagger-validate
79-
swagger-validate:
80-
$(SWAGGER) validate ./swagger/zipkin2-api.yaml
8174

8275
.PHONY: clean
8376
clean:
@@ -170,10 +163,6 @@ PROTOC_WITH_GRPC := $(PROTOC_WITH_GRPC_common) \
170163
--grpc-csharp_out=${PROTO_GEN_CSHARP_DIR_POLYGLOT}
171164
endif
172165

173-
PROTOC_INTERNAL := $(PROTOC) \
174-
$(PROTO_INCLUDES) \
175-
--csharp_out=internal_access,base_namespace:${PROTO_GEN_CSHARP_DIR_POLYGLOT} \
176-
--python_out=${PROTO_GEN_PYTHON_DIR_POLYGLOT}
177166

178167
GO=go
179168
GOOS ?= $(shell $(GO) env GOOS)
@@ -313,23 +302,6 @@ proto-api-v3-all:
313302
# API v3
314303
$(PROTOC_WITH_GRPC) \
315304
proto/api_v3/query_service.proto
316-
# GRPC gateway
317-
$(PROTOC) \
318-
$(PROTO_INCLUDES) \
319-
--grpc-gateway_out=logtostderr=true,grpc_api_configuration=proto/api_v3/query_service_http.yaml,$(PROTO_GOGO_MAPPINGS):${PROTO_GEN_GO_DIR_POLYGLOT} \
320-
proto/api_v3/query_service.proto
321-
# Swagger
322-
$(PROTOC) \
323-
$(PROTO_INCLUDES) \
324-
--swagger_out=disable_default_errors=true,logtostderr=true,grpc_api_configuration=proto/api_v3/query_service_http.yaml:./swagger \
325-
proto/api_v3/query_service.proto
326-
327-
$(PROTOC_INTERNAL) \
328-
google/api/annotations.proto \
329-
google/api/http.proto \
330-
protoc-gen-swagger/options/annotations.proto \
331-
protoc-gen-swagger/options/openapiv2.proto \
332-
gogoproto/gogo.proto
333305
# OpenAPI v3
334306
$(MAKE) proto-api-v3-openapi
335307

proto/api_v3/query_service_http.yaml

Lines changed: 0 additions & 14 deletions
This file was deleted.

0 commit comments

Comments
 (0)