TypeScript API / laikacms/json-api / JsonApiCollectionResponseSchema

Variable: JsonApiCollectionResponseSchema

const JsonApiCollectionResponseSchema: StandardSchemaV1<{
  data: readonly object[];
  included?: readonly object[];
  links?: {
     first?: string;
     last?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  meta?: {
     page?: {
        estimatedTotal?: number;
        total?: number;
     };
     warnings?: readonly object[];
  };
}, {
  data: readonly object[];
  included?: readonly object[];
  links?: {
     first?: string;
     last?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  meta?: {
     page?: {
        estimatedTotal?: number;
        total?: number;
     };
     warnings?: readonly object[];
  };
}> & Struct<{
  data: $Array<StandardSchemaV1<{
     attributes: {
      [key: string]: any;
     };
     id: string;
     links?: {
      [key: string]: string;
     };
     meta?: {
      [key: string]: any;
     };
     relationships?: {
      [key: string]: any;
     };
     type: string;
   }, {
     attributes: {
      [key: string]: any;
     };
     id: string;
     links?: {
      [key: string]: string;
     };
     meta?: {
      [key: string]: any;
     };
     relationships?: {
      [key: string]: any;
     };
     type: string;
   }> & Struct<{
     attributes: $Record<String, Any>;
     id: String;
     links: optional<$Record<String, String>>;
     meta: optional<$Record<String, Any>>;
     relationships: optional<$Record<String, Any>>;
     type: String;
  }>>;
  included: optional<$Array<StandardSchemaV1<{
     attributes: {
      [key: string]: any;
     };
     id: string;
     links?: {
      [key: string]: string;
     };
     meta?: {
      [key: string]: any;
     };
     relationships?: {
      [key: string]: any;
     };
     type: string;
   }, {
     attributes: {
      [key: string]: any;
     };
     id: string;
     links?: {
      [key: string]: string;
     };
     meta?: {
      [key: string]: any;
     };
     relationships?: {
      [key: string]: any;
     };
     type: string;
   }> & Struct<{
     attributes: $Record<String, Any>;
     id: String;
     links: optional<$Record<String, String>>;
     meta: optional<$Record<String, Any>>;
     relationships: optional<$Record<String, Any>>;
     type: String;
  }>>>;
  links: optional<StandardSchemaV1<{
     first?: string;
     last?: string;
     next?: string;
     prev?: string;
     self?: string;
   }, {
     first?: string;
     last?: string;
     next?: string;
     prev?: string;
     self?: string;
   }> & Struct<{
     first: optional<String>;
     last: optional<String>;
     next: optional<String>;
     prev: optional<String>;
     self: optional<String>;
  }>>;
  meta: optional<StandardSchemaV1<{
     page?: {
        estimatedTotal?: number;
        total?: number;
     };
     warnings?: readonly object[];
   }, {
     page?: {
        estimatedTotal?: number;
        total?: number;
     };
     warnings?: readonly object[];
   }> & Struct<{
     page: optional<Struct<{
        estimatedTotal: optional<...>;
        total: optional<...>;
     }>>;
     warnings: optional<$Array<Struct<{
        code: ...;
        detail: ...;
        source: ...;
        status: ...;
        title: ...;
     }>>>;
  }>>;
}>;