mirror of
https://github.com/dathere/ckanaction.git
synced 2025-11-09 22:19:49 +00:00
feat(docs): add more endpoints
This commit is contained in:
parent
6d843632ff
commit
e13124ee42
15 changed files with 653 additions and 54 deletions
18
docs/content/docs/group_package_show.mdx
Normal file
18
docs/content/docs/group_package_show.mdx
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
title: group_package_show
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: group_package_show
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: Return the datasets (packages) of a 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 datasets (packages) of a group.
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"group_package_show","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
20
docs/content/docs/group_show.mdx
Normal file
20
docs/content/docs/group_show.mdx
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
title: group_show
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: group_show
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: >-
|
||||
Return the details of a group (only its first 1000 datasets are
|
||||
returned).
|
||||
---
|
||||
|
||||
{/* 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 details of a group (only its first 1000 datasets are returned).
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"group_show","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
20
docs/content/docs/license_list.mdx
Normal file
20
docs/content/docs/license_list.mdx
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
title: license_list
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: license_list
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: |
|
||||
Return the list of licenses available for datasets on the site.
|
||||
---
|
||||
|
||||
{/* 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 licenses available for datasets on the site.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"license_list","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
58
docs/content/docs/organization_list_for_user.mdx
Normal file
58
docs/content/docs/organization_list_for_user.mdx
Normal file
|
|
@ -0,0 +1,58 @@
|
|||
---
|
||||
title: organization_list_for_user
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: organization_list_for_user
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: >
|
||||
Return the organizations that the user has a given permission for.
|
||||
|
||||
|
||||
Specifically it returns the list of organizations that the currently
|
||||
authorized user has a given permission (for example: "manage_group")
|
||||
against.
|
||||
|
||||
|
||||
By default this returns the list of organizations that the currently
|
||||
authorized user is member of, in any capacity.
|
||||
|
||||
|
||||
When a user becomes a member of an organization in CKAN they're given
|
||||
a "capacity" (sometimes called a "role"), for example "member",
|
||||
"editor" or "admin".
|
||||
|
||||
|
||||
Each of these roles has certain permissions associated with it. For
|
||||
example the admin role has the "admin" permission (which means they
|
||||
have permission to do anything). The editor role has permissions like
|
||||
"create_dataset", "update_dataset" and "delete_dataset". The member
|
||||
role has the "read" permission.
|
||||
|
||||
|
||||
This function returns the list of organizations that the authorized
|
||||
user has a given permission for. For example the list of organizations
|
||||
that the user is an admin of, or the list of organizations that the
|
||||
user can create datasets in. This takes account of when permissions
|
||||
cascade down an organization hierarchy.
|
||||
---
|
||||
|
||||
{/* 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 organizations that the user has a given permission for.
|
||||
|
||||
Specifically it returns the list of organizations that the currently authorized user has a given permission (for example: "manage_group") against.
|
||||
|
||||
By default this returns the list of organizations that the currently authorized user is member of, in any capacity.
|
||||
|
||||
When a user becomes a member of an organization in CKAN they're given a "capacity" (sometimes called a "role"), for example "member", "editor" or "admin".
|
||||
|
||||
Each of these roles has certain permissions associated with it. For example the admin role has the "admin" permission (which means they have permission to do anything). The editor role has permissions like "create_dataset", "update_dataset" and "delete_dataset". The member role has the "read" permission.
|
||||
|
||||
This function returns the list of organizations that the authorized user has a given permission for. For example the list of organizations that the user is an admin of, or the list of organizations that the user can create datasets in. This takes account of when permissions cascade down an organization hierarchy.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"organization_list_for_user","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
20
docs/content/docs/organization_show.mdx
Normal file
20
docs/content/docs/organization_show.mdx
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
title: organization_show
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: organization_show
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: >-
|
||||
Return the details of an organization (only its first 10 datasets are
|
||||
returned).
|
||||
---
|
||||
|
||||
{/* 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 details of an organization (only its first 10 datasets are returned).
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"organization_show","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
20
docs/content/docs/package_relationships_list.mdx
Normal file
20
docs/content/docs/package_relationships_list.mdx
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
title: package_relationships_list
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: package_relationships_list
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: |
|
||||
Return a datset's relationships.
|
||||
---
|
||||
|
||||
{/* 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 datset's relationships.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"package_relationships_list","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
|
|
@ -29,7 +29,7 @@ _openapi:
|
|||
|
||||
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:
|
||||
Solr's dismax and edismax documentation for further details on them:
|
||||
|
||||
|
||||
`qf`, `wt`, `bf`, `boost`, `tie`, `defType`, `mm`
|
||||
|
|
@ -70,7 +70,7 @@ For more in depth treatment of each parameter, please read the [Solr Documentati
|
|||
|
||||
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:
|
||||
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`
|
||||
|
||||
|
|
|
|||
18
docs/content/docs/resource_show.mdx
Normal file
18
docs/content/docs/resource_show.mdx
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
title: resource_show
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: resource_show
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: Return the metadata of a resource.
|
||||
---
|
||||
|
||||
{/* 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 metadata of a resource.
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"resource_show","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
18
docs/content/docs/resource_view_list.mdx
Normal file
18
docs/content/docs/resource_view_list.mdx
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
title: resource_view_list
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: resource_view_list
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: Return the list of resource views for a particular resource.
|
||||
---
|
||||
|
||||
{/* 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 resource views for a particular resource.
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"resource_view_list","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
18
docs/content/docs/resource_view_show.mdx
Normal file
18
docs/content/docs/resource_view_show.mdx
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
title: resource_view_show
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: resource_view_show
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: Return the metadata of a resource_view.
|
||||
---
|
||||
|
||||
{/* 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 metadata of a resource_view.
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"resource_view_show","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
27
docs/content/docs/tag_list.mdx
Normal file
27
docs/content/docs/tag_list.mdx
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
---
|
||||
title: tag_list
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: tag_list
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: >
|
||||
Return a list of the site's tags.
|
||||
|
||||
|
||||
By default only free tags (tags that don't belong to a vocabulary) are
|
||||
returned. If the `vocabulary_id` argument is given then only tags
|
||||
belonging to that vocabulary will be returned 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 the site's tags.
|
||||
|
||||
By default only free tags (tags that don't belong to a vocabulary) are returned. If the `vocabulary_id` argument is given then only tags belonging to that vocabulary will be returned instead.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"tag_list","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
18
docs/content/docs/tag_show.mdx
Normal file
18
docs/content/docs/tag_show.mdx
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
title: tag_show
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: tag_show
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: Return the details of a tag and all its datasets.
|
||||
---
|
||||
|
||||
{/* 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 details of a tag and all its datasets.
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"tag_show","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
20
docs/content/docs/user_list.mdx
Normal file
20
docs/content/docs/user_list.mdx
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
title: user_list
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: user_list
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: |
|
||||
Return a list of the site's user accounts.
|
||||
---
|
||||
|
||||
{/* 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 user accounts.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"user_list","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
24
docs/content/docs/user_show.mdx
Normal file
24
docs/content/docs/user_show.mdx
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
title: user_show
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: user_show
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: |
|
||||
Return a user account.
|
||||
|
||||
Either the `id` should be passed or the user should be logged in.
|
||||
---
|
||||
|
||||
{/* 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 user account.
|
||||
|
||||
Either the `id` should be passed or the user should be logged in.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"user_show","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
Loading…
Add table
Add a link
Reference in a new issue