* first commit for go 1.26 fix golangci-lint fix Makefile golang-ci-lint remove -goroutineleak flag fix golangci-lint new introduced error ignore new golangci-lint warnings disable newexpr which cause false warning fix cursor suggestion * fix comment * Add disable newexpr * Fix ci proxy fail * go mod tidy under ray-operator --------- Signed-off-by: Yuan Hao Ku <[email protected]>
Protocol Buffer API Definitions
This directory contains API definitions written in Protocol Buffers. These definitions will be used for building services.
Prerequisites
To successfully run the generation commands, ensure the following tools are installed in your environment:
Run the following command to build the proto-generator image. This image will be used for generating APIs:
Note: You can actually skip this step, and a prebuilt image will be downloaded instead.
make build-image
Automatic Generation
Go Client and Swagger
make generate
Clients
We postpone the client generation until there is a need for external service communication.
API Reference Documentation
Use the tools bootprint-openapi and html-inline to generate API reference documentation from the Swagger files. For more information on the API and architecture, refer to the design document.
Third-Party Protos
Third-party proto dependencies are synchronized back to proto/third_party for easier development
(IDE friendly). Ideally, the directory for searching imports should be specified instead.
protoc -I.
-I/go/src/github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis \
-I/go/src/github.com/grpc-ecosystem/grpc-gateway/ \
-I/go/src/github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger/options/ \
Sources: