@comet-cli/plugin-documentation/dist/helper-utils/src/operations.d.ts

Plugin for generating API documentation

import { ApiModel, Operation, Resource } from '@comet-cli/types';
import { Trie } from './trie';
export declare type EnhancedOperation = Operation & {
    uri: string;
};
export interface Group {
    name: string;
    description?: string;
    groups: Group[];
    operations: EnhancedOperation[];
    slug?: string;
}
export interface Folders {
    groups: Group[];
    operations: EnhancedOperation[];
}
export interface GroupOptions {
    group_by?: 'resources' | 'tags' | 'trie';
    flatten?: boolean;
}
export declare const getAllEnhancedOperations: (model: ApiModel) => EnhancedOperation[];
export declare const getEnhancedOperation: (resource: Resource, operation: Operation) => EnhancedOperation;
export declare const groupOperationsByResources: (model: ApiModel, options?: GroupOptions) => Folders;
export declare const groupOperationsByTags: (model: ApiModel) => Folders;
export declare const groupOperationsByTrie: (model: ApiModel, options?: GroupOptions) => Folders;
export declare const groupOperations: (model: ApiModel, options?: GroupOptions) => Folders;
export declare const createResourceTrie: (resources: Resource[]) => Trie;