vulkaninfo/json_validation_process.md

   1 # Validating [vulkaninfo](https://github.com/KhronosGroup/Vulkan-Tools/tree/main/vulkaninfo) JSON output
   2
   3 The format of vulkaninfo's JSON output is designed to be used as input for the
   4 [Vulkan Profiles](https://github.com/KhronosGroup/Vulkan-Profiles)
   5 solution.
   6
   7 The Vulkan Profiles JSON schema specifies exactly how the JSON must be structured.
   8 The schemas may be found at [here](https://schema.khronos.org/vulkan/).
   9 Select the latest schema that `vulkaninfo` was designed to be used with, or simply take the latest available schema.
  10
  11 ## Steps to validate JSON data against the Vulkan Profiles schema
  12
  13 1. Generate the text to be tested using `vulkaninfo --json` which creates a `.json` file automatically.
  14 1. Download the [Vulkan Profiles schema](https://schema.khronos.org/vulkan/) to another file.
  15 1. For each of the on-line JSON validator tools listed below:
  16    1. Paste the schema and and sample text into the `schema` and `data` fields.
  17    1. Depending on the tool, it may validate automatically, or require clicking a `validate` button.
  18    1. Ensure the tool reports no errors.
  19
  20 ## List of recommended JSON validator tools
  21
  22 * https://www.jsonschemavalidator.net/
  23 * https://jsonschemalint.com/#/version/draft-04/markup/json
  24 * https://json-schema-validator.herokuapp.com/index.jsp