feat(docs): add all GET endpoints for CKAN Actions API v3

This commit is contained in:
rzmk 2025-10-28 15:58:27 -04:00
parent b0f2d3e8de
commit c1343cc294
32 changed files with 1221 additions and 35 deletions

View file

@ -0,0 +1,20 @@
---
title: am_following_dataset
full: true
_openapi:
method: POST
route: am_following_dataset
toc: []
structuredData:
headings: []
contents:
- content: |
Return `True` if you're following the given dataset, `False` if not.
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Return `True` if you're following the given dataset, `False` if not.
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"am_following_dataset","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,20 @@
---
title: am_following_group
full: true
_openapi:
method: POST
route: am_following_group
toc: []
structuredData:
headings: []
contents:
- content: |
Return `True` if you're following the given group, `False` if not.
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Return `True` if you're following the given group, `False` if not.
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"am_following_group","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,20 @@
---
title: am_following_user
full: true
_openapi:
method: POST
route: am_following_user
toc: []
structuredData:
headings: []
contents:
- content: |
Return `True` if you're following the given user, `False` if not.
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Return `True` if you're following the given user, `False` if not.
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"am_following_user","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,20 @@
---
title: api_token_list
full: true
_openapi:
method: POST
route: api_token_list
toc: []
structuredData:
headings: []
contents:
- content: |
Return list of all available API tokens for the current user.
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Return list of all available API tokens for the current user.
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"api_token_list","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,21 @@
---
title: config_option_list
full: true
_openapi:
method: POST
route: config_option_list
toc: []
structuredData:
headings: []
contents:
- content: >
Return a list of runtime-editable config option keys that can be
updated with `config_option_update()`.
---
{/* 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 runtime-editable config option keys that can be updated with `config_option_update()`.
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"config_option_list","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,27 @@
---
title: config_option_show
full: true
_openapi:
method: POST
route: config_option_show
toc: []
structuredData:
headings: []
contents:
- content: >
Show the current value of a particular configuration option.
Only returns runtime-editable config options (the ones returned by
`config_option_list()`), which can be updated with the
`config_option_update()` action.
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Show the current value of a particular configuration option.
Only returns runtime-editable config options (the ones returned by `config_option_list()`), which can be updated with the `config_option_update()` action.
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"config_option_show","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,20 @@
---
title: dataset_followee_count
full: true
_openapi:
method: POST
route: dataset_followee_count
toc: []
structuredData:
headings: []
contents:
- content: |
Return the number of datasets that are followed by the given user.
---
{/* 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 number of datasets that are followed by the given user.
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"dataset_followee_count","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,20 @@
---
title: dataset_follower_count
full: true
_openapi:
method: POST
route: dataset_follower_count
toc: []
structuredData:
headings: []
contents:
- content: |
Returun the number of followers of a dataset.
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Returun the number of followers of a dataset.
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"dataset_follower_count","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,20 @@
---
title: dataset_follower_list
full: true
_openapi:
method: POST
route: dataset_follower_list
toc: []
structuredData:
headings: []
contents:
- content: |
Return the list of users that are following the given dataset.
---
{/* 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 users that are following the given dataset.
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"dataset_follower_list","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,26 @@
---
title: followee_count
full: true
_openapi:
method: POST
route: followee_count
toc: []
structuredData:
headings: []
contents:
- content: >
Return the number of objects that are followed by the given user.
Counts all objects, of any type, that the given user is following
(e.g. followed users, followed datasets, followed groups).
---
{/* 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 number of objects that are followed by the given user.
Counts all objects, of any type, that the given user is following (e.g. followed users, followed datasets, followed groups).
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"followee_count","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,26 @@
---
title: followee_list
full: true
_openapi:
method: POST
route: followee_list
toc: []
structuredData:
headings: []
contents:
- content: >
Return the list of objects that are followed by the given user.
Returns all objects, of any type, that the given user is following
(e.g. followed users, followed datasets, followed groups).
---
{/* 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 objects that are followed by the given user.
Returns all objects, of any type, that the given user is following (e.g. followed users, followed datasets, followed groups).
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"followee_list","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,20 @@
---
title: get_site_user
full: true
_openapi:
method: POST
route: get_site_user
toc: []
structuredData:
headings: []
contents:
- content: |
Return the CKAN site user.
---
{/* 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 CKAN site user.
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"get_site_user","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,20 @@
---
title: group_followee_count
full: true
_openapi:
method: POST
route: group_followee_count
toc: []
structuredData:
headings: []
contents:
- content: |
Return the number of groups that are followed by the given user.
---
{/* 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 number of groups that are followed by the given user.
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"group_followee_count","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,20 @@
---
title: group_follower_list
full: true
_openapi:
method: POST
route: group_follower_list
toc: []
structuredData:
headings: []
contents:
- content: |
Return the list of users that are following the given 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 list of users that are following the given group.
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"group_follower_list","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,20 @@
---
title: help_show
full: true
_openapi:
method: POST
route: help_show
toc: []
structuredData:
headings: []
contents:
- content: |
Return the help string for a particular API action.
---
{/* 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 help string for a particular API action.
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"help_show","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,20 @@
---
title: job_list
full: true
_openapi:
method: POST
route: job_list
toc: []
structuredData:
headings: []
contents:
- content: |
List enqueued background jobs.
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
List enqueued background jobs.
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"job_list","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,20 @@
---
title: job_show
full: true
_openapi:
method: POST
route: job_show
toc: []
structuredData:
headings: []
contents:
- content: |
Show details for a background job.
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Show details for a background job.
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"job_show","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,20 @@
---
title: member_roles_list
full: true
_openapi:
method: POST
route: member_roles_list
toc: []
structuredData:
headings: []
contents:
- content: |
Return the possible roles for members of groups and organizations.
---
{/* 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 possible roles for members of groups and organizations.
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"member_roles_list","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,21 @@
---
title: organization_followee_count
full: true
_openapi:
method: POST
route: organization_followee_count
toc: []
structuredData:
headings: []
contents:
- content: >
Return the number of organizations that are followed by the given
user.
---
{/* 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 number of organizations that are followed by the given user.
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"organization_followee_count","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,20 @@
---
title: organization_followee_list
full: true
_openapi:
method: POST
route: organization_followee_list
toc: []
structuredData:
headings: []
contents:
- content: |
Return the list of organizations that are followed by the given user.
---
{/* 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 organizations that are followed by the given user.
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"organization_followee_list","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,20 @@
---
title: organization_follower_count
full: true
_openapi:
method: POST
route: organization_follower_count
toc: []
structuredData:
headings: []
contents:
- content: |
Returun the number of followers of an organization.
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Returun the number of followers of an organization.
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"organization_follower_count","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,20 @@
---
title: organization_follower_list
full: true
_openapi:
method: POST
route: organization_follower_list
toc: []
structuredData:
headings: []
contents:
- content: |
Return the list of users that are following the given organization.
---
{/* 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 users that are following the given organization.
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"organization_follower_list","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,27 @@
---
title: tag_autocomplete
full: true
_openapi:
method: POST
route: tag_autocomplete
toc: []
structuredData:
headings: []
contents:
- content: >
Return a list of tag names that contain a given string.
By default only free tags (tags that don't belong to any vocabulary)
are searched. If the `vocabulary_id` argument is given then only tags
belonging to that vocabulary will be searched instead.
---
{/* 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 tag names that contain a given string.
By default only free tags (tags that don't belong to any vocabulary) are searched. If the `vocabulary_id` argument is given then only tags belonging to that vocabulary will be searched instead.
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"tag_autocomplete","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,27 @@
---
title: tag_search
full: true
_openapi:
method: POST
route: tag_search
toc: []
structuredData:
headings: []
contents:
- content: >
Return a list of tags whose names contain a given string.
By default only free tags (tags that don't belong to any vocabulary)
are searched. If the `vocabulary_id` argument is given then only tags
belonging to that vocabulary will be searched instead.
---
{/* 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 tags whose names contain a given string.
By default only free tags (tags that don't belong to any vocabulary) are searched. If the `vocabulary_id` argument is given then only tags belonging to that vocabulary will be searched instead.
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"tag_search","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,26 @@
---
title: task_status_show
full: true
_openapi:
method: POST
route: task_status_show
toc: []
structuredData:
headings: []
contents:
- content: >
Return a task status.
Either the `id` parameter or the `entity_id`, `task_type` *and* `key`
parameters must be given.
---
{/* 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 task status.
Either the `id` parameter or the `entity_id`, `task_type` *and* `key` parameters must be given.
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"task_status_show","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,20 @@
---
title: term_translation_show
full: true
_openapi:
method: POST
route: term_translation_show
toc: []
structuredData:
headings: []
contents:
- content: |
Return the translations for the given term(s) and language(s).
---
{/* 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 translations for the given term(s) and language(s).
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"term_translation_show","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,20 @@
---
title: user_followee_count
full: true
_openapi:
method: POST
route: user_followee_count
toc: []
structuredData:
headings: []
contents:
- content: |
Return the number of users that are followed by the given user.
---
{/* 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 number of users that are followed by the given user.
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"user_followee_count","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,20 @@
---
title: user_follower_count
full: true
_openapi:
method: POST
route: user_follower_count
toc: []
structuredData:
headings: []
contents:
- content: |
Returun the number of followers of a user.
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
Returun the number of followers of a user.
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"user_follower_count","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,20 @@
---
title: user_follower_list
full: true
_openapi:
method: POST
route: user_follower_list
toc: []
structuredData:
headings: []
contents:
- content: |
Return the list of users that are following the given user.
---
{/* 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 users that are following the given user.
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"user_follower_list","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,20 @@
---
title: vocabulary_list
full: true
_openapi:
method: POST
route: vocabulary_list
toc: []
structuredData:
headings: []
contents:
- content: |
Return a list of all the site's tag vocabularies.
---
{/* 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 all the site's tag vocabularies.
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"vocabulary_list","method":"post"}]} webhooks={[]} hasHead={false} />

View file

@ -0,0 +1,20 @@
---
title: vocabulary_show
full: true
_openapi:
method: POST
route: vocabulary_show
toc: []
structuredData:
headings: []
contents:
- content: |
Return a single tag vocabulary.
---
{/* 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 single tag vocabulary.
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"vocabulary_show","method":"post"}]} webhooks={[]} hasHead={false} />