@takeshape/schema 7.194.0

package/es/schemas/project-schema/v3.1.0.json

@@ -0,0 +1,569 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://schema.takeshape.io/project-schema/v3.1.0#",
+  "title": "Project Schema",
+  "definitions": {
+    "shape": {
+      "title": "Shape",
+      "description": "A Shape is a schema object for structuring and storing data from one or more sources, including the TakeShape data store and connected services",
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[_a-zA-Z][_a-zA-Z0-9]*$",
+          "description": "The Pascal-cased human-readable id for a Shape. This value should match the shape's key in the shapes object. This value is used in @ref and @mapping annotations"
+        },
+        "id": {
+          "type": "string",
+          "pattern": "[0-9A-Za-z_-]+",
+          "description": "The machine-readable id for a Shape which should never change. When using TakeShape's built-in database to store Shape data, this value is used  database as a stable \"table name\" and changing it will result in orphaning that data."
+        },
+        "title": {
+          "type": "string",
+          "description": "The human-readable name for a Shape for use in a UI."
+        },
+        "description": {
+          "type": "string"
+        },
+        "model": {
+          "description": "Specifying a model type allows Shape data to be stored in TakeShape's built-in database",
+          "type": "object",
+          "properties": {
+            "type": {
+              "title": "Model Type",
+              "type": "string",
+              "enum": ["single", "multiple", "taxonomy"]
+            }
+          },
+          "required": ["type"],
+          "additionalProperties": false
+        },
+        "workflow": {
+          "type": "string"
+        },
+        "schema": {
+          "$ref": "https://schema.takeshape.io/project-schema/meta-schema-v3.1.0#/definitions/contentObjectSchema"
+        }
+      },
+      "required": ["name", "title", "id", "schema"]
+    },
+    "shapeWithObjectSchema": {
+      "title": "Shape With Object Schema",
+      "type": "object",
+      "allOf": [
+        {
+          "$ref": "#/definitions/shape"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "schema": {
+              "$ref": "https://schema.takeshape.io/project-schema/meta-schema-v3.1.0#/definitions/objectSchema"
+            }
+          },
+          "required": ["schema"],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "shapeMap": {
+      "title": "Shape Map",
+      "type": "object",
+      "patternProperties": {
+        "[0-9A-Za-z_-]+": {"$ref": "#/definitions/shape"}
+      }
+    },
+    "formMap": {
+      "title": "Form Map",
+      "type": "object",
+      "patternProperties": {
+        "[0-9A-Za-z_-]+": {
+          "$ref": "#/definitions/formsConfig"
+        }
+      }
+    },
+    "formScalarConfig": {
+      "title": "Form Scalar Config",
+      "type": "object",
+      "properties": {
+        "widget": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false,
+      "required": ["widget"]
+    },
+    "formObjectConfig": {
+      "title": "Form Object Config",
+      "type": "object",
+      "properties": {
+        "widget": {
+          "type": "string"
+        },
+        "order": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "properties": {
+          "patternProperties": {
+            "[0-9A-Za-z_-]+": {
+              "$ref": "#/definitions/formConfig"
+            }
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "formArrayConfig": {
+      "title": "Form Array Config",
+      "type": "object",
+      "properties": {
+        "widget": {
+          "type": "string"
+        },
+        "items": {
+          "$ref": "#/definitions/formConfig"
+        }
+      },
+      "additionalProperties": false,
+      "required": ["widget", "items"]
+    },
+    "searchParamsAuthentication": {
+      "title": "Search Params Authentication",
+      "type": "array",
+      "items": {
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "value": {
+            "type": "string"
+          }
+        },
+        "required": ["name", "value"],
+        "additionalProperties": false
+      }
+    },
+    "bearerAuthentication": {
+      "title": "Bearer Authentication",
+      "type": "object",
+      "properties": {
+        "token": {
+          "type": "string"
+        },
+        "prefix": {
+          "type": "string"
+        },
+        "header": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
+    },
+    "oauth2BearerAuthentication": {
+      "title": "OAuth 2 Bearer Authentication",
+      "type": "object",
+      "properties": {
+        "token": {
+          "type": "string"
+        },
+        "prefix": {
+          "type": "string"
+        },
+        "header": {
+          "type": "string"
+        },
+        "scope": {
+          "type": "string"
+        },
+        "expiresAt": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
+    },
+    "basicAuthentication": {
+      "title": "Basic Authentication",
+      "type": "object",
+      "properties": {
+        "username": {
+          "type": "string"
+        },
+        "password": {
+          "type": "string"
+        },
+        "useIso8859": {
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    },
+    "oauth2Authentication": {
+      "title": "OAuth 2 Authentication",
+      "type": "object",
+      "properties": {
+        "grantType": {
+          "type": "string",
+          "enum": ["authorizationCode", "clientCredentials"]
+        },
+        "authorizationUrl": {
+          "type": "string"
+        },
+        "accessTokenUrl": {
+          "type": "string"
+        },
+        "clientId": {
+          "type": "string"
+        },
+        "clientSecret": {
+          "type": "string"
+        },
+        "scope": {
+          "type": "string"
+        },
+        "usePkce": {
+          "type": "boolean"
+        },
+        "redirectUrl": {
+          "type": "string"
+        },
+        "headerPrefix": {
+          "type": "string"
+        },
+        "audience": {
+          "type": "string"
+        },
+        "resource": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
+    },
+    "serviceAuthentication": {
+      "title": "Service Authentication",
+      "oneOf": [
+        {
+          "$ref": "#/definitions/oauth2Authentication"
+        },
+        {
+          "$ref": "#/definitions/oauth2BearerAuthentication"
+        },
+        {
+          "$ref": "#/definitions/bearerAuthentication"
+        },
+        {
+          "$ref": "#/definitions/basicAuthentication"
+        },
+        {
+          "$ref": "#/definitions/searchParamsAuthentication"
+        }
+      ]
+    },
+    "serviceType": {
+      "title": "Service Type",
+      "description": "The general type of this service, specifying how and where it will be utilized.",
+      "type": "string",
+      "enum": ["deployment", "authentication", "takeshape", "rest", "graphql", "openapi", "unknown"]
+    },
+    "serviceConfig": {
+      "title": "Service Config",
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Machine-readable identifier, should typically be the same as the property name on the services object."
+        },
+        "title": {
+          "type": "string",
+          "description": "Human-readable name for this service."
+        },
+        "provider": {
+          "description": "The service provider id.",
+          "type": "string"
+        },
+        "namespace": {
+          "type": "string",
+          "description": "A namespace to use for the imported types tied to this service."
+        },
+        "serviceType": {
+          "$ref": "#/definitions/serviceType"
+        },
+        "authenticationType": {
+          "type": "string",
+          "enum": ["oauth2", "basic", "bearer", "searchParams", "oauth2Bearer", "none", "unknown"]
+        },
+        "authentication": {
+          "$ref": "#/definitions/serviceAuthentication"
+        },
+        "webhookId": {
+          "type": "string"
+        },
+        "options": {
+          "type": "object",
+          "description": "Configuration options passed to and handled by the provider.",
+          "patternProperties": {
+            "[a-zA-Z][a-zA-Z0-9]*": {
+              "type": "string"
+            }
+          }
+        }
+      },
+      "required": ["id", "title", "provider", "serviceType", "authenticationType"],
+      "additionalProperties": false
+    },
+    "storedServiceConfig": {
+      "title": "Stored Service Config",
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Machine-readable identifier, should typically be the same as the property name on the services object."
+        },
+        "title": {
+          "type": "string",
+          "description": "Human-readable name for this service."
+        },
+        "provider": {
+          "type": "string",
+          "description": "The service provider id."
+        },
+        "namespace": {
+          "type": "string",
+          "description": "A namespace to use for the imported types tied to this service."
+        },
+        "serviceType": {
+          "$ref": "#/definitions/serviceType"
+        },
+        "authenticationType": {
+          "type": "string",
+          "enum": ["oauth2", "basic", "bearer", "searchParams", "oauth2Bearer", "none", "unknown"]
+        },
+        "authentication": {
+          "type": "string"
+        },
+        "webhookId": {
+          "type": "string"
+        },
+        "options": {
+          "type": "object",
+          "description": "Configuration options passed to and handled by the provider.",
+          "patternProperties": {
+            "[a-zA-Z][a-zA-Z0-9]*": {
+              "type": "string"
+            }
+          }
+        }
+      },
+      "required": ["id", "title", "provider", "serviceType", "authenticationType"],
+      "additionalProperties": false
+    },
+    "anyServiceConfig": {
+      "title": "Any Service Config",
+      "oneOf": [
+        {
+          "$ref": "#/definitions/storedServiceConfig"
+        },
+        {
+          "$ref": "#/definitions/serviceConfig"
+        }
+      ]
+    },
+    "storedServiceMap": {
+      "title": "Stored Service Map",
+      "type": "object",
+      "patternProperties": {
+        "[0-9A-Za-z_-]+": {
+          "$ref": "#/definitions/storedServiceConfig"
+        }
+      }
+    },
+    "workflowStep": {
+      "title": "Workflow Step",
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "title": "Name",
+          "pattern": "^[_a-zA-Z][_a-zA-Z0-9]*$",
+          "description": "machine-readable slug"
+        },
+        "title": {
+          "title": "Title",
+          "type": "string",
+          "description": "Human-readable id for use in the UI"
+        },
+        "description": {
+          "title": "Description",
+          "type": "string"
+        },
+        "color": {
+          "title": "Color",
+          "type": "string",
+          "description": "Hex color code"
+        },
+        "live": {
+          "title": "Live",
+          "type": "boolean",
+          "description": "Value to indicate whether items in the state should be returned in list queries"
+        },
+        "key": {
+          "title": "Key",
+          "type": "string",
+          "description": "machine-readable id"
+        }
+      },
+      "required": ["name", "title", "color", "live", "key"],
+      "additionalProperties": false
+    },
+    "workflow": {
+      "title": "Workflow",
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[_a-zA-Z][_a-zA-Z0-9]*$",
+          "description": "machine-readable id"
+        },
+        "title": {
+          "type": "string",
+          "title": "Workflow Name",
+          "minLength": 1,
+          "description": "Human-readable id for use in the UI"
+        },
+        "steps": {
+          "type": "array",
+          "title": "Steps",
+          "items": {
+            "$ref": "#/definitions/workflowStep"
+          },
+          "minItems": 1
+        }
+      },
+      "required": ["name", "title", "steps"]
+    },
+    "workflowMap": {
+      "title": "Workflow Map",
+      "type": "object",
+      "patternProperties": {
+        "[0-9A-Za-z_-]+": {"$ref": "#/definitions/workflow"}
+      }
+    },
+    "formConfig": {
+      "title": "Form Config",
+      "type": "object"
+    },
+    "formsConfig": {
+      "title": "Forms Config",
+      "type": "object",
+      "properties": {
+        "default": {
+          "$ref": "#/definitions/formConfig"
+        }
+      },
+      "patternProperties": {
+        "[0-9A-Za-z_-]+": {
+          "$ref": "#/definitions/formConfig"
+        }
+      },
+      "required": ["default"]
+    }
+  },
+  "properties": {
+    "$schema": {
+      "type": "string"
+    },
+    "version": {
+      "type": "number",
+      "description": "This is the revision number of your schema. Every time your project schema is updated, this value should be incremented."
+    },
+    "apiVersion": {
+      "type": "string",
+      "description": "The version of the TakeShape API your project is using. We increase the version as we make breaking changes to the API endpoints."
+    },
+    "schemaVersion": {
+      "type": "string",
+      "enum": ["3.1.0"],
+      "description": "The version of the schema format your project is using. We increase the version as we make breaking changes to the schema format."
+    },
+    "projectId": {
+      "type": "string",
+      "description": "The ID of the TakeShape project this schema belongs to."
+    },
+    "author": {
+      "type": "string",
+      "description":"The ID of the TakeShape user who created the schema."
+    },
+    "created": {
+      "type": "string",
+      "format": "date-time",
+      "description": "The date the schema was created"
+    },
+    "updated": {
+      "type": "string",
+      "format": "date-time",
+      "description": "The date the schema was last updated"
+    },
+    "deactivated": {
+      "type": "number"
+    },
+    "defaultLocale": {
+      "type": "string",
+      "minLength": 1,
+      "pattern": "^[a-zA-Z]{2,3}(-[a-zA-Z]{2,3})?$",
+      "description": "The locale that should be preferred when creating new Shape items. This must be an entry in the locales array."
+    },
+    "locales": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "string",
+        "minLength": 1,
+        "pattern": "^[a-zA-Z]{2,3}(-[a-zA-Z]{2,3})?$"
+      }
+    },
+    "queries": {
+      "$ref": "https://schema.takeshape.io/project-schema/meta-schema-v3.1.0#/definitions/queryMap",
+      "description": "Queries map directly to queries your project's GraphQL API"
+    },
+    "mutations": {
+      "$ref": "https://schema.takeshape.io/project-schema/meta-schema-v3.1.0#/definitions/queryMap",
+      "description": "Mutations map directly to mutations your project's GraphQL API"
+    },
+    "shapes": {
+      "$ref": "#/definitions/shapeMap",
+      "description": "A Shape is a schema object for structuring and storing data from one or more sources, including the TakeShape data store and connected services."
+    },
+    "forms": {
+      "$ref": "#/definitions/formMap",
+      "description": "Forms define a visual interface for editing Shapes in the TakeShape UI."
+    },
+    "workflows": {
+      "$ref": "#/definitions/workflowMap",
+      "description": "Workflows describe the status of a shape item. Every schema starts with a default workflow with two steps, Disabled and Enabled"
+    },
+    "dataKey": {
+      "type": "string"
+    },
+    "services": {
+      "$ref": "#/definitions/storedServiceMap",
+      "description": "By connecting new Services to your project schema, you can add shapes, queries, and mutations from 3rd party sources to your API in TakeShape. This allows you to mesh together exactly the API you need to interact with all of the services your app or business depends upon. Services use an encrypted configuration to keep auth tokens secret. For this reason, services can only be added to a schema through the web client or through the Admin API."
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "projectId",
+    "created",
+    "updated",
+    "apiVersion",
+    "schemaVersion",
+    "version",
+    "defaultLocale",
+    "locales",
+    "shapes",
+    "queries",
+    "mutations",
+    "workflows"
+  ]
+}