mirror of
https://github.com/dathere/ckanaction.git
synced 2025-12-27 21:27:01 +00:00
feat(docs): added all create endpoints
This commit is contained in:
parent
8d0c757fa6
commit
3ce5686dd1
12 changed files with 597 additions and 0 deletions
27
docs/content/docs/api_token_create.mdx
Normal file
27
docs/content/docs/api_token_create.mdx
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
---
|
||||
title: api_token_create
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: api_token_create
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: >
|
||||
Create new API Token for current user.
|
||||
|
||||
|
||||
Apart from the `user` and `name` field that are required by default
|
||||
implementation, there may be additional fields registered by
|
||||
extensions.
|
||||
---
|
||||
|
||||
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
||||
|
||||
Create new API Token for current user.
|
||||
|
||||
Apart from the `user` and `name` field that are required by default implementation, there may be additional fields registered by extensions.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"api_token_create","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
24
docs/content/docs/follow_dataset.mdx
Normal file
24
docs/content/docs/follow_dataset.mdx
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
title: follow_dataset
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: follow_dataset
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: |
|
||||
Start following a dataset.
|
||||
|
||||
You must provide your API key in the Authorization header.
|
||||
---
|
||||
|
||||
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
||||
|
||||
Start following a dataset.
|
||||
|
||||
You must provide your API key in the Authorization header.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"follow_dataset","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
24
docs/content/docs/follow_group.mdx
Normal file
24
docs/content/docs/follow_group.mdx
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
title: follow_group
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: follow_group
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: |
|
||||
Start following a group.
|
||||
|
||||
You must provide your API key in the Authorization header.
|
||||
---
|
||||
|
||||
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
||||
|
||||
Start following a group.
|
||||
|
||||
You must provide your API key in the Authorization header.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"follow_group","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
24
docs/content/docs/follow_user.mdx
Normal file
24
docs/content/docs/follow_user.mdx
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
title: follow_user
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: follow_user
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: |
|
||||
Start following another user.
|
||||
|
||||
You must provide your API key in the Authorization header.
|
||||
---
|
||||
|
||||
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
||||
|
||||
Start following another user.
|
||||
|
||||
You must provide your API key in the Authorization header.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"follow_user","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
24
docs/content/docs/group_member_create.mdx
Normal file
24
docs/content/docs/group_member_create.mdx
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
title: group_member_create
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: group_member_create
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: |
|
||||
Make a user a member of a group.
|
||||
|
||||
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 a user a member of a group.
|
||||
|
||||
You must be authorized to edit the group.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"group_member_create","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
31
docs/content/docs/organization_create.mdx
Normal file
31
docs/content/docs/organization_create.mdx
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
---
|
||||
title: organization_create
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: organization_create
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: >
|
||||
Create a new organization.
|
||||
|
||||
|
||||
You must be authorized to create organizations.
|
||||
|
||||
|
||||
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 organization.
|
||||
|
||||
You must be authorized to create organizations.
|
||||
|
||||
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":"organization_create","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
24
docs/content/docs/organization_member_create.mdx
Normal file
24
docs/content/docs/organization_member_create.mdx
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
title: organization_member_create
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: organization_member_create
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: |
|
||||
Make a user a member of an organization.
|
||||
|
||||
You must be authorized to edit the organization.
|
||||
---
|
||||
|
||||
{/* 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 member of an organization.
|
||||
|
||||
You must be authorized to edit the organization.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"organization_member_create","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
32
docs/content/docs/tag_create.mdx
Normal file
32
docs/content/docs/tag_create.mdx
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
---
|
||||
title: tag_create
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: tag_create
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: >
|
||||
Create a new vocabulary tag.
|
||||
|
||||
|
||||
You must be a sysadmin to create vocabulary tags.
|
||||
|
||||
|
||||
You can only use this function to create tags that belong to a
|
||||
vocabulary, not to create free tags. (To create a new free tag simply
|
||||
add the tag to a package, e.g. using the `package_update()` function.)
|
||||
---
|
||||
|
||||
{/* 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 vocabulary tag.
|
||||
|
||||
You must be a sysadmin to create vocabulary tags.
|
||||
|
||||
You can only use this function to create tags that belong to a vocabulary, not to create free tags. (To create a new free tag simply add the tag to a package, e.g. using the `package_update()` function.)
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"tag_create","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
24
docs/content/docs/user_create.mdx
Normal file
24
docs/content/docs/user_create.mdx
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
title: user_create
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: user_create
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: |
|
||||
Create a new user.
|
||||
|
||||
You must be authorized to create users.
|
||||
---
|
||||
|
||||
{/* 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 user.
|
||||
|
||||
You must be authorized to create users.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"user_create","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
24
docs/content/docs/user_invite.mdx
Normal file
24
docs/content/docs/user_invite.mdx
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
title: user_invite
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: user_invite
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: |
|
||||
Invite a new user.
|
||||
|
||||
You must be authorized to create group members.
|
||||
---
|
||||
|
||||
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
|
||||
|
||||
Invite a new user.
|
||||
|
||||
You must be authorized to create group members.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"user_invite","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
24
docs/content/docs/vocabulary_create.mdx
Normal file
24
docs/content/docs/vocabulary_create.mdx
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
title: vocabulary_create
|
||||
full: true
|
||||
_openapi:
|
||||
method: POST
|
||||
route: vocabulary_create
|
||||
toc: []
|
||||
structuredData:
|
||||
headings: []
|
||||
contents:
|
||||
- content: |
|
||||
Create a new tag vocabulary.
|
||||
|
||||
You must a sysadmin to create vocabularies.
|
||||
---
|
||||
|
||||
{/* 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 tag vocabulary.
|
||||
|
||||
You must a sysadmin to create vocabularies.
|
||||
|
||||
|
||||
<APIPage document={"./lib/openapi.yml"} operations={[{"path":"vocabulary_create","method":"post"}]} webhooks={[]} hasHead={false} />
|
||||
Loading…
Add table
Add a link
Reference in a new issue