Application Load

IBlogCategory

The physical TypeScript declaration from the Nuxt starter, with linked types and field comments.

IBlogCategory

Public blog category.

interfaces/orionplace/blog/IBlogApi.ts
TypeScript
export interface IBlogCategory {
  // Blog category ID.
  id: number;
  // Configured manual ordering.
  ordering: number;
  // Whether the category is public.
  is_public: boolean;
  // Tree depth; this response stops at depth 3.
  depth: number;
  // Stored direct-child count, which can include hidden categories.
  numchild: number;
  // Direct visible-post count before request filters.
  c_posts: number;
  // Localized category labels, metadata and link.
  locale: Record<
    string,
    {
      // Blog category ID.
      id?: number;
      // Optional value of cg_name; it may be omitted.
      cg_name?: string;
      // Optional value of cg_title; it may be omitted.
      cg_title?: string;
      // Optional value of cg_slug; it may be omitted.
      cg_slug?: string;
      // Optional value of meta_description; it may be omitted.
      meta_description?: string;
      // Optional value of meta_keywords; it may be omitted.
      meta_keywords?: string;
      // Optional value of link; it may be omitted.
      link?: string;
    }
  >;
  // Present on initial root nodes.
  search_target?: boolean;
  // Empty in this endpoint: ancestor building is disabled.
  path_to_top: [];
  // Public child categories, when any stored child branch exists.
  childs?: IBlogCategory[];
}