From 30cd3b27d70d5c2a32d09091adaeb3be8a6aa557 Mon Sep 17 00:00:00 2001 From: Prashant Dwivedi Date: Sun, 23 Jun 2024 11:13:01 +0530 Subject: [PATCH] Added description for all the gRPC APIs in README file Signed-off-by: Prashant Dwivedi --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 27ba023..947db48 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,14 @@ gRPC API: * `/grpc.health.v1.Health/Check` health checking * `/grpc.EchoService/Echo` echos the received content * `/grpc.VersionService/Version` returns podinfo version and Git commit hash +* `/grpc.DelayService/Delay` returns a successful response after the given seconds in the body of gRPC request +* `/grpc.EnvService/Env` returns environment variables as a JSON array +* `/grpc.HeaderService/Header` returns the headers present in the gRPC request. Any custom header can also be given as a part of request and that can be returned using this API +* `/grpc.InfoService/Info` returns the runtime information +* `/grpc.PanicService/Panic` crashes the process with gRPC status code as '1 CANCELLED' +* `/grpc.StatusService/Status` returns the gRPC Status code given in the request body +* `/grpc.TokenService/TokenGenerate` issues a JWT token valid for one minute +* `/grpc.TokenService/TokenValidate` validates the JWT token Web UI: