Skip to content

chore(docs): document agent api debug endpoints #14454

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
Aug 28, 2024
Merged

chore(docs): document agent api debug endpoints #14454

merged 7 commits into from
Aug 28, 2024

Conversation

DanielleMaywood
Copy link
Contributor

relates to #14362

For now this is just handwritten (so no Swagger involved) documentation. It covers the four agent debug endpoints: /debug/logs, /debug/magicsock, /debug/magicsock/debug-logging/{state} and /debug/manifest.

Future work should aim to include how and when to use the API.

@github-actions GitHub Actions
Copy link

github-actions bot commented Aug 27, 2024 •
edited
Loading

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@DanielleMaywood
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

cdrcommunity added a commit to coder/cla that referenced this pull request Aug 27, 2024
@cdrcommunity
@DanielleMaywood has signed the CLA in coder/coder#14454
4c89b41
johnstcn
johnstcn reviewed Aug 27, 2024
View reviewed changes
Copy link
Member

@johnstcn johnstcn left a comment

Choose a reason for hiding this comment

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

I think the markdown link checker needs the full filename for local paths.

dannykopping
dannykopping approved these changes Aug 28, 2024
View reviewed changes
Copy link
Contributor

@dannykopping dannykopping left a comment

Choose a reason for hiding this comment

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

LGTM

For now this is just handwritten (so no Swagger involved) documentation.
It would be helpful if you clarified what exactly was manually written, if not all of it.

One other thing to check is that this won't be overwritten by running make coderd/apidoc/swagger.json and other targets which produce docs.

johnstcn
johnstcn approved these changes Aug 28, 2024
View reviewed changes
Copy link
Member

@johnstcn johnstcn left a comment

Choose a reason for hiding this comment

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

Nice work! 👍

@DanielleMaywood
Copy link
Contributor Author

One other thing to check is that this won't be overwritten by running make coderd/apidoc/swagger.json and other targets which produce docs.

I just ran make coderd/apidoc/swagger.json followed by a git diff and there is no diff produced and by manual inspection appears nothing has changed so I think we're good.

@DanielleMaywood DanielleMaywood merged commit 839918c into main Aug 28, 2024
28 checks passed
@DanielleMaywood DanielleMaywood deleted the dm-agent-endpoint-docs branch August 28, 2024 08:47
@github-actions github-actions bot locked and limited conversation to collaborators Aug 28, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@matifali matifali matifali left review comments

@dannykopping dannykopping dannykopping approved these changes

@johnstcn johnstcn johnstcn approved these changes

Assignees

@DanielleMaywood DanielleMaywood

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@DanielleMaywood @dannykopping @johnstcn @matifali