`IBlogCommentsRequest`

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

IBlogCommentsRequest

Send criteria under filters and paging under paginate. Root comments and replies are separate list requests.

app/interfaces/orionplace/blog/IBlogApi.ts

TypeScript

export interface IBlogCommentsRequest {
  // Comment selection criteria.
  filters?: {
    // Exact comment ID.
    id?: number;
    // Comma-separated comment IDs, for example `1,2,3`; a numeric array is also
    // accepted.
    id__in?: number[] | string;
    // Exact post ID.
    for_post?: number;
    // Comments on posts directly attached to this public blog category;
    // descendants are not expanded.
    single_category?: number;
    // Replies to this parent comment. Combine with `for_post` to scope the
    // conversation.
    parent?: number;
    // `true` — root comments only; `false` or omission — comments and replies.
    show_only_main?: boolean;
    // Sort by creation date or ID. Default: newest creation date, then newest
    // ID.
    ordering?: 'date_created' | '-date_created' | 'id' | '-id';
  };
  // Page number and page size.
  paginate?: IApiPaginationRequest;
}