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

[Observability plugin] Use correct access: tags in observability plugin API routes #192730

Closed
Tracked by #186781
jasonrhodes opened this issue Sep 12, 2024 · 3 comments · Fixed by #197511
Closed
Tracked by #186781
Assignees
Labels
Team:obs-ux-management Observability Management User Experience Team v9.0.0

Comments

@jasonrhodes
Copy link
Member

jasonrhodes commented Sep 12, 2024

In the observability plugin (x-pack/plugins/observability_solution/observability), the following API routes don't appear to use the access tag for specifying whether the route is public or private/internal. We need to verify if that's the case and if so, fix them so they use this access tag (and not rely on default behavior or path conventions).

Route Intended Access
POST /api/observability/annotation public
PUT /api/observability/annotation/{id} public
DELETE /api/observability/annotation/{id} public
GET /api/observability/annotation/{id} public
GET /api/observability/annotation/find public
GET /api/observability/annotation/permissions public
GET /internal/observability/assistant/alert_details_contextual_insights private/internal
GET /api/observability/rules/alerts/dynamic_index_pattern public

Note: if any/all of these route definitions make use of the kbn-server-route-repository package, it's possible that package is applying the access tag behind the scenes, based on the route's path. We should confirm if this is the case, but also verify whether the route repository package's tools allow us to specify the explicit access tag anyway, to avoid relying on the implicit convention.

@jasonrhodes jasonrhodes added the Team:obs-ux-management Observability Management User Experience Team label Sep 12, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/obs-ux-management-team (Team:obs-ux-management)

@jasonrhodes jasonrhodes changed the title [Observability plugin] Check API routes for correct access: tags [Observability plugin] Use correct access: tags in observability plugin API routes Sep 24, 2024
@jasonrhodes
Copy link
Member Author

This is needed for v9, but not before then.

@kdelemme kdelemme self-assigned this Oct 23, 2024
@kdelemme
Copy link
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:obs-ux-management Observability Management User Experience Team v9.0.0
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants