summaryrefslogtreecommitdiff
path: root/src/mailman/interfaces/api.py
diff options
context:
space:
mode:
authorBarry Warsaw2016-01-13 00:14:08 -0500
committerBarry Warsaw2016-01-13 00:17:49 -0500
commitd75a7ebb46279f341b498bf517d07e9ae4c27f0a (patch)
treebaaea8a2dc102887b057f9da5184bbe61ba22aef /src/mailman/interfaces/api.py
parent03bb57c8c2a47a08e19b20975622ebb2ef2b81c6 (diff)
downloadmailman-d75a7ebb46279f341b498bf517d07e9ae4c27f0a.tar.gz
mailman-d75a7ebb46279f341b498bf517d07e9ae4c27f0a.tar.zst
mailman-d75a7ebb46279f341b498bf517d07e9ae4c27f0a.zip
Diffstat (limited to 'src/mailman/interfaces/api.py')
-rw-r--r--src/mailman/interfaces/api.py37
1 files changed, 37 insertions, 0 deletions
diff --git a/src/mailman/interfaces/api.py b/src/mailman/interfaces/api.py
new file mode 100644
index 000000000..f2b33ea09
--- /dev/null
+++ b/src/mailman/interfaces/api.py
@@ -0,0 +1,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."""