Skip to content

README.md

Latest commit

 

History

History
28 lines (19 loc) · 1.2 KB

README.md

File metadata and controls

28 lines (19 loc) · 1.2 KB

API Spec

Schema of the external API types that are served by the Identity Service components. You can find the latest generated API Spec in the Identity Service API Specs documentation.

Prerequisites

To generate the API specs, you need to have the following installed:

Development

To generate the API specs, first make sure that Docker is running locally and then run the following command from the root of the repository:

make generate_proto

This will generate the Protobuf definitions, the OpenAPI specs and the gRPC stubs for the Node backend and the Issuer client.

Note

The Go code will be generated in the backend/api directory. The Proto definitions are generated in the /backend/api/spec/proto directory. The Proto Messages and Enums are generated from the Go types from the core package. The Protobuf Services are generated from the backend/api/spec/proto directory. The Proto Documentation, the OpenAPI Client and the JSON Schema will be generated in the backend/api/spec/static directory.
⚡