:py:mod:`gbif_registrar.validate`
=================================

.. py:module:: gbif_registrar.validate

.. autoapi-nested-parse::

   Validate the dataset registrations file.



Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   gbif_registrar.validate.validate_registrations



.. py:function:: validate_registrations(registrations_file)

   Validates the dataset registrations file.

   This function validates the dataset registrations file by checking for
   completeness, local dataset ID format, group registrations, local
   endpoints, and synchronization status. If any issues are found, a warning
   is raised.

   :param registrations_file: Path of the dataset registrations file.
   :type registrations_file: str or pathlike object

   :rtype: None

   :Warns: **UserWarning** -- Warnings are issued if registration issues are found.

   .. rubric:: Examples

   >>> validate_registrations('registrations.csv')