`IBlogPostsRequest`

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

IBlogPostsRequest

Send conditions in filters and paging in paginate.

src/lib/interfaces/orionplace/blog/IBlogApi.ts

TypeScript

export interface IBlogPostsRequest {
  // Post, category and writer criteria.
  filters?: {
    // Exact post ID. With full access, selecting this ID requests the full
    // article; a list without an ID returns previews only.
    id?: number;
    // One public category and its public descendants.
    category?: number;
    // Array of public category IDs; matches any selected category or its public
    // descendants.
    categories?: number[];
    // Exact public category only, without descendant expansion.
    single_category?: number;
    // Post writer account ID.
    single_writer?: number;
    // Array of writer account IDs; matches any selected writer.
    writers?: number[];
  };
  // Page number and page size.
  paginate?: IApiPaginationRequest;
}