[libvirt PATCH 03/11] ci: util: Document that get_registry_images() returns raw data
The current documentation makes it sound like the function
will only return a simple list containing the name of each
image available on the registry, but it actually returns a
lot more information than that.
Signed-off-by: Andrea Bolognani <abologna(a)redhat.com>
---
ci/util.py | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/ci/util.py b/ci/util.py
index e4e0955098..625428f339 100644
--- a/ci/util.py
+++ b/ci/util.py
@@ -29,8 +29,13 @@ def get_registry_images(uri: str) -> List[Dict]:
List all container images that are currently available in the given GitLab
project.
+ The raw data, as obtained from the GitLab API, is returned: this
+ will contain not only the name of each image, but also additional
+ information such as the image ID, which can be used to perform
+ further operations with subsequent calls to the GitLab API.
+
:param uri: URI pointing to a GitLab instance's image registry
- :return: list of container image names
+ :return: detailed information about container images
"""
r = urllib.request.urlopen(uri + "?per_page=100")
--
2.26.3