Source code for vo_models.vosi.capabilities.models

"""VOSICapabilities pydantic-xml models."""

from typing import Union

from pydantic_xml import BaseXmlModel, element

from vo_models.tapregext.models import TableAccess
from vo_models.voresource.models import NSMAP as VORESOURCE_NSMAP
from vo_models.voresource.models import Capability

NSMAP = {
    "vosi": "http://www.ivoa.net/xml/VOSICapabilities/v1.0",
    "xsd": "http://www.w3.org/2001/XMLSchema",
    "xsi": "http://www.w3.org/2001/XMLSchema-instance",
    "vs": "http://www.ivoa.net/xml/VODataService/v1.1",
} | VORESOURCE_NSMAP



[docs]
class VOSICapabilities(BaseXmlModel, tag="capabilities", ns="vosi", nsmap=NSMAP):
    """A listing of capabilities supported by a service

    Parameters:
        capability:
            (element) - A capability supported by the service.
                A protocol-specific capability is included by specifying a vr:Capability sub-type via an xsi:type
                attribute on this element.
    """

    capability: list[Union[TableAccess, Capability]] = element(
        tag="capability",
        ns="",
        default=[],
    )