Skip to content

[Serverless]: Endpoint List APIs and examples result in errors #195

Open
@maggieghamry

Description

@maggieghamry

Serverless Docs

Welcome to Elastic Serverless

Description

For API endpoints such as https://www.elastic.co/docs/api/doc/serverless/operation/operation-findendpointlistitems, the examples in the documentation do not work as expected:

Attempting to use the GET /api/endpoint_list/items and GET /api/endpoint_list/items/_find APIs and getting errors.

The error reads:
{"error":"no handler found for uri [/api/endpoint_list/items] and method [GET]"}

Attempts were made with the following permutations:

  • /api/endpoint_list/items
  • /api/endpoint_list/items?id={id_value}
  • /api/endpoint_list/items?item_id={item_id_value}
  • /api/endpoint_list/items/_find?id={id_value}
  • /api/endpoint_list/items/_find?item_id={item_id_value}
  • /api/endpoint_list/items/_find?list_id={list_id_value}
  • /api/endpoint_list/items/_find?filter=id:{id_value}
  • /api/endpoint_list/items/_find?filter=item_id:{item_id_value}
  • /api/endpoint_list/items/_find?filter=list_id:{list_id_value}

The documentation for the APIs provided in the https://www.elastic.co/docs/api/doc/serverless/operation/ URL path was used to craft the API calls tested.

Unless something was missed or entered incorrectly, it doesn't seem like the documentation matches the actual behavior of the API endpoint. These APIs also appear to be in Beta phase so perhaps these are known issues that developers are still working on.

Resources and additional context

It would be helpful to clarify the Supportability and what the Beta label means in this context (hovering over does not show additional information, like preview links do):
Image

Metadata

Metadata

Labels

ServerlessImprovements and changes to the Serverless DocsbugSomething isn't workingneeds-teamIssues pending triage by the Docs Team

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions