Add JSON Schema that is v1.1 compliant

json-api · VGirol · Jan 18, 2022 · Feb 15, 2022 · Jan 18, 2022 · Jan 24, 2022
commit 966499acb6f72b6fc1a9e39fe6acba7fd748ad1f
diff --git a/_schemas/1.1/schema.json b/_schemas/1.1/schema.json
diff --git a/_schemas/1.1/schema_creation_resource.json b/_schemas/1.1/schema_creation_resource.json
@@ -0,0 +1,140 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://jsonapi.org/schemas/spec/v1.1/draft/Creation/Resource",
+  "$comment": "The $id URI should be modified before releasing. This URI does not need to be network addressable. It is an ID only.",
+  "title": "JSON:API Schema for POST request",
+  "description": "This schema only validates a request for POSTing a new resource.",
+  "required": [
+    "data"
+  ],
+  "properties": {
+    "data": {
+      "$ref": "#/definitions/resource"
+    },
+    "included": {
+      "$ref": "https://jsonapi.org/schemas/spec/v1.1/draft#/definitions/included"
+    },
+    "jsonapi": {
+      "$ref": "https://jsonapi.org/schemas/spec/v1.1/draft#/definitions/jsonapi"
+    },
+    "links": {
+      "description": "Link members related to the primary data.",
+      "$ref": "https://jsonapi.org/schemas/spec/v1.1/draft#/definitions/topLevelLinks"
+    },
+    "meta": {
+      "$ref": "https://jsonapi.org/schemas/spec/v1.1/draft#/definitions/meta"
+    }
+  },
+  "dependencies": {
+    "included": ["data"]
+  },
+  "additionalProperties": false,
+  "definitions": {
+    "relationship": {
+      "type": "object",
+      "properties": {
+        "links": {
+          "$ref": "#/definitions/relationshipLinks"
+        },
+        "data": {
+          "$ref": "#/definitions/linkage"
+        },
+        "meta": {
+          "$ref": "#/definitions/meta"
+        }
+      },
+      "required": [
+        "data"
+      ],
+      "additionalProperties": false
+    },
+    "relationships": {
+      "description": "Members of the relationships object (\"relationships\") represent references from the resource object in which it's defined to other resource objects.",
+      "type": "object",
+      "patternProperties": {
+        "^[a-zA-Z0-9]{1}(?:[-\\w]*[a-zA-Z0-9])?$": {
+          "$ref": "#/definitions/relationship"
+        }
+      },
+      "not": {
+        "anyOf": [
+          {
+            "required": [
+              "type"
+            ]
+          },
+          {
+            "required": [
+              "id"
+            ]
+          }
+        ]
+      },
+      "additionalProperties": false
+    },
+    "resource": {
+      "description": "\"Resource objects\" appear in a JSON:API document to represent resources.",
+      "$comment": "The id member is not required when the resource object originates at the client and represents a new resource to be created on the server.",
+      "type": "object",
+      "allOf": [
+        {
+          "$ref": "#/definitions/resourceIdentification"
+        }
+      ],
+      "properties": {
+        "id": true,
+        "type": true,
+        "lid": true,
+        "attributes": {
+          "$ref": "https://jsonapi.org/schemas/spec/v1.1/draft#/definitions/attributes"
+        },
+        "links": {
+          "$ref": "https://jsonapi.org/schemas/spec/v1.1/draft#/definitions/resourceLinks"
+        },
+        "meta": {
+          "$ref": "https://jsonapi.org/schemas/spec/v1.1/draft#/definitions/meta"
+        },
+        "relationships": {
+          "$ref": "#/definitions/relationships"
+        }
+      },
+      "additionalProperties": false
+    },
+    "resourceIdentification": {
+      "type": "object",
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "type": "string",
+          "pattern": "^[a-zA-Z0-9]{1}(?:[-\\w]*[a-zA-Z0-9])?$"
+        },
+        "id": {
+          "type": "string"
+        },
+        "lid": {
+          "type": "string"
+        }
+      }
+    },
+    "resourceIdentifier": {
+      "description": "The \"type\" and \"id\" to non-empty members.",
+      "type": "object",
+      "allOf": [
+        {
+          "$ref": "#/definitions/resourceIdentification"
+        }
+      ],
+      "properties": {
+        "id": true,
+        "type": true,
+        "lid": true,
+        "meta": {
+          "$ref": "https://jsonapi.org/schemas/spec/v1.1/draft#/definitions/meta"
+        }
+      },
+      "additionalProperties": false
+    }
+  }
+}
diff --git a/_schemas/1.1/tests/request/creation/resource/invalid/lid_member_must_be_string.json b/_schemas/1.1/tests/request/creation/resource/invalid/lid_member_must_be_string.json
@@ -0,0 +1,9 @@
+{
+    "data": {
+        "type": "article",
+        "lid": 6,
+        "attributes": {
+            "title": "PHP is so crazy !"
+        }
+    }
+}
diff --git a/_schemas/1.1/tests/request/creation/resource/valid/post_resource_with_lid_member.json b/_schemas/1.1/tests/request/creation/resource/valid/post_resource_with_lid_member.json
@@ -0,0 +1,9 @@
+{
+    "data": {
+        "type": "article",
+        "lid": "local_id",
+        "attributes": {
+            "title": "PHP is so crazy !"
+        }
+    }
+}
diff --git a/_schemas/1.1/tests/request/update/relationship/invalid/lid_member_must_be_string.json b/_schemas/1.1/tests/request/update/relationship/invalid/lid_member_must_be_string.json
@@ -0,0 +1,8 @@
+{
+    "data": [
+        {
+            "type": "article",
+            "lid": 6
+        }
+    ]
+}
diff --git a/_schemas/1.1/tests/request/update/relationship/valid/patch_relationship_with_lid_member.json b/_schemas/1.1/tests/request/update/relationship/valid/patch_relationship_with_lid_member.json
@@ -0,0 +1,8 @@
+{
+    "data": [
+        {
+            "type": "article",
+            "lid": "local_id"
+        }
+    ]
+}
diff --git a/_schemas/1.1/tests/response/invalid/errors/error_object_must_not_be_empty.json b/_schemas/1.1/tests/response/invalid/errors/error_object_must_not_be_empty.json
@@ -0,0 +1,5 @@
+{
+    "errors": [
+        {}
+    ]
+}
diff --git a/_schemas/1.1/tests/response/invalid/errors/invalid_error_objects.json b/_schemas/1.1/tests/response/invalid/errors/invalid_error_objects.json
@@ -0,0 +1,16 @@
+{
+    "errors": [
+        {
+            "id": "0",
+            "status": "400",
+            "code": "4",
+            "title": "Oh no!",
+            "detail": "something",
+            "source": {
+                "header": {
+                    "wrong": "not a string"
+                }
+            }
+        }
+    ]
+}
diff --git a/_schemas/1.1/tests/response/invalid/jsonapi/ext_member_must_be_array.json b/_schemas/1.1/tests/response/invalid/jsonapi/ext_member_must_be_array.json
@@ -0,0 +1,9 @@
+{
+    "meta": {
+        "something": "wrong"
+    },
+    "jsonapi": {
+        "version": "1.0",
+        "ext": "error"
+    }
+}
diff --git a/_schemas/1.1/tests/response/invalid/jsonapi/ext_member_must_be_array_of_links.json b/_schemas/1.1/tests/response/invalid/jsonapi/ext_member_must_be_array_of_links.json
@@ -0,0 +1,11 @@
+{
+    "meta": {
+        "something": "wrong"
+    },
+    "jsonapi": {
+        "version": "1.0",
+        "ext": [
+            "error"
+        ]
+    }
+}
diff --git a/_schemas/1.1/tests/response/invalid/jsonapi/profile_member_must_be_array.json b/_schemas/1.1/tests/response/invalid/jsonapi/profile_member_must_be_array.json
@@ -0,0 +1,9 @@
+{
+    "meta": {
+        "something": "wrong"
+    },
+    "jsonapi": {
+        "version": "1.0",
+        "profile": "error"
+    }
+}
diff --git a/_schemas/1.1/tests/response/invalid/jsonapi/profile_member_must_be_array_of_links.json b/_schemas/1.1/tests/response/invalid/jsonapi/profile_member_must_be_array_of_links.json
@@ -0,0 +1,11 @@
+{
+    "meta": {
+        "something": "wrong"
+    },
+    "jsonapi": {
+        "version": "1.0",
+        "profile": [
+            "error"
+        ]
+    }
+}
diff --git a/_schemas/1.1/tests/response/invalid/links/link_members_must_be_string.json b/_schemas/1.1/tests/response/invalid/links/link_members_must_be_string.json
@@ -0,0 +1,19 @@
+{
+    "links": {
+        "self": {
+            "href": "http://example.com",
+            "rel": ["bad"],
+            "title": {
+                "attr": "wrong"
+            },
+            "type": 0,
+            "hreflang": ["bad"],
+            "describedby": {
+                "attr": "wrong"
+            }
+        }
+    },
+    "meta": {
+        "something": "is wrong"
+    }
+}
diff --git a/_schemas/1.1/tests/response/valid/with_failure/errors_and_meta.json b/_schemas/1.1/tests/response/valid/with_failure/errors_and_meta.json
@@ -0,0 +1,31 @@
+{
+    "errors": [
+        {
+            "id": "1",
+            "links": {
+                "about": "http://www.example.com/errors/1"
+            },
+            "status": "400",
+            "code": "0x002",
+            "title": "human-readable summary of the problem",
+            "source": {
+                "pointer": "/data/id"
+            }
+        },
+      
CB4C
  {
+            "id": "2",
+            "links": {
+                "about": "http://www.example.com/errors/2"
+            },
+            "status": "400",
+            "code": "0x008",
+            "title": "human-readable summary of the problem",
+            "source": {
+                "parameter": "include"
+            }
+        }
+    ],
+    "meta": {
+        "anything": "valid"
+    }
+}
diff --git a/_schemas/1.1/tests/response/valid/with_failure/only_errors/one_error.json b/_schemas/1.1/tests/response/valid/with_failure/only_errors/one_error.json
@@ -0,0 +1,26 @@
+{
+    "errors": [
+        {
+            "id": "1",
+            "links": {
+                "about": "http://www.example.com/errors/1",
+                "type": "http://www.example.com/errors/type"
+            },
+            "status": "400",
+            "code": "0x002",
+            "title": "human-readable summary of the problem",
+            "source": {
+                "pointer": "/data/id"
+            }
+        },
+        {
+            "id": "1",
+            "status": "400",
+            "code": "0x006",
+            "title": "human-readable summary of the problem",
+            "source": {
+                "header": "wrong-header"
+            }
+        }
+    ]
+}