ckanaction/docs/content/docs/group_purge.mdx

44 lines
No EOL
1.2 KiB
Text

---
title: group_purge
full: true
_openapi:
preload:
- ./lib/openapi.yml
method: DELETE
webhook: false
toc: []
structuredData:
headings: []
contents:
- content: >
Purge a group.
<Callout title="Warning!" type="warn">Purging a group cannot be
undone!</Callout>
Purging a group completely removes the group from the CKAN database,
whereas deleting a group simply marks the group as deleted (it will no
longer show up in the frontend, but is still in the db).
Datasets in the group will remain, just not in the purged group.
You must be authorized to purge 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. */}
export default function Layout(props) {
const { APIPage, OpenAPIPage } = props.components ?? {};
// "APIPage" is the old name from v10, this allows both for backward compatibility
const Comp = OpenAPIPage ?? APIPage;
return (
<>
{props.children}
<Comp document="./lib/openapi.yml" operations={[{"path":"group_purge","method":"delete"}]} showDescription />
</>
);
}