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

[Fleet] Expand openapi docs with privileges needed for each API call #172155

Open
criamico opened this issue Nov 29, 2023 · 5 comments
Open

[Fleet] Expand openapi docs with privileges needed for each API call #172155

criamico opened this issue Nov 29, 2023 · 5 comments
Labels
docs Team:Fleet Team label for Observability Data Collection Fleet team

Comments

@criamico
Copy link
Contributor

Add privileges needed for each API call to our openapi specs. We currently don't have it documented anywhere and it can be only retrieved by looking at the code.

Example:
GET /epm/packages can be called with read privileges - let's have this info in the swagger so it's easy for customer to know what type of role they need to setup.

https://github.com/elastic/kibana/blob/bf5f8cb480cd842e6c4f630da923bbae68ae251e/x-pack/plugins/fleet/server/routes/epm/index.ts#L127C12-L127C12

readPackageInfo: fleet.all || fleet.setup || integrations.all || integrations.read,

@criamico criamico added Team:Fleet Team label for Observability Data Collection Fleet team docs labels Nov 29, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/fleet (Team:Fleet)

@criamico
Copy link
Contributor Author

@kpollich do you think we could prioritize this ticket for the upcoming sprints?

@kpollich
Copy link
Member

@criamico - Great idea. This seems like a solid quality improvement, especially considering the docs team is exploring better solutions for hosting various OpenAPI specs.

@juliaElastic
Copy link
Contributor

juliaElastic commented Jan 30, 2024

One thing to consider though is that we possibly have to get rid of our current openapi spec soon in favor of the code driven OAS generation that the kibana core team is working on. So we might want to wait for that before spending too much time on this.
Related issue: #180056

@jen-huang
Copy link
Contributor

The API privileges are also going to change soon with RBAC/space awareness work. Going to punt this by a few sprints.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Team:Fleet Team label for Observability Data Collection Fleet team
Projects
None yet
Development

No branches or pull requests

5 participants