summaryrefslogtreecommitdiff
path: root/src/mailman/interfaces/api.py
blob: f2b33ea093fe56564ecc1c7e3388eaa43f664cf4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# Copyright (C) 2016 by the Free Software Foundation, Inc.
#
# This file is part of GNU Mailman.
#
# GNU Mailman is free software: you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free
# Software Foundation, either version 3 of the License, or (at your option)
# any later version.
#
# GNU Mailman is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
# more details.
#
# You should have received a copy of the GNU General Public License along with
# GNU Mailman.  If not, see <http://www.gnu.org/licenses/>.

"""REST web service API context."""

__all__ = [
    'IAPI',
    ]


from zope.interface import Attribute, Interface


class IAPI(Interface):
    """The REST web service context."""

    version = Attribute("""The REST API version.""")

    def from_uuid(uuid):
        """Return the string representation of a UUID."""

    def to_uuid(uuid_repr):
        """Return the UUID from the string representation."""