https://github.com/temporalio/api
Temporal gRPC API and proto files
https://github.com/temporalio/api
api grpc protobuf
Last synced: 8 days ago
JSON representation
Temporal gRPC API and proto files
- Host: GitHub
- URL: https://github.com/temporalio/api
- Owner: temporalio
- License: mit
- Created: 2019-10-28T20:14:20.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2026-01-23T23:58:36.000Z (16 days ago)
- Last Synced: 2026-01-26T14:38:43.006Z (14 days ago)
- Topics: api, grpc, protobuf
- Language: Makefile
- Homepage: https://temporal.io
- Size: 2.36 MB
- Stars: 127
- Watchers: 25
- Forks: 84
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- grpc-protos - temporalio/api
README
# Temporal proto files
This repository contains both the protobuf descriptors and OpenAPI documentation for the Temporal platform.
## How to use
Install as git submodule to the project.
## Contribution
Make your change to the temporal/proto files, and run `make` to update the openapi definitions.
## Breaking changes
Sometimes during initial feature development, there will be breaking API changes made. Running `make` will
catch these changes and fail CI. If the breaking change is for a feature not yet released, a temporary `ignore`
line can be added to `buf.yaml` to pass CI. This is
[an example](https://github.com/temporalio/api/pull/608/files#diff-1a5ba9cba93e971f532139f694d7da802776bfe578e3f753b9c3f25968dbf42dL16)
of adding such an exception. A subsequent PR will be needed to then disable to exception once it's been merged in.
## License
MIT License, please see [LICENSE](LICENSE) for details.