chore(docs): add error callout about facet field for package_search

This commit is contained in:
rzmk 2025-10-22 15:20:07 -04:00
parent 20c5d749d8
commit 6d843632ff
2 changed files with 24 additions and 0 deletions

View file

@ -44,6 +44,18 @@ _openapi:
- `fq=tags:economy` datasets with the tag *economy*
- `facet.field=["tags"] facet.limit=10 rows=0` top 10 tags
<Callout title="Title" type="error">
There is an issue for the Body dropdown within this UI where an empty
object `{}` is set for the `facet` field.
Please either remove this field by clicking "Open JSON editor" in the
Body dropdown or set it to `true` (the default value) or `false`.
</Callout>
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
@ -68,5 +80,11 @@ Examples:
- `fq=tags:economy` datasets with the tag *economy*
- `facet.field=["tags"] facet.limit=10 rows=0` top 10 tags
<Callout title="Title" type="error">
There is an issue for the Body dropdown within this UI where an empty object `{}` is set for the `facet` field.
Please either remove this field by clicking "Open JSON editor" in the Body dropdown or set it to `true` (the default value) or `false`.
</Callout>
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"package_search","method":"post"}]} webhooks={[]} hasHead={false} />