docs(cockpit): update documentation (#77)

Author: scaleway-bot

scaleway-async/scaleway_async/cockpit/v1beta1/api.py

@@ -382,8 +382,8 @@ async def create_contact_point(
     ) -> ContactPoint:
         """
         Create an alert contact point for the default receiver.
-        :param project_id: Project ID
-        :param contact_point: Contact point to create
+        :param project_id: Project ID.
+        :param contact_point: Contact point to create.
         :return: :class:`ContactPoint <ContactPoint>`
 
         Usage:
@@ -416,9 +416,9 @@ async def list_contact_points(
     ) -> ListContactPointsResponse:
         """
         List alert contact points associated with the given cockpit ID.
-        :param page: Page number
-        :param page_size: Page size
-        :param project_id: Project ID
+        :param page: Page number.
+        :param page_size: Page size.
+        :param project_id: Project ID.
         :return: :class:`ListContactPointsResponse <ListContactPointsResponse>`
 
         Usage:
@@ -449,9 +449,9 @@ async def list_contact_points_all(
     ) -> List[ContactPoint]:
         """
         List alert contact points associated with the given cockpit ID.
-        :param page: Page number
-        :param page_size: Page size
-        :param project_id: Project ID
+        :param page: Page number.
+        :param page_size: Page size.
+        :param project_id: Project ID.
         :return: :class:`List[ListContactPointsResponse] <List[ListContactPointsResponse]>`
 
         Usage:
@@ -480,7 +480,7 @@ async def delete_contact_point(
         """
         Delete an alert contact point for the default receiver.
         :param project_id:
-        :param contact_point: Contact point to delete
+        :param contact_point: Contact point to delete.
 
         Usage:
         ::

scaleway-async/scaleway_async/cockpit/v1beta1/types.py

@@ -50,44 +50,44 @@ def __str__(self) -> str:
 @dataclass
 class Cockpit:
     """
-    Cockpit
+    Cockpit.
     """
 
     project_id: str
     """
-    Project ID
+    Project ID.
     """
 
     created_at: Optional[datetime]
     """
-    Created at
+    Created at.
     """
 
     updated_at: Optional[datetime]
     """
-    Updated at
+    Updated at.
     """
 
     endpoints: Optional[CockpitEndpoints]
     """
-    Endpoints
+    Endpoints.
     """
 
     status: CockpitStatus
     """
-    Status
+    Status.
     """
 
     managed_alerts_enabled: bool
     """
-    Managed alerts enabled
+    Managed alerts enabled.
     """
 
 
 @dataclass
 class CockpitEndpoints:
     """
-    Cockpit. endpoints
+    Cockpit. endpoints.
     """
 
     metrics_url: str
@@ -102,7 +102,7 @@ class CockpitEndpoints:
 @dataclass
 class ContactPoint:
     """
-    Alert contact point
+    Alert contact point.
     """
 
     email: Optional[ContactPointEmail]
@@ -121,7 +121,7 @@ class ContactPointEmail:
 @dataclass
 class GrafanaUser:
     """
-    Grafana user
+    Grafana user.
     """
 
     id: int
@@ -136,34 +136,34 @@ class GrafanaUser:
 @dataclass
 class ListContactPointsResponse:
     """
-    List contact points response
+    List contact points response.
     """
 
     total_count: int
     """
-    Total count of contact points
+    Total count of contact points.
     """
 
     contact_points: List[ContactPoint]
     """
-    Contact points array
+    Contact points array.
     """
 
     has_additional_receivers: bool
     """
-    Has receivers other than default
+    Has receivers other than default.
     """
 
     has_additional_contact_points: bool
     """
-    Has unmanaged contact points
+    Has unmanaged contact points.
     """
 
 
 @dataclass
 class ListGrafanaUsersResponse:
     """
-    List grafana users response
+    List grafana users response.
     """
 
     total_count: int
@@ -174,7 +174,7 @@ class ListGrafanaUsersResponse:
 @dataclass
 class ListTokensResponse:
     """
-    List tokens response
+    List tokens response.
     """
 
     total_count: int
@@ -185,7 +185,7 @@ class ListTokensResponse:
 @dataclass
 class Token:
     """
-    Token
+    Token.
     """
 
     id: str
@@ -206,7 +206,7 @@ class Token:
 @dataclass
 class TokenScopes:
     """
-    Token scopes
+    Token scopes.
     """
 
     query_metrics: bool
@@ -278,30 +278,30 @@ class DeleteTokenRequest:
 class CreateContactPointRequest:
     project_id: Optional[str]
     """
-    Project ID
+    Project ID.
     """
 
     contact_point: Optional[ContactPoint]
     """
-    Contact point to create
+    Contact point to create.
     """
 
 
 @dataclass
 class ListContactPointsRequest:
     page: Optional[int]
     """
-    Page number
+    Page number.
     """
 
     page_size: Optional[int]
     """
-    Page size
+    Page size.
     """
 
     project_id: Optional[str]
     """
-    Project ID
+    Project ID.
     """
 
 
@@ -311,7 +311,7 @@ class DeleteContactPointRequest:
 
     contact_point: Optional[ContactPoint]
     """
-    Contact point to delete
+    Contact point to delete.
     """
 
 

scaleway/scaleway/cockpit/v1beta1/api.py

@@ -382,8 +382,8 @@ def create_contact_point(
     ) -> ContactPoint:
         """
         Create an alert contact point for the default receiver.
-        :param project_id: Project ID
-        :param contact_point: Contact point to create
+        :param project_id: Project ID.
+        :param contact_point: Contact point to create.
         :return: :class:`ContactPoint <ContactPoint>`
 
         Usage:
@@ -416,9 +416,9 @@ def list_contact_points(
     ) -> ListContactPointsResponse:
         """
         List alert contact points associated with the given cockpit ID.
-        :param page: Page number
-        :param page_size: Page size
-        :param project_id: Project ID
+        :param page: Page number.
+        :param page_size: Page size.
+        :param project_id: Project ID.
         :return: :class:`ListContactPointsResponse <ListContactPointsResponse>`
 
         Usage:
@@ -449,9 +449,9 @@ def list_contact_points_all(
     ) -> List[ContactPoint]:
         """
         List alert contact points associated with the given cockpit ID.
-        :param page: Page number
-        :param page_size: Page size
-        :param project_id: Project ID
+        :param page: Page number.
+        :param page_size: Page size.
+        :param project_id: Project ID.
         :return: :class:`List[ListContactPointsResponse] <List[ListContactPointsResponse]>`
 
         Usage:
@@ -480,7 +480,7 @@ def delete_contact_point(
         """
         Delete an alert contact point for the default receiver.
         :param project_id:
-        :param contact_point: Contact point to delete
+        :param contact_point: Contact point to delete.
 
         Usage:
         ::