|
# retoor <retoor@molodetz.nl>
|
|
|
|
from __future__ import annotations
|
|
|
|
from .spec import Action, Param
|
|
|
|
DOCS_ACTIONS: tuple[Action, ...] = (
|
|
Action(
|
|
name="search_docs",
|
|
method="LOCAL",
|
|
path="",
|
|
summary="Full-text search the DevPlace API documentation",
|
|
description=(
|
|
"Searches the platform's developer documentation and returns the most relevant "
|
|
"sections (title and content). Use it to confirm how an endpoint, parameter, or "
|
|
"feature works before acting."
|
|
),
|
|
handler="docs",
|
|
requires_auth=False,
|
|
read_only=True,
|
|
params=(
|
|
Param(
|
|
name="query",
|
|
location="body",
|
|
description="What to look for in the documentation.",
|
|
required=True,
|
|
),
|
|
Param(
|
|
name="max_results",
|
|
location="body",
|
|
description="Maximum number of documentation sections to return (1-10).",
|
|
type="integer",
|
|
),
|
|
),
|
|
),
|
|
)
|