metadata_presenter 0.1.0 → 0.1.5

data/schemas/link/link.json

@@ -0,0 +1,46 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/link",
+  "_name": "link",
+  "title": "Link",
+  "type": "object",
+  "properties": {
+    "_type": {
+      "const": "link"
+    },
+    "text": {
+      "title": "Link text",
+      "description": "Link text to display",
+      "type": "string",
+      "content": true
+    },
+    "href": {
+      "title": "Link url",
+      "description": "Page Id or absolute url",
+      "type": "string",
+      "content": true,
+      "url": true
+    },
+    "active": {
+      "title": "Active",
+      "description": "Whether link is active",
+      "type": "boolean"
+    },
+    "attributes": {
+      "title": "Link attributes",
+      "description": "Attributes to pass to link",
+      "type": "object"
+    }
+  },
+  "required": [
+    "text",
+    "href"
+  ],
+  "allOf": [
+    {
+      "$ref": "definition.block"
+    }
+  ],
+  "category": [
+    "definition"
+  ]
+}

data/schemas/page/confirmation.json

@@ -0,0 +1,35 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/page/confirmation",
+  "_name": "page.confirmation",
+  "title": "Confirmation",
+  "description": "Confirm to users that they’ve completed their answers",
+  "type": "object",
+  "properties": {
+    "_id": {
+      "const": "page.confirmation"
+    },
+    "_type": {
+      "const": "page.confirmation"
+    },
+    "heading": {
+      "multiline": true
+    },
+    "body": {
+      "multiline": true
+    },
+    "lede": {
+      "multiline": true
+    }
+  },
+  "required": [
+    "_id",
+    "_type",
+    "heading"
+  ],
+  "additionalProperties": false,
+  "allOf": [
+    {
+      "$ref": "definition.page.content"
+    }
+  ]
+}

data/schemas/page/start.json

@@ -0,0 +1,34 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/page/start",
+  "_name": "page.start",
+  "title": "Start page",
+  "description": "Let users start using a service",
+  "type": "object",
+  "properties": {
+    "_type": {
+      "const": "page.start"
+    },
+    "enable_steps": {
+      "const": true
+    },
+    "components": {
+      "accepts": [
+        "content"
+      ]
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "definition.page.form"
+    }
+  ],
+  "ui_category": {
+    "main": [
+      "lede",
+      "body"
+    ]
+  },
+  "required": [
+    "steps"
+  ]
+}

data/schemas/page/summary.json

@@ -0,0 +1,63 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/page/summary",
+  "_name": "page.summary",
+  "title": "Check answers",
+  "description": "Let users check and change their answers before submitting",
+  "type": "object",
+  "properties": {
+    "_type": {
+      "const": "page.summary"
+    },
+    "section_heading": {
+      "title": "Section heading",
+      "type": "string",
+      "description": "Section to display before the heading"
+    },
+    "heading": {
+      "type": "string",
+      "default": "Check your answers"
+    },
+    "lede": {
+      "title": "Lede",
+      "type": "string",
+      "description": "Content before the body"
+    },
+    "body": {
+      "title": "Body",
+      "type": "string",
+      "description": "Optional content before showing the summary"
+    },
+    "summary_of": {
+      "title": "Summary of",
+      "description": "Page/section that summary summarises"
+    },
+    "send_heading": {
+      "title": "Send heading",
+      "description": "Heading to display before accept and send button",
+      "type": "string",
+      "content": true,
+      "default": "Now send your application"
+    },
+    "send_body": {
+      "title": "Send content",
+      "description": "Content to display before accept and send button - use [markdown](https://www.gov.uk/guidance/how-to-publish-on-gov-uk/markdown) to format text or add hyperlinks",
+      "type": "string",
+      "content": true,
+      "multiline": true,
+      "default": "By submitting this application you confirm that, to the best of your knowledge, the details you are providing are correct."
+    }
+  },
+  "required": [
+    "_id",
+    "_type",
+    "heading",
+    "send_heading",
+    "send_body"
+  ],
+  "additionalProperties": false,
+  "allOf": [
+    {
+      "$ref": "definition.page.form"
+    }
+  ]
+}

data/schemas/request/service.json

@@ -0,0 +1,13 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/request/service",
+  "_name": "request.service",
+  "title": "Create new service",
+  "description": "Request object schema for creating and updating a new service",
+  "type": "object",
+  "properties": {
+    "metadata": {
+      "$ref": "service.base"
+    }
+  },
+  "required": ["metadata"]
+}

data/schemas/service/base.json

@@ -0,0 +1,52 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/service/base",
+  "_name": "service.base",
+  "title": "Base service schema",
+  "description": "Base schema for a service",
+  "type": "object",
+  "properties": {
+    "_id": {
+      "const": "service.base"
+    },
+    "_type": {
+      "const": "service.base"
+    },
+    "service_id": {
+      "type": "string"
+    },
+    "service_name": {
+      "type": "string"
+    },
+    "version_id": {
+      "type": "string"
+    },
+    "created_at": {
+      "type": "string"
+    },
+    "created_by": {
+      "type": "string"
+    },
+    "locale": {
+      "$ref": "service.locale"
+    },
+    "configuration": {
+      "$ref": "configuration"
+    },
+    "pages": {
+      "type": "array",
+      "items": {
+        "$ref": "definition.page"
+      }
+    }
+  },
+  "required": [
+    "_id",
+    "_type",
+    "service_name",
+    "created_by",
+    "locale",
+    "configuration",
+    "pages"
+  ],
+  "additionalProperties": false
+}

data/schemas/service/configuration.json

@@ -0,0 +1,22 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/configuration",
+  "_name": "configuration",
+  "title": "Service configuration",
+  "description": "Service configuration",
+  "type": "object",
+  "properties": {
+    "service": {
+      "$ref": "config.service"
+    },
+    "meta": {
+      "$ref": "config.meta"
+    }
+  },
+  "required": [
+    "service",
+    "meta"
+  ],
+  "category": [
+    "configuration"
+  ]
+}

data/schemas/service/locale.json

@@ -0,0 +1,12 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/service/locale",
+  "_name": "service.locale",
+  "title": "Service version locale",
+  "description": "The locale of a version of a service",
+  "type": "string",
+  "default": "en",
+  "enum": [
+    "en",
+    "cy"
+  ]
+}

data/schemas/text/text.json

@@ -0,0 +1,23 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/text",
+  "_name": "text",
+  "title": "Text",
+  "description": "Let users enter text that’s no longer than a single line",
+  "type": "object",
+  "properties": {
+    "_type": {
+      "const": "text"
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "definition.field"
+    },
+    {
+      "$ref": "validations#/definitions/string_bundle"
+    },
+    {
+      "$ref": "definition.width_class.input"
+    }
+  ]
+}

data/schemas/validations/validations.json

@@ -0,0 +1,443 @@
+{
+  "$id": "http://gov.uk/schema/v1.0.0/validations",
+  "_name": "validations",
+  "title": "Validations",
+  "type": "object",
+  "definitions": {
+    "error_strings": {
+      "type": "object",
+      "properties": {
+        "any": {
+          "title": "Error message",
+          "description": "Error message users see if their answer fails validation - write {control} to show the question in the message",
+          "type": "string",
+          "role": "error_string"
+        }
+      }
+    },
+    "required": {
+      "title": "Required",
+      "description": "Whether the user must answer a question",
+      "oneOf": [
+        {
+          "$ref": "definition.conditional.boolean"
+        }
+      ],
+      "default": true
+    },
+    "errors_required": {
+      "title": "Error messages for ‘Required’",
+      "allOf": [
+        {
+          "$ref": "#/definitions/error_strings"
+        }
+      ]
+    },
+    "errors_accept": {
+      "title": "Error messages for ‘Accept’",
+      "allOf": [
+        {
+          "$ref": "#/definitions/error_strings"
+        }
+      ]
+    },
+    "errors_max_size": {
+      "title": "Error messages for ‘Max Size’",
+      "allOf": [
+        {
+          "$ref": "#/definitions/error_strings"
+        }
+      ]
+    },
+    "min_length": {
+      "title": "Minimum length",
+      "description": "The minimum characters users must enter",
+      "type": "number",
+      "minimum": 0
+    },
+    "errors_min_length": {
+      "title": "Error messages for ‘Minimum length’",
+      "allOf": [
+        {
+          "$ref": "#/definitions/error_strings"
+        }
+      ]
+    },
+    "max_length": {
+      "title": "Maximum length",
+      "description": "The maximum characters users can enter",
+      "type": "number",
+      "minimum": 0
+    },
+    "errors_max_length": {
+      "title": "Error messages for ‘Maximum length’",
+      "allOf": [
+        {
+          "$ref": "#/definitions/error_strings"
+        }
+      ]
+    },
+    "pattern": {
+      "title": "Pattern to match string against",
+      "description": "A regular expression for validating users’ answers",
+      "type": "string"
+    },
+    "errors_pattern": {
+      "title": "Error messages for pattern",
+      "allOf": [
+        {
+          "$ref": "#/definitions/error_strings"
+        }
+      ]
+    },
+    "format": {
+      "title": "Format to match string against",
+      "description": "Format used for validating users’ answers",
+      "type": "string"
+    },
+    "errors_format": {
+      "title": "Error messages for format",
+      "allOf": [
+        {
+          "$ref": "#/definitions/error_strings"
+        }
+      ]
+    },
+    "multiple_of": {
+      "title": "Multiple of",
+      "description": "Whether users must enter a multiple of another number",
+      "type": "number",
+      "minimum": 0
+    },
+    "errors_multiple_of": {
+      "title": "Error messages for ‘Multiple of’",
+      "allOf": [
+        {
+          "$ref": "#/definitions/error_strings"
+        }
+      ]
+    },
+    "maximum": {
+      "title": "Maximum value",
+      "description": "The largest number that users can enter",
+      "type": "number",
+      "minimum": 0
+    },
+    "errors_maximum": {
+      "title": "Error messages for ‘Maximum value’",
+      "allOf": [
+        {
+          "$ref": "#/definitions/error_strings"
+        }
+      ]
+    },
+    "exclusive_maximum": {
+      "title": "Is maximum value exclusive?",
+      "description": "Excludes the maximum value from the range users can enter",
+      "type": "boolean"
+    },
+    "errors_exclusive_maximum": {
+      "title": "Error messages for ‘Maximum value is exclusive",
+      "allOf": [
+        {
+          "$ref": "#/definitions/error_strings"
+        }
+      ]
+    },
+    "minimum": {
+      "title": "Minimum value",
+      "description": "The smallest number that users can enter",
+      "type": "number",
+      "minimum": 0
+    },
+    "errors_minimum": {
+      "title": "Error messages for for ‘Minimum value’",
+      "allOf": [
+        {
+          "$ref": "#/definitions/error_strings"
+        }
+      ]
+    },
+    "exclusive_minimum": {
+      "title": "Is minimum value exclusive?",
+      "description": "Excludes the minimum value from the range users can enter",
+      "type": "boolean"
+    },
+    "errors_exclusive_minimum": {
+      "title": "Error messages for ‘Minimum value is exclusive",
+      "allOf": [
+        {
+          "$ref": "#/definitions/error_strings"
+        }
+      ]
+    },
+    "date_before": {
+      "title": "Before date",
+      "description": "Date which user input must be before - eg. 2000-10-24",
+      "type": "string",
+      "format": "date"
+    },
+    "errors_date_before": {
+      "title": "Error messages for ‘Before date’",
+      "allOf": [
+        {
+          "$ref": "#/definitions/error_strings"
+        }
+      ]
+    },
+    "date_after": {
+      "title": "After date",
+      "description": "Date which user input must be after - eg. 2000-10-24",
+      "type": "string",
+      "format": "date"
+    },
+    "errors_date_after": {
+      "title": "Error messages for ‘After date’",
+      "allOf": [
+        {
+          "$ref": "#/definitions/error_strings"
+        }
+      ]
+    },
+    "date_within_next": {
+      "title": "Within next",
+      "description": "Date which user input must be before - eg. 1y, 4Mm, 2w, 100d",
+      "type": "object",
+      "properties": {
+        "amount": {
+          "type": "number"
+        },
+        "unit": {
+          "type": "string",
+          "enum": [
+            "years",
+            "months",
+            "weeks",
+            "days"
+          ]
+        }
+      },
+      "required": [
+        "amount",
+        "unit"
+      ]
+    },
+    "errors_date_within_next": {
+      "title": "Error messages for ‘Within next’",
+      "allOf": [
+        {
+          "$ref": "#/definitions/error_strings"
+        }
+      ]
+    },
+    "date_within_last": {
+      "title": "Within last",
+      "description": "Date which user input must be before - eg. 1y, 4Mm, 2w, 100d",
+      "type": "object",
+      "properties": {
+        "amount": {
+          "type": "number"
+        },
+        "unit": {
+          "type": "string",
+          "enum": [
+            "years",
+            "months",
+            "weeks",
+            "days"
+          ]
+        }
+      },
+      "required": [
+        "amount",
+        "unit"
+      ]
+    },
+    "errors_date_within_last": {
+      "title": "Error messages for ‘Within last’",
+      "allOf": [
+        {
+          "$ref": "#/definitions/error_strings"
+        }
+      ]
+    },
+    "required_bundle": {
+      "properties": {
+        "validation": {
+          "title": "Validation",
+          "description": "Values for default validation",
+          "role": "validation",
+          "properties": {
+            "required": {
+              "$ref": "#/definitions/required"
+            }
+          }
+        },
+        "errors": {
+          "title": "Errors",
+          "description": "Strings to override for default error messages",
+          "role": "error_strings",
+          "properties": {
+            "required": {
+              "$ref": "#/definitions/errors_required"
+            }
+          }
+        }
+      }
+    },
+    "upload_bundle": {
+      "properties": {
+        "validation": {
+          "title": "Validation",
+          "description": "Values for default validation",
+          "role": "validation",
+          "properties": {
+            "accept": {
+              "title": "Accepted types",
+              "description": "Which file types to accept",
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "max_size": {
+              "title": "Maximum size",
+              "description": "Maximum file size as human readable string or bytes",
+              "type": "string"
+            }
+          }
+        },
+        "errors": {
+          "title": "Errors",
+          "description": "Strings to override for default error messages",
+          "role": "error_strings",
+          "properties": {
+            "accept": {
+              "$ref": "#/definitions/errors_accept"
+            },
+            "maxSize": {
+              "$ref": "#/definitions/errors_max_size"
+            }
+          }
+        }
+      }
+    },
+    "string_bundle": {
+      "properties": {
+        "validation": {
+          "properties": {
+            "min_length": {
+              "$ref": "#/definitions/min_length"
+            },
+            "max_length": {
+              "$ref": "#/definitions/max_length"
+            },
+            "pattern": {
+              "$ref": "#/definitions/pattern"
+            },
+            "format": {
+              "$ref": "#/definitions/format"
+            }
+          }
+        },
+        "errors": {
+          "properties": {
+            "min_length": {
+              "$ref": "#/definitions/errors_min_length"
+            },
+            "max_length": {
+              "$ref": "#/definitions/errors_max_length"
+            },
+            "pattern": {
+              "$ref": "#/definitions/errors_pattern"
+            },
+            "format": {
+              "$ref": "#/definitions/errors_format"
+            }
+          }
+        }
+      }
+    },
+    "number_bundle": {
+      "properties": {
+        "validation": {
+          "properties": {
+            "multiple_of": {
+              "$ref": "#/definitions/multiple_of"
+            },
+            "maximum": {
+              "$ref": "#/definitions/maximum"
+            },
+            "exclusive_maximum": {
+              "$ref": "#/definitions/exclusive_maximum"
+            },
+            "minimum": {
+              "$ref": "#/definitions/minimum"
+            },
+            "exclusive_minimum": {
+              "$ref": "#/definitions/exclusive_minimum"
+            }
+          }
+        },
+        "errors": {
+          "properties": {
+            "multiple_of": {
+              "$ref": "#/definitions/errors_multiple_of"
+            },
+            "maximum": {
+              "$ref": "#/definitions/errors_maximum"
+            },
+            "exclusive_maximum": {
+              "$ref": "#/definitions/errors_exclusive_maximum"
+            },
+            "minimum": {
+              "$ref": "#/definitions/errors_minimum"
+            },
+            "exclusive_minimum": {
+              "$ref": "#/definitions/errors_exclusive_minimum"
+            }
+          }
+        }
+      }
+    },
+    "date_bundle": {
+      "properties": {
+        "validation": {
+          "properties": {
+            "date_before": {
+              "$ref": "#/definitions/date_before"
+            },
+            "date_after": {
+              "$ref": "#/definitions/date_after"
+            },
+            "date_within_next": {
+              "$ref": "#/definitions/date_within_next"
+            },
+            "date_within_last": {
+              "$ref": "#/definitions/date_within_last"
+            }
+          }
+        },
+        "errors": {
+          "properties": {
+            "date_before": {
+              "$ref": "#/definitions/errors_date_before"
+            },
+            "date_after": {
+              "$ref": "#/definitions/errors_date_after"
+            },
+            "date_within_next": {
+              "$ref": "#/definitions/errors_date_within_next"
+            },
+            "date_within_last": {
+              "$ref": "#/definitions/errors_date_within_last"
+            }
+          }
+        }
+      }
+    }
+  },
+  "category": [
+    "definition"
+  ]
+}