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

[Docs] Add documentation for manually testing Fleet Server API endpoints #3422

Open
kpollich opened this issue Apr 2, 2024 · 2 comments
Open
Labels
Team:Elastic-Agent-Control-Plane Label for the Agent Control Plane team

Comments

@kpollich
Copy link
Member

kpollich commented Apr 2, 2024

Fleet Server's API endpoints (e.g. check in) require an active agent API key and some knowledge of how to provide that API key. We should document the process by which API endpoints can be manually tested either through cURL or an API client (e.g. Postman, Thunder Client, Insomnia, etc) so developers can sanity check updates to API endpoints outside of just unit/integration tests.

These docs should be added to the README.

@kpollich kpollich added the Team:Fleet Label for the Fleet team label Apr 2, 2024
@jlind23 jlind23 added Team:Elastic-Agent-Control-Plane Label for the Agent Control Plane team and removed Team:Fleet Label for the Fleet team labels Jun 4, 2024
@jlind23
Copy link
Contributor

jlind23 commented Jun 4, 2024

@kilfoyle do you believe this is something you can take on?

@kilfoyle
Copy link

kilfoyle commented Jun 4, 2024

@jlind23 I think these are internal docs (for the readme). I'm happy to help and/or review, but I'd need someone from development to provide the draft content.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Elastic-Agent-Control-Plane Label for the Agent Control Plane team
Projects
None yet
Development

No branches or pull requests

3 participants