Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

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.

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

Already on GitHub?Sign in to your account

Merged
DanielleMaywood merged 7 commits intomainfromdm-agent-endpoint-docs
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 includehow andwhen to use the API.

@github-actionsGitHub Actions
Copy link

github-actionsbot commentedAug 27, 2024•
edited
Loading

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

@DanielleMaywood
Copy link
ContributorAuthor

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

cdrcommunity added a commit to coder/cla that referenced this pull requestAug 27, 2024
Copy link
Member

@johnstcnjohnstcn 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.

DanielleMaywood reacted with thumbs up emoji
Copy link
Contributor

@dannykoppingdannykopping 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 runningmake coderd/apidoc/swagger.json and other targets which produce docs.

Copy link
Member

@johnstcnjohnstcn 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
ContributorAuthor

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

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

@DanielleMaywoodDanielleMaywood merged commit839918c intomainAug 28, 2024
28 checks passed
@DanielleMaywoodDanielleMaywood deleted the dm-agent-endpoint-docs branchAugust 28, 2024 08:47
@github-actionsgithub-actionsbot locked and limited conversation to collaboratorsAug 28, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account?Sign in.
Reviewers

@matifalimatifalimatifali left review comments

@dannykoppingdannykoppingdannykopping approved these changes

@johnstcnjohnstcnjohnstcn approved these changes

Assignees

@DanielleMaywoodDanielleMaywood

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
[8]ページ先頭
©2009-2025 Movatter.jp