Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create HIP for Protocol Buffer Specification #1036

Closed

Conversation

jsync-swirlds
Copy link
Member

This pull request introduces HIP-000, titled "Protocol Buffer API Specification" The proposal aims to enhance the Hedera API declarations by adding detailed API specification text to every protocol buffer element. This API specification text is added in a manner very similar to the Java API specification by adding properly formatted comments above each API message and field. The standard protoc plugin protoc-gen-doc processes these comments, in combination with an included template, to produce markdown files that fully detail the API.

 * Initial proposed HIP text

Signed-off-by: Joseph Sinclair <joseph.sinclair@swirldslabs.com>
Copy link

netlify bot commented Aug 31, 2024

Deploy Preview for hedera-hips ready!

Name Link
🔨 Latest commit eb619e2
🔍 Latest deploy log https://app.netlify.com/sites/hedera-hips/deploys/66d26372e779ee000845b31c
😎 Deploy Preview https://deploy-preview-1036--hedera-hips.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant