feat(iam): improve documentation for new quota methods (#64)

Co-authored-by: Nathanael Demacon <[email protected]>

Author: scaleway-bot

scaleway-async/scaleway_async/iam/v1alpha1/api.py

@@ -1738,11 +1738,17 @@ async def list_quota(
         self,
         *,
         order_by: ListQuotaRequestOrderBy = ListQuotaRequestOrderBy.NAME_ASC,
-        page: Optional[int] = None,
         page_size: Optional[int] = None,
+        page: Optional[int] = None,
         organization_id: Optional[str] = None,
     ) -> ListQuotaResponse:
         """
+        List all quota in the organization with the associated limit
+        :param order_by: Criteria for sorting results
+        :param page_size: Number of results per page. Value must be between 1 and 100
+        :param page: Number of page. Value must be greater to 1
+        :param organization_id: Filter by organization ID
+        :return: :class:`ListQuotaResponse <ListQuotaResponse>`
 
         Usage:
         ::
@@ -1769,11 +1775,16 @@ async def list_quota_all(
         self,
         *,
         order_by: Optional[ListQuotaRequestOrderBy] = None,
-        page: Optional[int] = None,
         page_size: Optional[int] = None,
+        page: Optional[int] = None,
         organization_id: Optional[str] = None,
     ) -> List[Quotum]:
         """
+        List all quota in the organization with the associated limit
+        :param order_by: Criteria for sorting results
+        :param page_size: Number of results per page. Value must be between 1 and 100
+        :param page: Number of page. Value must be greater to 1
+        :param organization_id: Filter by organization ID
         :return: :class:`List[ListQuotaResponse] <List[ListQuotaResponse]>`
 
         Usage:
@@ -1788,8 +1799,8 @@ async def list_quota_all(
             fetcher=self.list_quota,
             args={
                 "order_by": order_by,
-                "page": page,
                 "page_size": page_size,
+                "page": page,
                 "organization_id": organization_id,
             },
         )
@@ -1801,6 +1812,10 @@ async def get_quotum(
         organization_id: Optional[str] = None,
     ) -> Quotum:
         """
+        Get a quotum in the organization with the associated limit
+        :param quotum_name: Name of the quotum to get
+        :param organization_id: ID of the organization
+        :return: :class:`Quotum <Quotum>`
 
         Usage:
         ::

scaleway-async/scaleway_async/iam/v1alpha1/types.py

@@ -384,9 +384,19 @@ class ListPoliciesResponse:
 
 @dataclass
 class ListQuotaResponse:
+    """
+    List quota response
+    """
+
     quota: List[Quotum]
+    """
+    List of quota
+    """
 
     total_count: int
+    """
+    Total count of quota
+    """
 
 
 @dataclass
@@ -559,15 +569,26 @@ class Policy:
 
 @dataclass
 class Quotum:
+    """
+    Quotum
+    """
+
     name: str
+    """
+    Name of the quotum
+    """
 
     limit: Optional[int]
     """
+    Max limit of the quotum.
+    
     One-of ('value'): at most one of 'limit', 'unlimited' could be set.
     """
 
     unlimited: Optional[bool]
     """
+    Whether the quotum is unlimited or not.
+    
     One-of ('value'): at most one of 'limit', 'unlimited' could be set.
     """
 
@@ -1491,16 +1512,34 @@ class DeleteAPIKeyRequest:
 @dataclass
 class ListQuotaRequest:
     order_by: Optional[ListQuotaRequestOrderBy]
-
-    page: Optional[int]
+    """
+    Criteria for sorting results
+    """
 
     page_size: Optional[int]
+    """
+    Number of results per page. Value must be between 1 and 100
+    """
+
+    page: Optional[int]
+    """
+    Number of page. Value must be greater to 1
+    """
 
     organization_id: Optional[str]
+    """
+    Filter by organization ID
+    """
 
 
 @dataclass
 class GetQuotumRequest:
     quotum_name: str
+    """
+    Name of the quotum to get
+    """
 
     organization_id: Optional[str]
+    """
+    ID of the organization
+    """

scaleway/scaleway/iam/v1alpha1/api.py

@@ -1738,11 +1738,17 @@ def list_quota(
         self,
         *,
         order_by: ListQuotaRequestOrderBy = ListQuotaRequestOrderBy.NAME_ASC,
-        page: Optional[int] = None,
         page_size: Optional[int] = None,
+        page: Optional[int] = None,
         organization_id: Optional[str] = None,
     ) -> ListQuotaResponse:
         """
+        List all quota in the organization with the associated limit
+        :param order_by: Criteria for sorting results
+        :param page_size: Number of results per page. Value must be between 1 and 100
+        :param page: Number of page. Value must be greater to 1
+        :param organization_id: Filter by organization ID
+        :return: :class:`ListQuotaResponse <ListQuotaResponse>`
 
         Usage:
         ::
@@ -1769,11 +1775,16 @@ def list_quota_all(
         self,
         *,
         order_by: Optional[ListQuotaRequestOrderBy] = None,
-        page: Optional[int] = None,
         page_size: Optional[int] = None,
+        page: Optional[int] = None,
         organization_id: Optional[str] = None,
     ) -> List[Quotum]:
         """
+        List all quota in the organization with the associated limit
+        :param order_by: Criteria for sorting results
+        :param page_size: Number of results per page. Value must be between 1 and 100
+        :param page: Number of page. Value must be greater to 1
+        :param organization_id: Filter by organization ID
         :return: :class:`List[ListQuotaResponse] <List[ListQuotaResponse]>`
 
         Usage:
@@ -1788,8 +1799,8 @@ def list_quota_all(
             fetcher=self.list_quota,
             args={
                 "order_by": order_by,
-                "page": page,
                 "page_size": page_size,
+                "page": page,
                 "organization_id": organization_id,
             },
         )
@@ -1801,6 +1812,10 @@ def get_quotum(
         organization_id: Optional[str] = None,
     ) -> Quotum:
         """
+        Get a quotum in the organization with the associated limit
+        :param quotum_name: Name of the quotum to get
+        :param organization_id: ID of the organization
+        :return: :class:`Quotum <Quotum>`
 
         Usage:
         ::

scaleway/scaleway/iam/v1alpha1/types.py

@@ -384,9 +384,19 @@ class ListPoliciesResponse:
 
 @dataclass
 class ListQuotaResponse:
+    """
+    List quota response
+    """
+
     quota: List[Quotum]
+    """
+    List of quota
+    """
 
     total_count: int
+    """
+    Total count of quota
+    """
 
 
 @dataclass
@@ -559,15 +569,26 @@ class Policy:
 
 @dataclass
 class Quotum:
+    """
+    Quotum
+    """
+
     name: str
+    """
+    Name of the quotum
+    """
 
     limit: Optional[int]
     """
+    Max limit of the quotum.
+    
     One-of ('value'): at most one of 'limit', 'unlimited' could be set.
     """
 
     unlimited: Optional[bool]
     """
+    Whether the quotum is unlimited or not.
+    
     One-of ('value'): at most one of 'limit', 'unlimited' could be set.
     """
 
@@ -1491,16 +1512,34 @@ class DeleteAPIKeyRequest:
 @dataclass
 class ListQuotaRequest:
     order_by: Optional[ListQuotaRequestOrderBy]
-
-    page: Optional[int]
+    """
+    Criteria for sorting results
+    """
 
     page_size: Optional[int]
+    """
+    Number of results per page. Value must be between 1 and 100
+    """
+
+    page: Optional[int]
+    """
+    Number of page. Value must be greater to 1
+    """
 
     organization_id: Optional[str]
+    """
+    Filter by organization ID
+    """
 
 
 @dataclass
 class GetQuotumRequest:
     quotum_name: str
+    """
+    Name of the quotum to get
+    """
 
     organization_id: Optional[str]
+    """
+    ID of the organization
+    """