openacr-0.1.0.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "openacr-0.1.0.json",
  "title": "OpenACR",
  "description": "Open Accessibility Conformance Report (OpenACR) as a YAML file.",
  "type": "object",
  "properties": {
    "title": {
      "description": "The title of the report in the heading format of '[Company Name] Accessibility Conformance Report'.",
      "type": "string"
    },
    "product": {
      "description": "Product information",
      "type": "object",
      "properties": {
        "name": {
          "description": "Product name.",
          "type": "string"
        },
        "version": {
          "description": "Product version if available.",
          "type": "string"
        },
        "description": {
          "description": "A brief description of the product.",
          "type": "string"
        }
      },
      "required": ["name"]
    },
    "report_date": {
      "description": "Report date. If none is provided today's date is used as default in any output.",
      "type": "string"
    },
    "author": {
      "description": "Author information.",
      "$ref": "#/definitions/contact"
    },
    "vendor": {
      "description": "Vendor information.",
      "$ref": "#/definitions/contact"
    },
    "notes": {
      "description": "Any details or explanation about the product or the report.",
      "type": "string"
    },
    "evaluation_methods_used": {
      "description": "Include a description of evaluation methods used to complete the OpenACR for the product under test.",
      "type": "string"
    },
    "legal_disclaimer": {
      "description": "Area for any legal disclaimer text required by your organization.",
      "type": "string"
    },
    "license": {
      "type": "string",
      "description": "You should specify a license for your OpenACR so that people know how they are permitted to use it, and any restrictions you're placing on it. Must be a valid SPDX license see https://spdx.org/licenses/. If none is provided 'CC-BY-4.0' is assumed default in any output."
    },
    "repository": {
      "description": "Specify the place where your OpenACR lives. This is helpful for people who want to contribute.",
      "type": "string"
    },
    "feedback": {
      "description": "The url to your project's issue tracker to which issues should be reported. These are helpful for people who encounter issues with your OpenACR.",
      "type": "string"
    },
    "related_openacrs": {
      "description": "Link to related OpenACRs. E.g. CKEditor is a library used by Drupal and both have OpenACRs.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "url": {
            "description": "Link to related OpenACR.",
            "type": "string"
          },
          "type": {
            "description": "Specify whether the link is a primary or secondary.",
            "enum": ["primary", "secondary"]
          }
        }
      }
    },
    "chapters": {
      "type": "object",
      "properties": {
        "success_criteria_level_a": {
          "description": "Success criteria level A. Table/chapter 1 in all versions.",
          "type": "object",
          "properties": {
            "notes": {
              "description": "Any details or explanation about the chapter.",
              "type": "string"
            },
            "criteria": {
              "$ref": "#/definitions/criteria"
            }
          }
        },
        "success_criteria_level_aa": {
          "description": "Success criteria level AA. Table/chapter 2 in all versions.",
          "type": "object",
          "properties": {
            "notes": {
              "description": "Any details or explanation about the chapter.",
              "type": "string"
            },
            "criteria": {
              "$ref": "#/definitions/criteria"
            }
          }
        },
        "success_criteria_level_aaa": {
          "description": "Success criteria level AAA. Table/chapter 3 in all versions.",
          "type": "object",
          "properties": {
            "notes": {
              "description": "Any details or explanation about the chapter.",
              "type": "string"
            },
            "criteria": {
              "$ref": "#/definitions/criteria"
            }
          }
        },
        "hardware": {
          "description": "Hardware (chapter 4 in 508/WCAG/INT versions, chapter 8 in EU version).",
          "type": "object",
          "properties": {
            "notes": {
              "description": "Any details or explanation about the chapter.",
              "type": "string"
            },
            "criteria": {
              "$ref": "#/definitions/criteria"
            }
          }
        }
      }
    }
  },
  "required": ["title", "product", "author"],
  "definitions": {
    "contact": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "company_name": {
          "type": "string"
        },
        "address": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "phone": {
          "type": "string"
        },
        "website": {
          "type": "string"
        }
      },
      "required": ["email"]
    },
    "criteria": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "num": {
            "description": "Criteria number.",
            "type": "string"
          },
          "components": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "description": "Name of component. E.g. Web, Electronic Docs, Authoring Tools, Software, and so on.",
                  "type": "string"
                },
                "adherence": {
                  "type": "object",
                  "properties": {
                    "level": {
                      "description": "Conformance level.",
                      "type": "string"
                    },
                    "notes": {
                      "description": "Remarks and Explanations.",
                      "type": "string"
                    }
                  },
                  "required": ["level"]
                }
              },
              "required": ["name"]
            }
          }
        },
        "required": ["num"]
      }
    }
  }
}