mirror of
https://github.com/dathere/ckanaction.git
synced 2025-11-09 22:19:49 +00:00
feat(docs): add more endpoints and remove slashes before endpoint names
This commit is contained in:
rzmk
parent
03830242c3
commit
5adb611c85
10 changed files with 346 additions and 34 deletions
24
docs/content/docs/current_package_list_with_resources.mdx
Normal file
24
docs/content/docs/current_package_list_with_resources.mdx
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
title: current_package_list_with_resources
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: current_package_list_with_resources
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: |
|
||||
Return a list of the site's datasets (packages) and their resources.
|
||||
|
||||
The list is sorted most-recently-modified first.
|
||||
---
|
||||
|
||||
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
||||
|
||||
Return a list of the site's datasets (packages) and their resources.
|
||||
|
||||
The list is sorted most-recently-modified first.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"current_package_list_with_resources","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
24
docs/content/docs/member_list.mdx
Normal file
24
docs/content/docs/member_list.mdx
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
title: member_list
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: member_list
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: |
|
||||
Return the members of a group.
|
||||
|
||||
The user must have permission to "get" the group.
|
||||
---
|
||||
|
||||
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
||||
|
||||
Return the members of a group.
|
||||
|
||||
The user must have permission to "get" the group.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"member_list","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
34
docs/content/docs/package_collaborator_list.mdx
Normal file
34
docs/content/docs/package_collaborator_list.mdx
Normal file
|
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
title: package_collaborator_list
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: package_collaborator_list
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: >
|
||||
Return the list of all collaborators for a given dataset (package).
|
||||
|
||||
|
||||
Currently you must be an Admin on the dataset owner organization to
|
||||
manage collaborators.
|
||||
|
||||
|
||||
Note: This action requires the collaborators feature to be enabled
|
||||
with the
|
||||
[`ckan.auth.allow_dataset_collaborators`](https://docs.ckan.org/en/2.11/maintaining/configuration.html#ckan-auth-allow-dataset-collaborators)
|
||||
configuration option.
|
||||
---
|
||||
|
||||
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
||||
|
||||
Return the list of all collaborators for a given dataset (package).
|
||||
|
||||
Currently you must be an Admin on the dataset owner organization to manage collaborators.
|
||||
|
||||
Note: This action requires the collaborators feature to be enabled with the [`ckan.auth.allow_dataset_collaborators`](https://docs.ckan.org/en/2.11/maintaining/configuration.html#ckan-auth-allow-dataset-collaborators) configuration option.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"package_collaborator_list","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
28
docs/content/docs/package_collaborator_list_for_user.mdx
Normal file
28
docs/content/docs/package_collaborator_list_for_user.mdx
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
---
|
||||
title: package_collaborator_list_for_user
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: package_collaborator_list_for_user
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: >
|
||||
Return the list of all datasets the user is a collaborator in.
|
||||
|
||||
|
||||
Note: This action requires the collaborators feature to be enabled
|
||||
with the
|
||||
[`ckan.auth.allow_dataset_collaborators`](https://docs.ckan.org/en/2.11/maintaining/configuration.html#ckan-auth-allow-dataset-collaborators)
|
||||
configuration option.
|
||||
---
|
||||
|
||||
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
||||
|
||||
Return the list of all datasets the user is a collaborator in.
|
||||
|
||||
Note: This action requires the collaborators feature to be enabled with the [`ckan.auth.allow_dataset_collaborators`](https://docs.ckan.org/en/2.11/maintaining/configuration.html#ckan-auth-allow-dataset-collaborators) configuration option.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"package_collaborator_list_for_user","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
|
|
@ -1,9 +1,9 @@
|
|||
---
|
||||
title: /package_list
|
||||
title: package_list
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: /package_list
|
||||
route: package_list
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
|
|
@ -15,4 +15,4 @@ _openapi:
|
|||
|
||||
This endpoint lists CKAN resources.
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"/package_list","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"package_list","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
|
|
@ -1,18 +1,72 @@
|
|||
---
|
||||
title: /package_search
|
||||
title: package_search
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: /package_search
|
||||
route: package_search
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: Searches for packages satisfying a given search criteria.
|
||||
- content: >
|
||||
Searches for packages satisfying a given search criteria.
|
||||
|
||||
|
||||
This action accepts Solr search query parameters (details below), and
|
||||
returns a dictionary of results, including dictized datasets that
|
||||
match the search criteria, a search count, and also facet information.
|
||||
|
||||
|
||||
Solr Parameters:
|
||||
|
||||
|
||||
For more in depth treatment of each parameter, please read the [Solr
|
||||
Documentation](https://solr.apache.org/guide/6_6/common-query-parameters.html).
|
||||
|
||||
|
||||
This action accepts a subset of Solr's search query parameters.
|
||||
|
||||
|
||||
The following advanced Solr parameters are supported as well. Note
|
||||
that some of these are only available on particular Solr versions. See
|
||||
Solr’s dismax and edismax documentation for further details on them:
|
||||
|
||||
|
||||
`qf`, `wt`, `bf`, `boost`, `tie`, `defType`, `mm`
|
||||
|
||||
|
||||
Examples:
|
||||
|
||||
|
||||
- `q=flood` datasets containing the word *flood*, *floods*, or
|
||||
*flooding*
|
||||
|
||||
- `fq=tags:economy` datasets with the tag *economy*
|
||||
|
||||
- `facet.field=["tags"] facet.limit=10 rows=0` top 10 tags
|
||||
---
|
||||
|
||||
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
||||
|
||||
Searches for packages satisfying a given search criteria.
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"/package_search","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
This action accepts Solr search query parameters (details below), and returns a dictionary of results, including dictized datasets that match the search criteria, a search count, and also facet information.
|
||||
|
||||
Solr Parameters:
|
||||
|
||||
For more in depth treatment of each parameter, please read the [Solr Documentation](https://solr.apache.org/guide/6_6/common-query-parameters.html).
|
||||
|
||||
This action accepts a subset of Solr's search query parameters.
|
||||
|
||||
The following advanced Solr parameters are supported as well. Note that some of these are only available on particular Solr versions. See Solr’s dismax and edismax documentation for further details on them:
|
||||
|
||||
`qf`, `wt`, `bf`, `boost`, `tie`, `defType`, `mm`
|
||||
|
||||
Examples:
|
||||
|
||||
- `q=flood` datasets containing the word *flood*, *floods*, or *flooding*
|
||||
- `fq=tags:economy` datasets with the tag *economy*
|
||||
- `facet.field=["tags"] facet.limit=10 rows=0` top 10 tags
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"package_search","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
|
|
@ -1,9 +1,9 @@
|
|||
---
|
||||
title: /package_show
|
||||
title: package_show
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: /package_show
|
||||
route: package_show
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
|
|
@ -15,4 +15,4 @@ _openapi:
|
|||
|
||||
Return the metadata of a dataset and its resources.
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"/package_show","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"package_show","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
|
|
@ -1,9 +1,9 @@
|
|||
---
|
||||
title: /status_show
|
||||
title: status_show
|
||||
full: true
|
||||
_openapi:
|
||||
method: GET
|
||||
route: /status_show
|
||||
route: status_show
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
|
|
@ -15,4 +15,4 @@ _openapi:
|
|||
|
||||
This endpoint shows information about the CKAN instance.
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"/status_show","method":"get"}]} webhooks={[]} hasHead={false} />
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"status_show","method":"get"}]} webhooks={[]} hasHead={false} />
|
||||
Loading…
Add table
Add a link
Reference in a new issue