From c92b56642775602f80c452d26565225aa045f2f4 Mon Sep 17 00:00:00 2001
From: Evan Cordell <cordell.evan@gmail.com>
Date: Wed, 26 Jul 2017 14:21:51 -0400
Subject: [PATCH] Add doc comments to data interface for manifest labels
---
endpoints/api/manifest_models_interface.py | 65 ++++++++++++++++++++--
endpoints/api/manifest_models_pre_oci.py | 2 +-
2 files changed, 61 insertions(+), 6 deletions(-)
diff --git a/endpoints/api/manifest_models_interface.py b/endpoints/api/manifest_models_interface.py
index 5157fb0da..618e434b7 100644
--- a/endpoints/api/manifest_models_interface.py
+++ b/endpoints/api/manifest_models_interface.py
@@ -12,7 +12,14 @@ class ManifestLabel(
'source_type_name',
'media_type_name',
])):
-
+ """
+ ManifestLabel represents a label on a manifest
+ :type uuid: string
+ :type key: string
+ :type value: string
+ :type source_type_name: string
+ :type media_type_name: string
+ """
def to_dict(self):
return {
'id': self.uuid,
@@ -25,18 +32,66 @@ class ManifestLabel(
@add_metaclass(ABCMeta)
class ManifestLabelInterface(object):
+ """
+ Data interface that the manifest labels API uses
+ """
+
@abstractmethod
def get_manifest_labels(self, namespace_name, repository_name, manifestref, filter=None):
- pass
+ """
+
+ Args:
+ namespace_name: string
+ repository_name: string
+ manifestref: string
+ filter: string
+
+ Returns:
+ list(ManifestLabel) or None
+
+ """
@abstractmethod
def create_manifest_label(self, namespace_name, repository_name, manifestref, key, value, source_type_name, media_type_name):
- pass
+ """
+
+ Args:
+ namespace_name: string
+ repository_name: string
+ manifestref: string
+ key: string
+ value: string
+ source_type_name: string
+ media_type_name: string
+
+ Returns:
+ ManifestLabel or None
+ """
@abstractmethod
def get_manifest_label(self, namespace_name, repository_name, manifestref, label_uuid):
- pass
+ """
+
+ Args:
+ namespace_name: string
+ repository_name: string
+ manifestref: string
+ label_uuid: string
+
+ Returns:
+ ManifestLabel or None
+ """
@abstractmethod
def delete_manifest_label(self, namespace_name, repository_name, manifestref, label_uuid):
- pass
+ """
+
+ Args:
+ namespace_name: string
+ repository_name: string
+ manifestref: string
+ label_uuid: string
+
+ Returns:
+ ManifestLabel or None
+ """
diff --git a/endpoints/api/manifest_models_pre_oci.py b/endpoints/api/manifest_models_pre_oci.py
index 5d0c7cbdd..9cc44ce93 100644
--- a/endpoints/api/manifest_models_pre_oci.py
+++ b/endpoints/api/manifest_models_pre_oci.py
@@ -47,4 +47,4 @@ class ManifestLabelPreOCI(ManifestLabelInterface):
media_type_name=label_obj.media_type.name,
)
-pre_oci_model = ManifestLabelPreOCI()
\ No newline at end of file
+pre_oci_model = ManifestLabelPreOCI()