@takeshape/schema 7.194.0

package/lib/schemas/project-schema/meta-schema-v3.6.0.json

@@ -0,0 +1,633 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://schema.takeshape.io/project-schema/meta-schema-v3.6.0#",
+  "title": "Content Schema",
+  "definitions": {
+    "schemaArray": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "$ref": "#"
+      }
+    },
+    "nonNegativeInteger": {
+      "type": "integer",
+      "minimum": 0
+    },
+    "nonNegativeIntegerDefault0": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/nonNegativeInteger"
+        },
+        {
+          "default": 0
+        }
+      ]
+    },
+    "simpleTypes": {
+      "enum": ["array", "boolean", "integer", "null", "number", "object", "string"]
+    },
+    "stringArray": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "uniqueItems": true,
+      "default": []
+    },
+    "relationship": {
+      "title": "Relationship",
+      "type": "object",
+      "properties": {
+        "shapeIds": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "minItems": 1
+        },
+        "type": {
+          "type": "string"
+        },
+        "relatedName": {
+          "type": "string",
+          "pattern": "^[_a-zA-Z][_a-zA-Z0-9]*$"
+        }
+      },
+      "required": ["shapeIds"],
+      "additionalProperties": false
+    },
+    "mappingString": {
+      "type": "string",
+      "pattern": "^[\\w-]+(?::[\\w-]+)+(?:\\.[\\w-]+)+$"
+    },
+    "fieldMapping": {
+      "title": "Field Mapping",
+      "oneOf": [
+        {
+          "$ref": "#/definitions/mappingString"
+        },
+        {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/mappingString"
+          }
+        }
+      ]
+    },
+    "refSchema": {
+      "title": "Ref Schema",
+      "type": "object",
+      "properties": {
+        "@ref": {
+          "$ref": "#/definitions/ref"
+        }
+      },
+      "required": ["@ref"]
+    },
+    "refSchemaLegacy": {
+      "title": "Ref Schema Legacy",
+      "type": "object",
+      "properties": {
+        "$ref": {
+          "$ref": "#/definitions/ref"
+        }
+      },
+      "required": ["$ref"]
+    },
+    "objectSchema": {
+      "title": "Object Schema",
+      "type": "object",
+      "allOf": [
+        {
+          "$ref": "#"
+        },
+        {
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "object"
+            },
+            "properties": {
+              "type": "object",
+              "additionalProperties": {
+                "$ref": "#"
+              }
+            }
+          },
+          "required": ["type", "properties"]
+        }
+      ]
+    },
+    "arraySchema": {
+      "title": "Array Schema",
+      "type": "object",
+      "allOf": [
+        {
+          "$ref": "#"
+        },
+        {
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "array"
+            },
+            "items": {
+              "$ref": "#/definitions/contentObjectSchema"
+            }
+          },
+          "required": ["type", "items"]
+        }
+      ]
+    },
+    "allOfSchema": {
+      "title": "All Of Schema",
+      "type": "object",
+      "properties": {
+        "allOf": {
+          "type": "array",
+          "items": {
+            "oneOf": [
+              {
+                "$ref": "#/definitions/refSchema"
+              },
+              {
+                "$ref": "#/definitions/refSchemaLegacy"
+              },
+              {
+                "$ref": "#/definitions/objectSchema"
+              }
+            ],
+            "unevaluatedProperties": true
+          }
+        }
+      },
+      "required": ["allOf"],
+      "additionalProperties": false
+    },
+    "oneOfSchema": {
+      "title": "One Of Schema",
+      "type": "object",
+      "properties": {
+        "oneOf": {
+          "type": "array",
+          "items": {
+            "oneOf": [
+              {
+                "$ref": "#/definitions/refSchema"
+              },
+              {
+                "$ref": "#/definitions/refSchemaLegacy"
+              },
+              {
+                "$ref": "#/definitions/objectSchema"
+              }
+            ],
+            "unevaluatedProperties": true
+          }
+        }
+      },
+      "required": ["oneOf"],
+      "additionalProperties": false
+    },
+    "contentObjectSchema": {
+      "title": "Content Object Schema",
+      "type": "object",
+      "oneOf": [
+        {
+          "$ref": "#/definitions/allOfSchema"
+        },
+        {
+          "$ref": "#/definitions/oneOfSchema"
+        },
+        {
+          "$ref": "#/definitions/refSchema"
+        },
+        {
+          "$ref": "#/definitions/refSchemaLegacy"
+        },
+        {
+          "$ref": "#/definitions/objectSchema"
+        },
+        {
+          "$ref": "#/definitions/arraySchema"
+        }
+      ]
+    },
+    "queryMap": {
+      "title": "Query Map",
+      "type": "object",
+      "patternProperties": {
+        "[0-9A-Za-z_-]+": {
+          "$ref": "#/definitions/query"
+        }
+      }
+    },
+    "args": {
+      "title": "Args",
+      "oneOf": [{"type": "string"}, {"$ref": "#/definitions/contentObjectSchema"}]
+    },
+    "returnShape": {
+      "title": "Return Shape",
+      "oneOf": [{"type": "string"}, {"$ref": "#/definitions/arraySchema"}]
+    },
+    "directiveConfigItem": {
+      "title": "Directive Config Item",
+      "description": "A tuple with a string directive name, and options to pass to the directive",
+      "type": "array",
+      "items": [
+        {
+          "title": "Directive Name",
+          "type": "string"
+        },
+        {
+          "title": "Directive Options",
+          "type": "object",
+          "propertyNames": {
+            "pattern": "[0-9A-Za-z_-]+"
+          }
+        }
+      ]
+    },
+    "directiveConfig": {
+      "title": "Directive Config",
+      "description": "An array of individual directive config items to process in order",
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/directiveConfigItem"
+      }
+    },
+    "directiveMappingMap": {
+      "title": "Directive Mapping Map",
+      "description": "An map of object keys / key paths to directive configs",
+      "type": "object",
+      "patternProperties": {
+        "[0-9A-Za-z_-]+": {
+          "$ref": "#/definitions/directiveConfig"
+        }
+      }
+    },
+    "directiveMappingArrayItem": {
+      "title": "Directive Mapping Array Item",
+      "description": "A tuple with a string key and a directive config to evaluate",
+      "type": "array",
+      "items": [{"type": "string"}, {"$ref": "#/definitions/directiveConfig"}]
+    },
+    "directiveMappingArray": {
+      "title": "Directive Mapping Array",
+      "description": "An array of key / value or directive config tuples",
+      "type": "array",
+      "items": {"$ref": "#/definitions/directiveMappingArrayItem"}
+    },
+    "basicResolver": {
+      "title": "BasicResolver",
+      "type": "object",
+      "properties": {
+        "if": {"type": "string"},
+        "id": {
+          "type": "string",
+          "pattern": "^(?=[a-zA-Z])[-_a-zA-Z0-9]+$"
+        },
+        "name": {
+          "type": "string",
+          "description": "The name of the built-in resolver your query or mutation should use."
+        },
+        "service": {
+          "type": "string",
+          "description": "Specifies the service configuration the resolver should use, identified by a connected service's slug. This configuration contains the endpoint and authentication necessary to make API calls."
+        },
+        "argsMapping": {
+          "description": "Maps a query's input args to the input expected by the service's endpoint.",
+          "oneOf": [
+            {
+              "$ref": "#/definitions/directiveMappingMap"
+            },
+            {
+              "$ref": "#/definitions/directiveConfig"
+            }
+          ]
+        },
+        "searchParamsMapping": {
+          "description": "Set or evaluate directives to generate searchParams for the service endpoint.",
+          "$ref": "#/definitions/directiveMappingArray"
+        },
+        "resultsMapping": {
+          "description": "Maps a service endpoint's response results to the expected shape of the query's response.",
+          "oneOf": [
+            {
+              "$ref": "#/definitions/directiveMappingMap"
+            },
+            {
+              "$ref": "#/definitions/directiveConfig"
+            }
+          ]
+        },
+        "options": {
+          "type": "object",
+          "properties": {
+            "model": {"type": "string"}
+          },
+          "additionalProperties": true
+        }
+      },
+      "required": ["name", "service"],
+      "additionalProperties": false
+    },
+    "composeResolver": {
+      "title": "ComposeResolver",
+      "type": "object",
+      "properties": {
+        "compose": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/basicResolver"
+          }
+        },
+        "resultsMapping": {
+          "oneOf": [
+            {
+              "$ref": "#/definitions/directiveMappingMap"
+            },
+            {
+              "$ref": "#/definitions/directiveConfig"
+            }
+          ]
+        }
+      },
+      "required": ["compose"],
+      "additionalProperties": false
+    },
+    "resolver": {
+      "title": "Resolver",
+      "oneOf": [{"$ref": "#/definitions/basicResolver"}, {"$ref": "#/definitions/composeResolver"}]
+    },
+    "ref": {
+      "title": "Ref",
+      "type": "string"
+    },
+    "query": {
+      "title": "Query",
+      "type": "object",
+      "properties": {
+        "args": {
+          "description": "The args field specifies the name of a Shape for the input arguments required by your resolver.",
+          "$ref": "#/definitions/args"
+        },
+        "resolver": {
+          "description": "Configures the resolver for your query or mutation.",
+          "$ref": "#/definitions/resolver"
+        },
+        "shape": {
+          "$ref": "#/definitions/returnShape",
+          "description": "Specifies which shape is returned by the query or mutation. The shape can refer to a shape in the schema's \"shapes\" object or a shape that's available on a service schema."
+        },
+        "description": {
+          "type": "string",
+          "description": "Provides more detail about what the query or mutation is for. This will be displayed in the automatically-generated GraphQL API docs."
+        }
+      },
+      "required": ["resolver", "shape"]
+    }
+  },
+  "type": "object",
+  "properties": {
+    "$id": {
+      "type": "string",
+      "format": "uri-reference"
+    },
+    "$schema": {
+      "type": "string",
+      "format": "uri"
+    },
+    "$ref": {
+      "type": "string",
+      "format": "uri-reference"
+    },
+    "$comment": {
+      "type": "string"
+    },
+    "title": {
+      "type": "string"
+    },
+    "description": {
+      "type": "string"
+    },
+    "default": true,
+    "readOnly": {
+      "type": "boolean",
+      "default": false
+    },
+    "examples": {
+      "type": "array",
+      "items": true
+    },
+    "multipleOf": {
+      "type": "number",
+      "exclusiveMinimum": 0
+    },
+    "maximum": {
+      "type": "number"
+    },
+    "exclusiveMaximum": {
+      "type": "number"
+    },
+    "minimum": {
+      "type": "number"
+    },
+    "exclusiveMinimum": {
+      "type": "number"
+    },
+    "maxLength": {
+      "$ref": "#/definitions/nonNegativeInteger"
+    },
+    "minLength": {
+      "$ref": "#/definitions/nonNegativeIntegerDefault0"
+    },
+    "pattern": {
+      "type": "string",
+      "format": "regex"
+    },
+    "additionalItems": {
+      "$ref": "#"
+    },
+    "items": {
+      "$ref": "#"
+    },
+    "maxItems": {
+      "$ref": "#/definitions/nonNegativeInteger"
+    },
+    "minItems": {
+      "$ref": "#/definitions/nonNegativeIntegerDefault0"
+    },
+    "uniqueItems": {
+      "type": "boolean",
+      "default": false
+    },
+    "contains": {
+      "$ref": "#"
+    },
+    "maxProperties": {
+      "$ref": "#/definitions/nonNegativeInteger"
+    },
+    "minProperties": {
+      "$ref": "#/definitions/nonNegativeIntegerDefault0"
+    },
+    "required": {
+      "$ref": "#/definitions/stringArray"
+    },
+    "additionalProperties": {
+      "oneOf": [
+        {"$ref": "#"},
+        {"enum": [false]}
+      ]
+    },
+    "definitions": {
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "#"
+      },
+      "default": {}
+    },
+    "properties": {
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "#"
+      },
+      "default": {}
+    },
+    "patternProperties": {
+      "type": "object",
+      "additionalProperties": {
+        "$ref": "#"
+      },
+      "propertyNames": {
+        "format": "regex"
+      },
+      "default": {}
+    },
+    "dependencies": {
+      "type": "object",
+      "additionalProperties": {
+        "anyOf": [
+          {
+            "$ref": "#"
+          },
+          {
+            "$ref": "#/definitions/stringArray"
+          }
+        ]
+      }
+    },
+    "propertyNames": {
+      "$ref": "#"
+    },
+    "const": true,
+    "enum": {
+      "type": "array",
+      "items": true,
+      "minItems": 1,
+      "uniqueItems": true
+    },
+    "type": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/simpleTypes"
+        },
+        {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/simpleTypes"
+          },
+          "minItems": 1,
+          "uniqueItems": true
+        }
+      ]
+    },
+    "format": {
+      "type": "string"
+    },
+    "contentMediaType": {
+      "type": "string"
+    },
+    "contentEncoding": {
+      "type": "string"
+    },
+    "if": {
+      "$ref": "#"
+    },
+    "then": {
+      "$ref": "#"
+    },
+    "else": {
+      "$ref": "#"
+    },
+    "allOf": {
+      "$ref": "#/definitions/schemaArray"
+    },
+    "anyOf": {
+      "$ref": "#/definitions/schemaArray"
+    },
+    "oneOf": {
+      "$ref": "#/definitions/schemaArray"
+    },
+    "not": {
+      "$ref": "#"
+    },
+    "@relationship": {
+      "$ref": "#/definitions/relationship"
+    },
+    "@syncLocaleStructure": {
+      "type": "boolean"
+    },
+    "@sensitive": {
+      "type": "boolean"
+    },
+    "@draftjs": {
+      "type": "boolean"
+    },
+    "@l10n": {
+      "type": "boolean"
+    },
+    "@key": {
+      "type": "string",
+      "pattern": "^[-_a-zA-Z0-9]+$"
+    },
+    "@workflow": {
+      "type": "string"
+    },
+    "@mapping": {
+      "$ref": "#/definitions/fieldMapping"
+    },
+    "@tag": {
+      "type": "string"
+    },
+    "@tags": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "@deprecationReason": {
+      "type": "string"
+    },
+    "@user": {
+      "type": "boolean"
+    },
+    "@args": {
+      "$ref": "#/definitions/args"
+    },
+    "@resolver": {
+      "$ref": "#/definitions/resolver"
+    },
+    "@ref": {
+      "$ref": "#/definitions/ref"
+    },
+    "@derivedFrom": {
+      "type": "string"
+    },
+    "value": {
+      "type": "string"
+    }
+  },
+  "additionalProperties": false
+}