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

profiles API docs #3043

Merged
merged 4 commits into from
Mar 16, 2020
Merged

profiles API docs #3043

merged 4 commits into from
Mar 16, 2020

Conversation

vjeffrey
Copy link

@vjeffrey vjeffrey commented Mar 5, 2020

Signed-off-by: Victoria Jeffrey [email protected]

🔩 Description: What code changed, and why?

API docs for the profiles endpoints!

⛓️ Related Resources

#2356

👍 Definition of Done

Profiles endpoints documented

NOTE: this does not currently document the streaming profiles endpoints.

👟 How to Build and Test the Change

pull the branch down
run make serve from components/automate-chef-io
visit localhost:1313/docs/api
look at the docs!

✅ Checklist

Aha! Link: https://chef.aha.io/features/SH-558

Copy link
Contributor

@lancewf lancewf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks correct and understandable.

@susanev susanev added the documentation Anything related to the Automate docs. label Mar 6, 2020
@vjeffrey vjeffrey force-pushed the vj/profiles-api-docs branch 3 times, most recently from e73c875 to 5151785 Compare March 10, 2020 02:09
@vjeffrey vjeffrey marked this pull request as ready for review March 10, 2020 03:13
@vjeffrey vjeffrey requested a review from a team as a code owner March 10, 2020 03:13
Copy link

@kagarmoe kagarmoe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed "Read" to "Show" on the method labels & we're 👍 to merge.

Victoria Jeffrey and others added 4 commits March 15, 2020 16:50
Signed-off-by: Victoria Jeffrey <[email protected]>
Signed-off-by: kagarmoe <[email protected]>
Signed-off-by: kagarmoe <[email protected]>
Signed-off-by: kagarmoe <[email protected]>
@vjeffrey vjeffrey force-pushed the vj/profiles-api-docs branch from e9e5846 to 82dd5d5 Compare March 15, 2020 22:50
@vjeffrey
Copy link
Author

pushing a rebase

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Anything related to the Automate docs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants