dataasee/api/response/insert.json at main · ulbmuenster/dataasee · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "dataasee:api?response=insert",

  "title": "DatAasee Insert Endpoint Response", "type": "object", "oneOf": [ { "required": ["data", "meta", "links"] },

                                                                             { "required": ["errors", "meta", "links"] } ], "properties": {

    "data": { "type": "object", "description": "See: https://jsonapi.org/format/#document-resource-objects", "required": ["type", "id", "attributes"], "properties": {

      "type": { "type": "string", "const": "system" },

      "id": { "type": "string", "pattern": "^[1-2][0-9]{9}$" },

      "attributes": { "type": "object", "title": "Payload", "required": ["recordId"], "properties": {

        "recordId": { "type": "string", "title": "Record Identifier" } } } } },

    "errors": { "type": "array", "description": "See: https://jsonapi.org/format/#document-top-level", "minItems": 1,

      "items": { "type": "object", "description": "See: https://jsonapi.org/format/#error-objects", "required": ["title", "detail"], "properties": {

        "title": { "type": "string" },

        "detail": { "type": "string" },

        "links": { "type": "object",

          "additionalProperties": { "type": "string" } } } } },

    "meta": { "type": "object", "description": "See: https://jsonapi.org/format/#document-meta", "required": ["name", "version"], "properties": {

      "name": { "type": "string", "const": "DatAasee" },

      "version": { "type": "string", "pattern": "^[1-9]*0?\\.[0-9]+" } } },

    "links": { "type": "object", "description": "See: https://jsonapi.org/format/#document-links", "required": ["self", "describedby"], "properties": {

      "self": { "type": "string" },

      "describedby": { "type": "string" } } } }
}