pipeworks_mud_mapper.models.metadata
====================================

.. py:module:: pipeworks_mud_mapper.models.metadata

.. autoapi-nested-parse::

   Shared metadata models for map and zone files.

   These models capture versioning and export provenance while keeping the
   runtime schema clean. Authoring files (MapFile) include version counters,
   while exported zone files include an exported_from stamp.



Classes
-------

.. autoapisummary::

   pipeworks_mud_mapper.models.metadata.ExportedFrom
   pipeworks_mud_mapper.models.metadata.MapMetadata
   pipeworks_mud_mapper.models.metadata.ZoneMetadata


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

.. py:class:: ExportedFrom(/, **data)

   Bases: :py:obj:`pydantic.BaseModel`


   Provenance for a zone export.

   Stored under ``metadata.exported_from`` on exported zone files.


.. py:class:: MapMetadata(/, **data)

   Bases: :py:obj:`pydantic.BaseModel`


   Metadata stored on authoring ``*.map.json`` exports.


.. py:class:: ZoneMetadata(/, **data)

   Bases: :py:obj:`pydantic.BaseModel`


   Metadata stored on exported zone files.