docs(registry): components (#154)

Author: scaleway-bot

scaleway-async/scaleway_async/registry/v1/api.py

@@ -158,7 +158,7 @@ async def get_namespace(
         Get a namespace.
         Retrieve information about a given namespace, specified by its `namespace_id` and region. Full details about the namespace, such as `description`, `project_id`, `status`, `endpoint`, `is_public`, `size`, and `image_count` are returned in the response.
         :param region: Region to target. If none is passed will use default region from the config.
-        :param namespace_id: The UUID of the namespace.
+        :param namespace_id: UUID of the namespace.
         :return: :class:`Namespace <Namespace>`
 
         Usage:
@@ -192,7 +192,7 @@ async def wait_for_namespace(
         """
         Waits for :class:`Namespace <Namespace>` to be in a final state.
         :param region: Region to target. If none is passed will use default region from the config.
-        :param namespace_id: The UUID of the namespace.
+        :param namespace_id: UUID of the namespace.
         :param options: The options for the waiter
         :return: :class:`Namespace <Namespace>`
 
@@ -239,7 +239,7 @@ async def create_namespace(
         :param project_id: Project ID on which the namespace will be created.
 
         One-of ('project_identifier'): at most one of 'organization_id', 'project_id' could be set.
-        :param is_public: Whether or not namespace is public.
+        :param is_public: Defines whether or not namespace is public.
         :return: :class:`Namespace <Namespace>`
 
         Usage:
@@ -288,7 +288,7 @@ async def update_namespace(
         :param region: Region to target. If none is passed will use default region from the config.
         :param namespace_id: ID of the namespace to update.
         :param description: Namespace description.
-        :param is_public: Whether or not the namespace is public.
+        :param is_public: Defines whether or not the namespace is public.
         :return: :class:`Namespace <Namespace>`
 
         Usage:
@@ -329,7 +329,7 @@ async def delete_namespace(
         Delete a namespace.
         Delete a given namespace. You must specify, in the endpoint, the `region` and `namespace_id` parameters of the namespace you want to delete.
         :param region: Region to target. If none is passed will use default region from the config.
-        :param namespace_id: The UUID of the namespace.
+        :param namespace_id: UUID of the namespace.
         :return: :class:`Namespace <Namespace>`
 
         Usage:
@@ -461,7 +461,7 @@ async def get_image(
         Get an image.
         Retrieve information about a given container image, specified by its `image_id` and region. Full details about the image, such as `name`, `namespace_id`, `status`, `visibility`, and `size` are returned in the response.
         :param region: Region to target. If none is passed will use default region from the config.
-        :param image_id: The UUID of the image.
+        :param image_id: UUID of the image.
         :return: :class:`Image <Image>`
 
         Usage:
@@ -493,7 +493,7 @@ async def wait_for_image(
         """
         Waits for :class:`Image <Image>` to be in a final state.
         :param region: Region to target. If none is passed will use default region from the config.
-        :param image_id: The UUID of the image.
+        :param image_id: UUID of the image.
         :param options: The options for the waiter
         :return: :class:`Image <Image>`
 
@@ -573,7 +573,7 @@ async def delete_image(
         Delete an image.
         Delete a given image. You must specify, in the endpoint, the `region` and `image_id` parameters of the image you want to delete.
         :param region: Region to target. If none is passed will use default region from the config.
-        :param image_id: The UUID of the image.
+        :param image_id: UUID of the image.
         :return: :class:`Image <Image>`
 
         Usage:
@@ -609,7 +609,7 @@ async def list_tags(
         List tags.
         List all tags for a given image, specified by region. By default, the tags listed are ordered by creation date in ascending order. This can be modified via the order_by field. You can also define additional parameters for your query, such as the `name`.
         :param region: Region to target. If none is passed will use default region from the config.
-        :param image_id: The UUID of the image.
+        :param image_id: UUID of the image.
         :param page: A positive integer to choose the page to display.
         :param page_size: A positive integer lower or equal to 100 to select the number of items to display.
         :param order_by: Criteria to use when ordering tag listings. Possible values are `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `region`, `status_asc` and `status_desc`. The default value is `created_at_asc`.
@@ -655,7 +655,7 @@ async def list_tags_all(
         List tags.
         List all tags for a given image, specified by region. By default, the tags listed are ordered by creation date in ascending order. This can be modified via the order_by field. You can also define additional parameters for your query, such as the `name`.
         :param region: Region to target. If none is passed will use default region from the config.
-        :param image_id: The UUID of the image.
+        :param image_id: UUID of the image.
         :param page: A positive integer to choose the page to display.
         :param page_size: A positive integer lower or equal to 100 to select the number of items to display.
         :param order_by: Criteria to use when ordering tag listings. Possible values are `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `region`, `status_asc` and `status_desc`. The default value is `created_at_asc`.
@@ -692,7 +692,7 @@ async def get_tag(
         Get a tag.
         Retrieve information about a given image tag, specified by its `tag_id` and region. Full details about the tag, such as `name`, `image_id`, `status`, and `digest` are returned in the response.
         :param region: Region to target. If none is passed will use default region from the config.
-        :param tag_id: The UUID of the tag.
+        :param tag_id: UUID of the tag.
         :return: :class:`Tag <Tag>`
 
         Usage:
@@ -724,7 +724,7 @@ async def wait_for_tag(
         """
         Waits for :class:`Tag <Tag>` to be in a final state.
         :param region: Region to target. If none is passed will use default region from the config.
-        :param tag_id: The UUID of the tag.
+        :param tag_id: UUID of the tag.
         :param options: The options for the waiter
         :return: :class:`Tag <Tag>`
 
@@ -760,7 +760,7 @@ async def delete_tag(
         Delete a tag.
         Delete a given image tag. You must specify, in the endpoint, the `region` and `tag_id` parameters of the tag you want to delete.
         :param region: Region to target. If none is passed will use default region from the config.
-        :param tag_id: The UUID of the tag.
+        :param tag_id: UUID of the tag.
         :param force: If two tags share the same digest the deletion will fail unless this parameter is set to true.
         :return: :class:`Tag <Tag>`
 

scaleway-async/scaleway_async/registry/v1/types.py

@@ -95,22 +95,22 @@ class Image:
 
     id: str
     """
-    The UUID of the image.
+    UUID of the image.
     """
 
     name: str
     """
-    The name of the image, it must be unique within the namespace.
+    Name of the image, it must be unique within the namespace.
     """
 
     namespace_id: str
     """
-    The UUID of the namespace the image belongs to.
+    UUID of the namespace the image belongs to.
     """
 
     status: ImageStatus
     """
-    The status of the image.
+    Status of the image.
     """
 
     status_message: Optional[str]
@@ -204,12 +204,12 @@ class Namespace:
 
     id: str
     """
-    The UUID of the namespace.
+    UUID of the namespace.
     """
 
     name: str
     """
-    The name of the namespace, unique in a region accross all organizations.
+    Name of the namespace, unique in a region accross all organizations.
     """
 
     description: str
@@ -244,7 +244,7 @@ class Namespace:
 
     is_public: bool
     """
-    Whether or not namespace is public.
+    Defines whether or not namespace is public.
     """
 
     size: int
@@ -281,7 +281,7 @@ class Tag:
 
     id: str
     """
-    The UUID of the tag.
+    UUID of the tag.
     """
 
     name: str
@@ -362,7 +362,7 @@ class GetNamespaceRequest:
 
     namespace_id: str
     """
-    The UUID of the namespace.
+    UUID of the namespace.
     """
 
 
@@ -400,7 +400,7 @@ class CreateNamespaceRequest:
 
     is_public: bool
     """
-    Whether or not namespace is public.
+    Defines whether or not namespace is public.
     """
 
 
@@ -423,7 +423,7 @@ class UpdateNamespaceRequest:
 
     is_public: Optional[bool]
     """
-    Whether or not the namespace is public.
+    Defines whether or not the namespace is public.
     """
 
 
@@ -436,7 +436,7 @@ class DeleteNamespaceRequest:
 
     namespace_id: str
     """
-    The UUID of the namespace.
+    UUID of the namespace.
     """
 
 
@@ -492,7 +492,7 @@ class GetImageRequest:
 
     image_id: str
     """
-    The UUID of the image.
+    UUID of the image.
     """
 
 
@@ -523,7 +523,7 @@ class DeleteImageRequest:
 
     image_id: str
     """
-    The UUID of the image.
+    UUID of the image.
     """
 
 
@@ -536,7 +536,7 @@ class ListTagsRequest:
 
     image_id: str
     """
-    The UUID of the image.
+    UUID of the image.
     """
 
     page: Optional[int]
@@ -569,7 +569,7 @@ class GetTagRequest:
 
     tag_id: str
     """
-    The UUID of the tag.
+    UUID of the tag.
     """
 
 
@@ -582,7 +582,7 @@ class DeleteTagRequest:
 
     tag_id: str
     """
-    The UUID of the tag.
+    UUID of the tag.
     """
 
     force: bool

scaleway/scaleway/registry/v1/api.py

@@ -158,7 +158,7 @@ def get_namespace(
         Get a namespace.
         Retrieve information about a given namespace, specified by its `namespace_id` and region. Full details about the namespace, such as `description`, `project_id`, `status`, `endpoint`, `is_public`, `size`, and `image_count` are returned in the response.
         :param region: Region to target. If none is passed will use default region from the config.
-        :param namespace_id: The UUID of the namespace.
+        :param namespace_id: UUID of the namespace.
         :return: :class:`Namespace <Namespace>`
 
         Usage:
@@ -190,7 +190,7 @@ def wait_for_namespace(
         """
         Waits for :class:`Namespace <Namespace>` to be in a final state.
         :param region: Region to target. If none is passed will use default region from the config.
-        :param namespace_id: The UUID of the namespace.
+        :param namespace_id: UUID of the namespace.
         :param options: The options for the waiter
         :return: :class:`Namespace <Namespace>`
 
@@ -237,7 +237,7 @@ def create_namespace(
         :param project_id: Project ID on which the namespace will be created.
 
         One-of ('project_identifier'): at most one of 'organization_id', 'project_id' could be set.
-        :param is_public: Whether or not namespace is public.
+        :param is_public: Defines whether or not namespace is public.
         :return: :class:`Namespace <Namespace>`
 
         Usage:
@@ -286,7 +286,7 @@ def update_namespace(
         :param region: Region to target. If none is passed will use default region from the config.
         :param namespace_id: ID of the namespace to update.
         :param description: Namespace description.
-        :param is_public: Whether or not the namespace is public.
+        :param is_public: Defines whether or not the namespace is public.
         :return: :class:`Namespace <Namespace>`
 
         Usage:
@@ -327,7 +327,7 @@ def delete_namespace(
         Delete a namespace.
         Delete a given namespace. You must specify, in the endpoint, the `region` and `namespace_id` parameters of the namespace you want to delete.
         :param region: Region to target. If none is passed will use default region from the config.
-        :param namespace_id: The UUID of the namespace.
+        :param namespace_id: UUID of the namespace.
         :return: :class:`Namespace <Namespace>`
 
         Usage:
@@ -459,7 +459,7 @@ def get_image(
         Get an image.
         Retrieve information about a given container image, specified by its `image_id` and region. Full details about the image, such as `name`, `namespace_id`, `status`, `visibility`, and `size` are returned in the response.
         :param region: Region to target. If none is passed will use default region from the config.
-        :param image_id: The UUID of the image.
+        :param image_id: UUID of the image.
         :return: :class:`Image <Image>`
 
         Usage:
@@ -491,7 +491,7 @@ def wait_for_image(
         """
         Waits for :class:`Image <Image>` to be in a final state.
         :param region: Region to target. If none is passed will use default region from the config.
-        :param image_id: The UUID of the image.
+        :param image_id: UUID of the image.
         :param options: The options for the waiter
         :return: :class:`Image <Image>`
 
@@ -571,7 +571,7 @@ def delete_image(
         Delete an image.
         Delete a given image. You must specify, in the endpoint, the `region` and `image_id` parameters of the image you want to delete.
         :param region: Region to target. If none is passed will use default region from the config.
-        :param image_id: The UUID of the image.
+        :param image_id: UUID of the image.
         :return: :class:`Image <Image>`
 
         Usage:
@@ -607,7 +607,7 @@ def list_tags(
         List tags.
         List all tags for a given image, specified by region. By default, the tags listed are ordered by creation date in ascending order. This can be modified via the order_by field. You can also define additional parameters for your query, such as the `name`.
         :param region: Region to target. If none is passed will use default region from the config.
-        :param image_id: The UUID of the image.
+        :param image_id: UUID of the image.
         :param page: A positive integer to choose the page to display.
         :param page_size: A positive integer lower or equal to 100 to select the number of items to display.
         :param order_by: Criteria to use when ordering tag listings. Possible values are `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `region`, `status_asc` and `status_desc`. The default value is `created_at_asc`.
@@ -653,7 +653,7 @@ def list_tags_all(
         List tags.
         List all tags for a given image, specified by region. By default, the tags listed are ordered by creation date in ascending order. This can be modified via the order_by field. You can also define additional parameters for your query, such as the `name`.
         :param region: Region to target. If none is passed will use default region from the config.
-        :param image_id: The UUID of the image.
+        :param image_id: UUID of the image.
         :param page: A positive integer to choose the page to display.
         :param page_size: A positive integer lower or equal to 100 to select the number of items to display.
         :param order_by: Criteria to use when ordering tag listings. Possible values are `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `region`, `status_asc` and `status_desc`. The default value is `created_at_asc`.
@@ -690,7 +690,7 @@ def get_tag(
         Get a tag.
         Retrieve information about a given image tag, specified by its `tag_id` and region. Full details about the tag, such as `name`, `image_id`, `status`, and `digest` are returned in the response.
         :param region: Region to target. If none is passed will use default region from the config.
-        :param tag_id: The UUID of the tag.
+        :param tag_id: UUID of the tag.
         :return: :class:`Tag <Tag>`
 
         Usage:
@@ -722,7 +722,7 @@ def wait_for_tag(
         """
         Waits for :class:`Tag <Tag>` to be in a final state.
         :param region: Region to target. If none is passed will use default region from the config.
-        :param tag_id: The UUID of the tag.
+        :param tag_id: UUID of the tag.
         :param options: The options for the waiter
         :return: :class:`Tag <Tag>`
 
@@ -758,7 +758,7 @@ def delete_tag(
         Delete a tag.
         Delete a given image tag. You must specify, in the endpoint, the `region` and `tag_id` parameters of the tag you want to delete.
         :param region: Region to target. If none is passed will use default region from the config.
-        :param tag_id: The UUID of the tag.
+        :param tag_id: UUID of the tag.
         :param force: If two tags share the same digest the deletion will fail unless this parameter is set to true.
         :return: :class:`Tag <Tag>`