feat: use redocs and scalar as api docs (#228)

Signed-off-by: Michele Dolfi <dol@zurich.ibm.com>
This commit is contained in:
Michele Dolfi
2025-06-17 09:54:00 -05:00
committed by GitHub
parent 196c5ce42a
commit 873d05aefe
6 changed files with 36 additions and 7 deletions

View File

@@ -132,7 +132,11 @@ class ConvertDocumentsOptions(BaseModel):
f"Allowed values: {', '.join([v.value for v in OutputFormat])}. "
"Optional, defaults to Markdown."
),
examples=[[OutputFormat.MARKDOWN]],
examples=[
[OutputFormat.MARKDOWN],
[OutputFormat.MARKDOWN, OutputFormat.JSON],
[v.value for v in OutputFormat],
],
),
] = [OutputFormat.MARKDOWN]
@@ -231,7 +235,7 @@ class ConvertDocumentsOptions(BaseModel):
PageRange,
Field(
description="Only convert a range of pages. The page number starts at 1.",
examples=[(1, 4)],
examples=[DEFAULT_PAGE_RANGE, (1, 4)],
),
] = DEFAULT_PAGE_RANGE