sidequest_common.schemas.addons
===============================

.. py:module:: sidequest_common.schemas.addons

.. autoapi-nested-parse::

   Addon schemas. Files are hosted elsewhere (GitHub releases, CurseForge, Wago); we only store links.



Attributes
----------

.. autoapisummary::

   sidequest_common.schemas.addons.ADDON_ORIGIN_LABELS


Classes
-------

.. autoapisummary::

   sidequest_common.schemas.addons.AddonCreate
   sidequest_common.schemas.addons.AddonOrigin
   sidequest_common.schemas.addons.AddonSchema
   sidequest_common.schemas.addons.AddonUpdate


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

.. py:class:: AddonCreate

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


   Body for ``POST /api/addons`` (officer).


   .. py:attribute:: download_url
      :type:  str


   .. py:attribute:: homepage_url
      :type:  str | None


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: origin
      :type:  AddonOrigin


   .. py:attribute:: slug
      :type:  str


   .. py:attribute:: summary
      :type:  str


   .. py:attribute:: version
      :type:  str


.. py:class:: AddonOrigin

   Bases: :py:obj:`enum.StrEnum`


   Who made the addon: the guild itself, or a community addon it recommends.

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: COMMUNITY
      :value: 'community'



   .. py:attribute:: GUILD
      :value: 'guild'



.. py:class:: AddonSchema

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


   An addon as returned by ``GET /api/addons``.


   .. py:attribute:: download_url
      :type:  str


   .. py:attribute:: homepage_url
      :type:  str | None


   .. py:attribute:: id
      :type:  uuid.UUID


   .. py:attribute:: model_config


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: origin
      :type:  AddonOrigin


   .. py:attribute:: slug
      :type:  str


   .. py:attribute:: summary
      :type:  str


   .. py:attribute:: updated_at
      :type:  datetime.datetime


   .. py:attribute:: version
      :type:  str


.. py:class:: AddonUpdate

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


   Body for ``PATCH /api/addons/{id}`` (officer). Only present fields change.


   .. py:attribute:: download_url
      :type:  str | None


   .. py:attribute:: homepage_url
      :type:  str | None


   .. py:attribute:: name
      :type:  str | None


   .. py:attribute:: origin
      :type:  AddonOrigin | None


   .. py:attribute:: summary
      :type:  str | None


   .. py:attribute:: version
      :type:  str | None


.. py:data:: ADDON_ORIGIN_LABELS
   :type:  dict[AddonOrigin, str]