mirror of
https://github.com/dathere/ckanaction.git
synced 2025-12-19 08:49:26 +00:00
feat(docs): add all update endpoints
This commit is contained in:
parent
e9b220462b
commit
fc7aa9da36
21 changed files with 1617 additions and 0 deletions
20
docs/content/docs/bulk_update_delete.mdx
Normal file
20
docs/content/docs/bulk_update_delete.mdx
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
title: bulk_update_delete
|
||||
full: true
|
||||
_openapi:
|
||||
method: PUT
|
||||
route: bulk_update_delete
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: |
|
||||
Make a list of datasets deleted.
|
||||
---
|
||||
|
||||
{/* 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 list of datasets deleted.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"bulk_update_delete","method":"put"}]} webhooks={[]} hasHead={false} />
|
||||
20
docs/content/docs/bulk_update_private.mdx
Normal file
20
docs/content/docs/bulk_update_private.mdx
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
title: bulk_update_private
|
||||
full: true
|
||||
_openapi:
|
||||
method: PUT
|
||||
route: bulk_update_private
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: |
|
||||
Make a list of datasets private.
|
||||
---
|
||||
|
||||
{/* 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 list of datasets private.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"bulk_update_private","method":"put"}]} webhooks={[]} hasHead={false} />
|
||||
20
docs/content/docs/bulk_update_public.mdx
Normal file
20
docs/content/docs/bulk_update_public.mdx
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
title: bulk_update_public
|
||||
full: true
|
||||
_openapi:
|
||||
method: PUT
|
||||
route: bulk_update_public
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: |
|
||||
Make a list of datasets public.
|
||||
---
|
||||
|
||||
{/* 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 list of datasets public.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"bulk_update_public","method":"put"}]} webhooks={[]} hasHead={false} />
|
||||
69
docs/content/docs/config_option_update.mdx
Normal file
69
docs/content/docs/config_option_update.mdx
Normal file
|
|
@ -0,0 +1,69 @@
|
|||
---
|
||||
title: config_option_update
|
||||
full: true
|
||||
_openapi:
|
||||
method: PUT
|
||||
route: config_option_update
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: >
|
||||
Added in version 2.4.
|
||||
|
||||
|
||||
Allows to modify some CKAN runtime-editable config options
|
||||
|
||||
|
||||
It takes arbitrary key, value pairs and checks the keys against the
|
||||
config options update schema. If some of the provided keys are not
|
||||
present in the schema a `ValidationError` is raised. The values are
|
||||
then validated against the schema, and if validation is passed, for
|
||||
each key, value config option:
|
||||
|
||||
|
||||
- It is stored on the `system_info` database table
|
||||
|
||||
- The Pylons `config` object is updated.
|
||||
|
||||
- The `app_globals` (`g`) object is updated (this only happens for
|
||||
options explicitly defined in the `app_globals` module.
|
||||
|
||||
|
||||
<Callout title="Note">You can see all available runtime-editable
|
||||
configuration options calling the `config_option_list()`
|
||||
action.</Callout>
|
||||
|
||||
|
||||
<Callout title="Note">Extensions can modify which configuration
|
||||
options are runtime-editable. For details, check [Making configuration
|
||||
options
|
||||
runtime-editable](https://docs.ckan.org/en/2.11/extensions/remote-config-update.html).</Callout>
|
||||
|
||||
|
||||
<Callout title="Warning" type="warn">You should only add config
|
||||
options that you are comfortable they can be edited during runtime,
|
||||
such as ones you've added in your own extension, or have reviewed the
|
||||
use of in core CKAN.</Callout>
|
||||
---
|
||||
|
||||
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
||||
|
||||
Added in version 2.4.
|
||||
|
||||
Allows to modify some CKAN runtime-editable config options
|
||||
|
||||
It takes arbitrary key, value pairs and checks the keys against the config options update schema. If some of the provided keys are not present in the schema a `ValidationError` is raised. The values are then validated against the schema, and if validation is passed, for each key, value config option:
|
||||
|
||||
- It is stored on the `system_info` database table
|
||||
- The Pylons `config` object is updated.
|
||||
- The `app_globals` (`g`) object is updated (this only happens for options explicitly defined in the `app_globals` module.
|
||||
|
||||
<Callout title="Note">You can see all available runtime-editable configuration options calling the `config_option_list()` action.</Callout>
|
||||
|
||||
<Callout title="Note">Extensions can modify which configuration options are runtime-editable. For details, check [Making configuration options runtime-editable](https://docs.ckan.org/en/2.11/extensions/remote-config-update.html).</Callout>
|
||||
|
||||
<Callout title="Warning" type="warn">You should only add config options that you are comfortable they can be edited during runtime, such as ones you've added in your own extension, or have reviewed the use of in core CKAN.</Callout>
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"config_option_update","method":"put"}]} webhooks={[]} hasHead={false} />
|
||||
39
docs/content/docs/group_update.mdx
Normal file
39
docs/content/docs/group_update.mdx
Normal file
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
title: group_update
|
||||
full: true
|
||||
_openapi:
|
||||
method: PUT
|
||||
route: group_update
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: >
|
||||
Update a group.
|
||||
|
||||
|
||||
You must be authorized to edit the group.
|
||||
|
||||
|
||||
<Callout title="Note">Update methods may delete parameters not
|
||||
explicitly provided in the data_dict. If you want to edit only a
|
||||
specific attribute use `group_patch` instead.</Callout>
|
||||
|
||||
|
||||
Plugins may change the parameters of this function depending on the
|
||||
value of the group's `type` attribute, 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. */}
|
||||
|
||||
Update a group.
|
||||
|
||||
You must be authorized to edit the group.
|
||||
|
||||
<Callout title="Note">Update methods may delete parameters not explicitly provided in the data_dict. If you want to edit only a specific attribute use `group_patch` instead.</Callout>
|
||||
|
||||
Plugins may change the parameters of this function depending on the value of the group's `type` attribute, see the `IGroupForm` plugin interface.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"group_update","method":"put"}]} webhooks={[]} hasHead={false} />
|
||||
32
docs/content/docs/organization_update.mdx
Normal file
32
docs/content/docs/organization_update.mdx
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
---
|
||||
title: organization_update
|
||||
full: true
|
||||
_openapi:
|
||||
method: PUT
|
||||
route: organization_update
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: >
|
||||
Update an organization.
|
||||
|
||||
|
||||
You must be authorized to edit the organization.
|
||||
|
||||
|
||||
<Callout title="Note">Update methods may delete parameters not
|
||||
explicitly provided in the data_dict. If you want to edit only a
|
||||
specific attribute use `organization_patch` instead.</Callout>
|
||||
---
|
||||
|
||||
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
||||
|
||||
Update an organization.
|
||||
|
||||
You must be authorized to edit the organization.
|
||||
|
||||
<Callout title="Note">Update methods may delete parameters not explicitly provided in the data_dict. If you want to edit only a specific attribute use `organization_patch` instead.</Callout>
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"organization_update","method":"put"}]} webhooks={[]} hasHead={false} />
|
||||
20
docs/content/docs/package_owner_org_update.mdx
Normal file
20
docs/content/docs/package_owner_org_update.mdx
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
title: package_owner_org_update
|
||||
full: true
|
||||
_openapi:
|
||||
method: PUT
|
||||
route: package_owner_org_update
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: |
|
||||
Update the owning organization 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. */}
|
||||
|
||||
Update the owning organization of a dataset.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"package_owner_org_update","method":"put"}]} webhooks={[]} hasHead={false} />
|
||||
32
docs/content/docs/package_relationship_update.mdx
Normal file
32
docs/content/docs/package_relationship_update.mdx
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
---
|
||||
title: package_relationship_update
|
||||
full: true
|
||||
_openapi:
|
||||
method: PUT
|
||||
route: package_relationship_update
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: >
|
||||
Update a relationship between two datasets (packages).
|
||||
|
||||
|
||||
The subject, object and type parameters are required to identify the
|
||||
relationship. Only the comment can be updated.
|
||||
|
||||
|
||||
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. */}
|
||||
|
||||
Update a relationship between two datasets (packages).
|
||||
|
||||
The subject, object and type parameters are required to identify the relationship. Only the comment can be updated.
|
||||
|
||||
You must be authorized to edit both the subject and the object datasets.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"package_relationship_update","method":"put"}]} webhooks={[]} hasHead={false} />
|
||||
22
docs/content/docs/package_resource_reorder.mdx
Normal file
22
docs/content/docs/package_resource_reorder.mdx
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
---
|
||||
title: package_resource_reorder
|
||||
full: true
|
||||
_openapi:
|
||||
method: PUT
|
||||
route: package_resource_reorder
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: >
|
||||
Reorder resources against datasets. If only partial resource ids are
|
||||
supplied then these are assumed to be first and the other resources
|
||||
will stay in their original order.
|
||||
---
|
||||
|
||||
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
||||
|
||||
Reorder resources against datasets. If only partial resource ids are supplied then these are assumed to be first and the other resources will stay in their original order.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"package_resource_reorder","method":"put"}]} webhooks={[]} hasHead={false} />
|
||||
196
docs/content/docs/package_revise.mdx
Normal file
196
docs/content/docs/package_revise.mdx
Normal file
|
|
@ -0,0 +1,196 @@
|
|||
---
|
||||
title: package_revise
|
||||
full: true
|
||||
_openapi:
|
||||
method: PUT
|
||||
route: package_revise
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: >
|
||||
Revise a dataset (package) selectively with match, filter, and update
|
||||
parameters.
|
||||
|
||||
|
||||
You must be authorized to edit the dataset and the groups that it
|
||||
belongs to.
|
||||
|
||||
|
||||
`match` and `update` parameters may also be passed as "flattened
|
||||
keys", using either the item numeric index or its unique id (with a
|
||||
minimum of 5 characters), e.g.
|
||||
`update__resource__1f9ab__description="guidebook"` would set the
|
||||
description of the resource with id starting with "1f9ab" to
|
||||
"guidebook", and `update__resource__-1__description="guidebook"` would
|
||||
do the same on the last resource in the dataset.
|
||||
|
||||
|
||||
The `extend` suffix can also be used on the update parameter to add a
|
||||
new item to a list, e.g. `update__resources__extend=[{"name": "new
|
||||
resource", "url": "https://example.com"}]` will add a new resource to
|
||||
the dataset with the provided `name` and `url`.
|
||||
|
||||
|
||||
Usage examples:
|
||||
|
||||
|
||||
- Change description in dataset, checking for old description:
|
||||
|
||||
|
||||
```
|
||||
|
||||
match={"notes": "old notes", "name": "xyz"}
|
||||
|
||||
update={"notes": "new notes"}
|
||||
|
||||
```
|
||||
|
||||
|
||||
- Identical to above, but using flattened keys:
|
||||
|
||||
|
||||
```
|
||||
|
||||
match__name="xyz"
|
||||
|
||||
match__notes="old notes"
|
||||
|
||||
update__notes="new notes"
|
||||
|
||||
```
|
||||
|
||||
|
||||
- Replace all fields at dataset level only, keep resources (note:
|
||||
dataset id and type fields can’t be deleted)
|
||||
|
||||
|
||||
```
|
||||
|
||||
match={"id": "1234abc-1420-cbad-1922"}
|
||||
|
||||
filter=["+resources", "-*"]
|
||||
|
||||
update={"name": "fresh-start", "title": "Fresh Start"}
|
||||
|
||||
```
|
||||
|
||||
|
||||
- Add a new resource (__extend on flattened key):
|
||||
|
||||
|
||||
```
|
||||
|
||||
match={"id": "abc0123-1420-cbad-1922"}
|
||||
|
||||
update__resources__extend=[{"name": "new resource", "url":
|
||||
"http://example.com"}]
|
||||
|
||||
```
|
||||
|
||||
|
||||
- Update a resource by its index:
|
||||
|
||||
|
||||
```
|
||||
|
||||
match={"name": "my-data"}
|
||||
|
||||
update__resources__0={"name": "new name, first resource"}
|
||||
|
||||
```
|
||||
|
||||
|
||||
- Update a resource by its id (provide at least 5 characters):
|
||||
|
||||
|
||||
```
|
||||
|
||||
match={"name": "their-data"}
|
||||
|
||||
update__resources__19cfad={"description": "right one for sure"}
|
||||
|
||||
```
|
||||
|
||||
|
||||
- Replace all fields of a resource:
|
||||
|
||||
|
||||
```
|
||||
|
||||
match={"id": "34a12bc-1420-cbad-1922"}
|
||||
|
||||
filter=["+resources__1492a__id", "-resources__1492a__*"]
|
||||
|
||||
update__resources__1492a={"name": "edits here", "url":
|
||||
"http://example.com"}
|
||||
|
||||
```
|
||||
---
|
||||
|
||||
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
||||
|
||||
Revise a dataset (package) selectively with match, filter, and update parameters.
|
||||
|
||||
You must be authorized to edit the dataset and the groups that it belongs to.
|
||||
|
||||
`match` and `update` parameters may also be passed as "flattened keys", using either the item numeric index or its unique id (with a minimum of 5 characters), e.g. `update__resource__1f9ab__description="guidebook"` would set the description of the resource with id starting with "1f9ab" to "guidebook", and `update__resource__-1__description="guidebook"` would do the same on the last resource in the dataset.
|
||||
|
||||
The `extend` suffix can also be used on the update parameter to add a new item to a list, e.g. `update__resources__extend=[{"name": "new resource", "url": "https://example.com"}]` will add a new resource to the dataset with the provided `name` and `url`.
|
||||
|
||||
Usage examples:
|
||||
|
||||
- Change description in dataset, checking for old description:
|
||||
|
||||
```
|
||||
match={"notes": "old notes", "name": "xyz"}
|
||||
update={"notes": "new notes"}
|
||||
```
|
||||
|
||||
- Identical to above, but using flattened keys:
|
||||
|
||||
```
|
||||
match__name="xyz"
|
||||
match__notes="old notes"
|
||||
update__notes="new notes"
|
||||
```
|
||||
|
||||
- Replace all fields at dataset level only, keep resources (note: dataset id and type fields can’t be deleted)
|
||||
|
||||
```
|
||||
match={"id": "1234abc-1420-cbad-1922"}
|
||||
filter=["+resources", "-*"]
|
||||
update={"name": "fresh-start", "title": "Fresh Start"}
|
||||
```
|
||||
|
||||
- Add a new resource (__extend on flattened key):
|
||||
|
||||
```
|
||||
match={"id": "abc0123-1420-cbad-1922"}
|
||||
update__resources__extend=[{"name": "new resource", "url": "http://example.com"}]
|
||||
```
|
||||
|
||||
- Update a resource by its index:
|
||||
|
||||
```
|
||||
match={"name": "my-data"}
|
||||
update__resources__0={"name": "new name, first resource"}
|
||||
```
|
||||
|
||||
- Update a resource by its id (provide at least 5 characters):
|
||||
|
||||
```
|
||||
match={"name": "their-data"}
|
||||
update__resources__19cfad={"description": "right one for sure"}
|
||||
```
|
||||
|
||||
- Replace all fields of a resource:
|
||||
|
||||
```
|
||||
match={"id": "34a12bc-1420-cbad-1922"}
|
||||
filter=["+resources__1492a__id", "-resources__1492a__*"]
|
||||
update__resources__1492a={"name": "edits here", "url": "http://example.com"}
|
||||
```
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"package_revise","method":"put"}]} webhooks={[]} hasHead={false} />
|
||||
47
docs/content/docs/package_update.mdx
Normal file
47
docs/content/docs/package_update.mdx
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
---
|
||||
title: package_update
|
||||
full: true
|
||||
_openapi:
|
||||
method: PUT
|
||||
route: package_update
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: >
|
||||
Update a dataset (package).
|
||||
|
||||
|
||||
You must be authorized to edit the dataset and the groups that it
|
||||
belongs to.
|
||||
|
||||
|
||||
<Callout title="Note">Update methods may delete parameters not
|
||||
explicitly provided in the data_dict. If you want to edit only a
|
||||
specific attribute use `package_patch` instead.</Callout>
|
||||
|
||||
|
||||
It is recommended to call `ckan.logic.action.get.package_show()`, make
|
||||
the desired changes to the result, and then call `package_update()`
|
||||
with it.
|
||||
|
||||
|
||||
Plugins may change the parameters of this function depending on the
|
||||
value of the dataset's `type` attribute, see the `IDatasetForm` 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. */}
|
||||
|
||||
Update a dataset (package).
|
||||
|
||||
You must be authorized to edit the dataset and the groups that it belongs to.
|
||||
|
||||
<Callout title="Note">Update methods may delete parameters not explicitly provided in the data_dict. If you want to edit only a specific attribute use `package_patch` instead.</Callout>
|
||||
|
||||
It is recommended to call `ckan.logic.action.get.package_show()`, make the desired changes to the result, and then call `package_update()` with it.
|
||||
|
||||
Plugins may change the parameters of this function depending on the value of the dataset's `type` attribute, see the `IDatasetForm` plugin interface.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"package_update","method":"put"}]} webhooks={[]} hasHead={false} />
|
||||
33
docs/content/docs/resource_update.mdx
Normal file
33
docs/content/docs/resource_update.mdx
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: resource_update
|
||||
full: true
|
||||
_openapi:
|
||||
method: PUT
|
||||
route: resource_update
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: >
|
||||
Update a resource.
|
||||
|
||||
|
||||
To update a resource you must be authorized to update the dataset that
|
||||
the resource belongs to.
|
||||
|
||||
|
||||
<Callout title="Note">Update methods may delete parameters not
|
||||
explicitly provided in the data_dict. If you want to edit only a
|
||||
specific attribute use `resource_patch` instead.</Callout>
|
||||
---
|
||||
|
||||
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
||||
|
||||
Update a resource.
|
||||
|
||||
To update a resource you must be authorized to update the dataset that the resource belongs to.
|
||||
|
||||
<Callout title="Note">Update methods may delete parameters not explicitly provided in the data_dict. If you want to edit only a specific attribute use `resource_patch` instead.</Callout>
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"resource_update","method":"put"}]} webhooks={[]} hasHead={false} />
|
||||
20
docs/content/docs/resource_view_reorder.mdx
Normal file
20
docs/content/docs/resource_view_reorder.mdx
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
title: resource_view_reorder
|
||||
full: true
|
||||
_openapi:
|
||||
method: PUT
|
||||
route: resource_view_reorder
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: |
|
||||
Reorder resource views.
|
||||
---
|
||||
|
||||
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
||||
|
||||
Reorder resource views.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"resource_view_reorder","method":"put"}]} webhooks={[]} hasHead={false} />
|
||||
26
docs/content/docs/resource_view_update.mdx
Normal file
26
docs/content/docs/resource_view_update.mdx
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
---
|
||||
title: resource_view_update
|
||||
full: true
|
||||
_openapi:
|
||||
method: PUT
|
||||
route: resource_view_update
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: >
|
||||
Update a resource view.
|
||||
|
||||
|
||||
To update a resource_view you must be authorized to update the
|
||||
resource that the resource_view belongs to.
|
||||
---
|
||||
|
||||
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
||||
|
||||
Update a resource view.
|
||||
|
||||
To update a resource_view you must be authorized to update the resource that the resource_view belongs to.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"resource_view_update","method":"put"}]} webhooks={[]} hasHead={false} />
|
||||
20
docs/content/docs/task_status_update.mdx
Normal file
20
docs/content/docs/task_status_update.mdx
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
title: task_status_update
|
||||
full: true
|
||||
_openapi:
|
||||
method: PUT
|
||||
route: task_status_update
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: |
|
||||
Update a task status.
|
||||
---
|
||||
|
||||
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
||||
|
||||
Update a task status.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"task_status_update","method":"put"}]} webhooks={[]} hasHead={false} />
|
||||
20
docs/content/docs/task_status_update_many.mdx
Normal file
20
docs/content/docs/task_status_update_many.mdx
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
title: task_status_update_many
|
||||
full: true
|
||||
_openapi:
|
||||
method: PUT
|
||||
route: task_status_update_many
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: |
|
||||
Update many task statuses at once.
|
||||
---
|
||||
|
||||
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
||||
|
||||
Update many task statuses at once.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"task_status_update_many","method":"put"}]} webhooks={[]} hasHead={false} />
|
||||
24
docs/content/docs/term_translation_update.mdx
Normal file
24
docs/content/docs/term_translation_update.mdx
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
title: term_translation_update
|
||||
full: true
|
||||
_openapi:
|
||||
method: PUT
|
||||
route: term_translation_update
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: |
|
||||
Create or update a term translation.
|
||||
|
||||
You must be a sysadmin to create or update term translations.
|
||||
---
|
||||
|
||||
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
||||
|
||||
Create or update a term translation.
|
||||
|
||||
You must be a sysadmin to create or update term translations.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"term_translation_update","method":"put"}]} webhooks={[]} hasHead={false} />
|
||||
20
docs/content/docs/term_translation_update_many.mdx
Normal file
20
docs/content/docs/term_translation_update_many.mdx
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
title: term_translation_update_many
|
||||
full: true
|
||||
_openapi:
|
||||
method: PUT
|
||||
route: term_translation_update_many
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: |
|
||||
Create or update many term translations at once.
|
||||
---
|
||||
|
||||
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
||||
|
||||
Create or update many term translations at once.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"term_translation_update_many","method":"put"}]} webhooks={[]} hasHead={false} />
|
||||
33
docs/content/docs/user_update.mdx
Normal file
33
docs/content/docs/user_update.mdx
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: user_update
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: user_update
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: >
|
||||
Update a user account.
|
||||
|
||||
|
||||
Normal users can only update their own user accounts. Sysadmins can
|
||||
update any user account and modify existing usernames.
|
||||
|
||||
|
||||
<Callout title="Note">Update methods may delete parameters not
|
||||
explicitly provided in the data_dict. If you want to edit only a
|
||||
specific attribute use `user_patch` instead.</Callout>
|
||||
---
|
||||
|
||||
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
||||
|
||||
Update a user account.
|
||||
|
||||
Normal users can only update their own user accounts. Sysadmins can update any user account and modify existing usernames.
|
||||
|
||||
<Callout title="Note">Update methods may delete parameters not explicitly provided in the data_dict. If you want to edit only a specific attribute use `user_patch` instead.</Callout>
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"user_update","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
24
docs/content/docs/vocabulary_update.mdx
Normal file
24
docs/content/docs/vocabulary_update.mdx
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
title: vocabulary_update
|
||||
full: true
|
||||
_openapi:
|
||||
method: PUT
|
||||
route: vocabulary_update
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: |
|
||||
Update a tag vocabulary.
|
||||
|
||||
You must a sysadmin to update vocabularies.
|
||||
---
|
||||
|
||||
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
||||
|
||||
Update a tag vocabulary.
|
||||
|
||||
You must a sysadmin to update vocabularies.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"vocabulary_update","method":"put"}]} webhooks={[]} hasHead={false} />
|
||||
Loading…
Add table
Add a link
Reference in a new issue