validate_descriptor¶
Summary¶
- validate_descriptor(descriptors: list[MapDescriptor], gdrive_api_key=None, skip_music_download_test=False) ValidationResultBundle¶
The entry-point for validating MapDescriptor .yaml files.
- Parameters:
descriptors (list[MapDescriptor]) – A list of MapDescriptor objects representing your .yaml files.
gdrive_api_key (string, optional) – Optional. Needed in order to run the Music Download test if one of your download mirrors is Google Drive. Not used otherwise.
skip_music_download_test (bool, optional) – If set to True, the Music Download Check will be skipped. Defaults to False.
- Returns:
A bundle containing the overall results, as well as a list containing objects that represent each of the individual results.
- Return type:
Importing¶
from cs_board_tools.validation.main import validate_descriptor