datHere/ckanaction
1
0
Fork 0
mirror of https://github.com/dathere/ckanaction.git synced 2025-11-09 14:19:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

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

Browse source
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
Download patch file Download diff file Expand all files Collapse all files

18
docs/content/docs/package_search.mdx
View file

@ -44,6 +44,18 @@ _openapi:
- `fq=tags:economy` datasets with the tag *economy* - `fq=tags:economy` datasets with the tag *economy*
- `facet.field=["tags"] facet.limit=10 rows=0` top 10 tags - `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. */} {/* 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* - `fq=tags:economy` datasets with the tag *economy*
- `facet.field=["tags"] facet.limit=10 rows=0` top 10 tags - `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} /> <APIPage document={"./lib/openapi.yml"} operations={[{"path":"package_search","method":"post"}]} webhooks={[]} hasHead={false} />

6
docs/lib/openapi.yml
View file

@ -383,6 +383,12 @@ paths:
- `q=flood` datasets containing the word *flood*, *floods*, or *flooding* - `q=flood` datasets containing the word *flood*, *floods*, or *flooding*
- `fq=tags:economy` datasets with the tag *economy* - `fq=tags:economy` datasets with the tag *economy*
- `facet.field=["tags"] facet.limit=10 rows=0` top 10 tags - `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>
requestBody: requestBody:
required: false required: false
content: content: