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.

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

document external profiles proto for api docs #2356

Closed
vjeffrey opened this issue Nov 23, 2019 · 0 comments
Closed

document external profiles proto for api docs #2356

vjeffrey opened this issue Nov 23, 2019 · 0 comments
Assignees
@vjeffrey
Labels
documentation Anything related to the Automate docs.

Comments

@vjeffrey
Copy link

vjeffrey commented Nov 23, 2019 •
edited
Loading

User Story

In order to properly display api documentation for the profiles apis, we need to document the externally exposed protobuf file(s).
For reference, please see: #1412

Definition of Done

Protobuf file in https://github.com/chef/automate/blob/master/components/automate-gateway/api/compliance/profiles/profiles.proto is well documented, checked for content/accuracy/formatting in local docs build.

Aha! Link: https://chef.aha.io/features/SH-582
@vjeffrey vjeffrey added the documentation Anything related to the Automate docs. label Nov 23, 2019
@phiggins phiggins mentioned this issue Jan 15, 2020
Merged
@vjeffrey vjeffrey self-assigned this Mar 5, 2020
@vjeffrey vjeffrey mentioned this issue Mar 5, 2020
Merged
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@vjeffrey vjeffrey

Labels
documentation Anything related to the Automate docs.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@vjeffrey