Skip to content

[Serverless]: Make it easier to find APIs for Observability and Security projects #197

@ppf2

Description

@ppf2

Serverless Docs

Elastic Security
Elastic Observability

Description

The Elasticsearch project has its own "REST APIs" section which makes it easy to find its REST API reference guide.

Image

Observability and Security project do not have a dedicated section in their documentation:

https://www.elastic.co/guide/en/serverless/current/what-is-security-serverless.html
https://www.elastic.co/guide/en/serverless/current/what-is-observability-serverless.html

As a result, some users believe that these project types do not provide any APIs even though they are documented in https://www.elastic.co/docs/api/doc/serverless.

It will be helpful to enhancement the documentation. Ideas:

  • In the main Serverless guide (https://www.elastic.co/guide/en/serverless), create equivalent REST APIs sections for Observability and Security that brings users to the set of APIs that are relevant to these projects
  • In https://www.elastic.co/docs/api/doc/serverless, provide a way to filter for APIs that are relevant to a specific project type. Currently, we have an Elastic APIs hubs, but that only filters the API by "Product" (e.g. Kibana) and we don't have a filter by Project Type.

Image

Resources and additional context

https://www.elastic.co/guide/en/serverless/current/what-is-security-serverless.html
https://www.elastic.co/guide/en/serverless/current/what-is-observability-serverless.html
https://www.elastic.co/docs/api/doc/serverless

Metadata

Metadata

Assignees

No one assigned

    Labels

    Team:ExperienceIssues owned by the Experience Docs Team

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions