mirror of
https://github.com/dathere/ckanaction.git
synced 2025-12-19 08:49:26 +00:00
feat(docs): add more create endpoints
This commit is contained in:
parent
46012a33d8
commit
8d0c757fa6
8 changed files with 448 additions and 0 deletions
31
docs/content/docs/group_create.mdx
Normal file
31
docs/content/docs/group_create.mdx
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
---
|
||||
title: group_create
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: group_create
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: >
|
||||
Create a new group.
|
||||
|
||||
|
||||
You must be authorized to create groups.
|
||||
|
||||
|
||||
Plugins may change the parameters of this function depending on the
|
||||
value of the `type` parameter, see the `IGroupForm` plugin interface.
|
||||
---
|
||||
|
||||
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
||||
|
||||
Create a new group.
|
||||
|
||||
You must be authorized to create groups.
|
||||
|
||||
Plugins may change the parameters of this function depending on the value of the `type` parameter, see the `IGroupForm` plugin interface.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"group_create","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
31
docs/content/docs/member_create.mdx
Normal file
31
docs/content/docs/member_create.mdx
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
---
|
||||
title: member_create
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: member_create
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: >
|
||||
Make an object (e.g. a user, dataset or group) a member of a group.
|
||||
|
||||
|
||||
If the object is already a member of the group then the capacity of
|
||||
the membership will be updated.
|
||||
|
||||
|
||||
You must be authorized to edit 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. */}
|
||||
|
||||
Make an object (e.g. a user, dataset or group) a member of a group.
|
||||
|
||||
If the object is already a member of the group then the capacity of the membership will be updated.
|
||||
|
||||
You must be authorized to edit the group.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"member_create","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
40
docs/content/docs/package_collaborator_create.mdx
Normal file
40
docs/content/docs/package_collaborator_create.mdx
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
---
|
||||
title: package_collaborator_create
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: package_collaborator_create
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: >
|
||||
Make a user a collaborator in a dataset.
|
||||
|
||||
|
||||
If the user is already a collaborator in the dataset then their
|
||||
capacity will be updated.
|
||||
|
||||
|
||||
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. */}
|
||||
|
||||
Make a user a collaborator in a dataset.
|
||||
|
||||
If the user is already a collaborator in the dataset then their capacity will be updated.
|
||||
|
||||
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_create","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
30
docs/content/docs/package_create_default_resource_views.mdx
Normal file
30
docs/content/docs/package_create_default_resource_views.mdx
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
---
|
||||
title: package_create_default_resource_views
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: package_create_default_resource_views
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: >
|
||||
Creates the default views on all resources of the provided dataset
|
||||
|
||||
|
||||
By default only view plugins that don't require the resource data to
|
||||
be in the DataStore are called. Passing `create_datastore_views` as
|
||||
`True` will only create views that require data to be in the
|
||||
DataStore. The first case happens when the function is called from
|
||||
`package_create` or `package_update`, the second when it's called from
|
||||
the DataPusher when data was uploaded to the DataStore.
|
||||
---
|
||||
|
||||
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
||||
|
||||
Creates the default views on all resources of the provided dataset
|
||||
|
||||
By default only view plugins that don't require the resource data to be in the DataStore are called. Passing `create_datastore_views` as `True` will only create views that require data to be in the DataStore. The first case happens when the function is called from `package_create` or `package_update`, the second when it's called from the DataPusher when data was uploaded to the DataStore.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"package_create_default_resource_views","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
26
docs/content/docs/package_relationship_create.mdx
Normal file
26
docs/content/docs/package_relationship_create.mdx
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
---
|
||||
title: package_relationship_create
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: package_relationship_create
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: >
|
||||
Create a relationship between two datasets (packages).
|
||||
|
||||
|
||||
You must be authorized to edit both the subject and the object
|
||||
datasets.
|
||||
---
|
||||
|
||||
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
||||
|
||||
Create a relationship between two datasets (packages).
|
||||
|
||||
You must be authorized to edit both the subject and the object datasets.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"package_relationship_create","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
42
docs/content/docs/resource_create_default_resource_views.mdx
Normal file
42
docs/content/docs/resource_create_default_resource_views.mdx
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
---
|
||||
title: resource_create_default_resource_views
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: resource_create_default_resource_views
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: >
|
||||
Creates the default views (if necessary) on the provided resource
|
||||
|
||||
|
||||
The function will get the plugins for the default views defined in the
|
||||
configuration, and if some were found the `can_view` method of each
|
||||
one of them will be called to determine if a resource view should be
|
||||
created. Resource views extensions get the resource dict and the
|
||||
parent dataset dict.
|
||||
|
||||
|
||||
If the latter is not provided, `package_show` is called to get it.
|
||||
|
||||
|
||||
By default only view plugins that don't require the resource data to
|
||||
be in the DataStore are called. See
|
||||
`ckan.logic.action.create.package_create_default_resource_views()` for
|
||||
details on the `create_datastore_views` parameter.
|
||||
---
|
||||
|
||||
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
||||
|
||||
Creates the default views (if necessary) on the provided resource
|
||||
|
||||
The function will get the plugins for the default views defined in the configuration, and if some were found the `can_view` method of each one of them will be called to determine if a resource view should be created. Resource views extensions get the resource dict and the parent dataset dict.
|
||||
|
||||
If the latter is not provided, `package_show` is called to get it.
|
||||
|
||||
By default only view plugins that don't require the resource data to be in the DataStore are called. See `ckan.logic.action.create.package_create_default_resource_views()` for details on the `create_datastore_views` parameter.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"resource_create_default_resource_views","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
20
docs/content/docs/resource_view_create.mdx
Normal file
20
docs/content/docs/resource_view_create.mdx
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
title: resource_view_create
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: resource_view_create
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: |
|
||||
Creates a new 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. */}
|
||||
|
||||
Creates a new resource view.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"resource_view_create","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
Loading…
Add table
Add a link
Reference in a new issue