Identity Platform API

This repo hosts all protocol buffers definitions for the Admin UI APIs. Also, Golang code generated will be here.

This repo relies on Buf for code generation and protocol buffers for APi definitions. It also relies on the grpc-gateway Buf plugin to add a REST API reverse proxy for the generated gRPC server.

Buf uses remote plugins available on its platform. In order to install the Buf CLI just run

# it's going to prompt for your password since it needs `sudo` to install
# the buf command in /usr/local/bin
make install-buf

Generate Go and Swagger files

To generate Golang files and the swagger file run

make generate

This will create all the Go files needed, and also an api.swagger.json file under the openapi folder. To get the OpenAPI v3 version of the API, run

make openapi-v3

To clean up all generated files, run

make clean

Tools

• Buf
• Protocol buffers
• grpc-gateway

Security

Please see SECURITY.md for guidelines on reporting security issues.