Skip to content

Add proto documentation #161

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 7 commits into from
Jan 17, 2023
Merged

Add proto documentation #161

merged 7 commits into from
Jan 17, 2023

Conversation

@dhurley
Copy link
Collaborator

@dhurley dhurley commented Jan 10, 2023 •
edited
Loading

Proposed changes

  • Add documentation for the proto definitions.
  • Updated make format to also format the .proto files.
  • Updated make deps to also generate swagger.json.
  • Ignore swagger annotations in proto documentation. (This was required for the cases where we use the same object for both gRPC and the REST API)

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING document
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • If applicable, I have checked that any relevant tests pass after adding my changes
  • I have updated any relevant documentation (README.md)

@netlify
Copy link

netlify bot commented Jan 10, 2023 •
edited
Loading

✅ Deploy Preview for agent-public-docs canceled.

Name Link
🔨 Latest commit 315049e
🔍 Latest deploy log https://app.netlify.com/sites/agent-public-docs/deploys/63c66f215a598000082ff3ef

@github-actions github-actions bot added dependencies documentation Improvements or additions to documentation labels Jan 10, 2023
@dhurley dhurley requested a review from mtbChef January 10, 2023 10:01
@dhurley dhurley self-assigned this Jan 10, 2023
@dhurley dhurley merged commit 1715142 into main Jan 17, 2023
@dhurley dhurley deleted the add-proto-docs branch January 17, 2023 10:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@craigell craigell craigell approved these changes

@aphralG aphralG aphralG approved these changes

@oliveromahony oliveromahony Awaiting requested review from oliveromahony

@mtbChef mtbChef Awaiting requested review from mtbChef

+1 more reviewer

@Dean-Coakley Dean-Coakley Dean-Coakley approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@dhurley dhurley

Labels

dependencies documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@dhurley @Dean-Coakley @craigell @aphralG