# sphobjinv.schema

JSON schema to validate inventory dictionaries.

This module is part of `sphobjinv`, a toolkit for manipulation and inspection of Sphinx objects.inv files.

Author

  Brian Skinn (brian.skinn@gmail.com)

File Created

  7 Dec 2017

Copyright

  (c) Brian Skinn 2016-2025

Source Repository

  https://github.com/bskinn/sphobjinv

Documentation

  https://sphobjinv.readthedocs.io/en/stable

License

  Code: MIT License

  Docs & Docstrings: CC BY 4.0 International License

  See LICENSE.txt for full license terms.

Members

json_schema = {'$schema': 'https://json-schema.org/draft-04/schema#', 'additionalProperties': False, 'patternProperties': {'^\\d+': {'additionalProperties': False, 'properties': {'dispname': {'type': 'string'}, 'domain': {'type': 'string'}, 'name': {'type': 'string'}, 'priority': {'type': 'string'}, 'role': {'type': 'string'}, 'uri': {'type': 'string'}}, 'required': ['name', 'domain', 'role', 'priority', 'uri', 'dispname'], 'type': 'object'}}, 'properties': {'count': {'type': 'integer'}, 'metadata': {}, 'project': {'type': 'string'}, 'version': {'type': 'string'}}, 'required': ['project', 'version', 'count'], 'type': 'object'}

  JSON schema for validating the `dict` forms of Sphinx objects.inv inventories as generated from or expected by `Inventory` classes.