Skip to content

TypeScript API / laikacms/json-api / JsonApiResponseSchema

Variable: JsonApiResponseSchema ​

ts
const JsonApiResponseSchema: StandardSchemaV1<{
  data: {
     attributes: {
      [key: string]: any;
     };
     id: string;
     links?: {
      [key: string]: string;
     };
     meta?: {
      [key: string]: any;
     };
     relationships?: {
      [key: string]: any;
     };
     type: string;
  };
  links?: {
     first?: string;
     last?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  meta?: {
   [key: string]: any;
  };
}, {
  data: {
     attributes: {
      [key: string]: any;
     };
     id: string;
     links?: {
      [key: string]: string;
     };
     meta?: {
      [key: string]: any;
     };
     relationships?: {
      [key: string]: any;
     };
     type: string;
  };
  links?: {
     first?: string;
     last?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  meta?: {
   [key: string]: any;
  };
}> & Struct<{
  data: 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<$Record<String, Any>>;
}>;

Released under the MIT License.