docs(serverless): clarify UpdateContainer and UpdateFunction behavior and clarify delete secrets behavior (#1197)

Co-authored-by: Laure-di <[email protected]>

Author: scaleway-bot

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

@@ -746,7 +746,18 @@ async def update_container(
         :param max_concurrency: Number of maximum concurrent executions of the container.
         :param protocol: Protocol the container uses.
         :param port: Port the container listens on.
-        :param secret_environment_variables: Secret environment variables of the container.
+        :param secret_environment_variables: During an update, secret environment variables that are not specified in this field will be kept unchanged.
+
+        In order to delete a specific secret environment variable, you must reference its key, but not provide any value for it.
+        For example, the following payload will delete the `TO_DELETE` secret environment variable:
+
+        ```json
+        {
+          "secret_environment_variables":[
+            {"key":"TO_DELETE"}
+          ]
+        }
+        ```.
         :param http_option: Possible values:
          - redirected: Responds to HTTP request with a 301 redirect to ask the clients to use HTTPS.
          - enabled: Serve both HTTP and HTTPS traffic.

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

@@ -1556,7 +1556,18 @@ class UpdateContainerRequest:
 
     secret_environment_variables: Optional[List[Secret]] = field(default_factory=list)
     """
-    Secret environment variables of the container.
+    During an update, secret environment variables that are not specified in this field will be kept unchanged.
+
+In order to delete a specific secret environment variable, you must reference its key, but not provide any value for it.
+For example, the following payload will delete the `TO_DELETE` secret environment variable:
+
+```json
+{
+  "secret_environment_variables":[
+    {"key":"TO_DELETE"}
+  ]
+}
+```.
     """
 
     http_option: Optional[ContainerHttpOption] = ContainerHttpOption.UNKNOWN_HTTP_OPTION

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

@@ -709,7 +709,18 @@ async def update_function(
         :param handler: Handler to use with the function.
         :param privacy: Privacy setting of the function.
         :param description: Description of the function.
-        :param secret_environment_variables: Secret environment variables of the function.
+        :param secret_environment_variables: During an update, secret environment variables that are not specified in this field will be kept unchanged.
+
+        In order to delete a specific secret environment variable, you must reference its key, but not provide any value for it.
+        For example, the following payload will delete the `TO_DELETE` secret environment variable:
+
+        ```json
+        {
+         "secret_environment_variables":[
+           {"key":"TO_DELETE"}
+         ]
+        }
+        ```.
         :param http_option: Possible values:
          - redirected: Responds to HTTP request with a 301 redirect to ask the clients to use HTTPS.
          - enabled: Serve both HTTP and HTTPS traffic.

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

@@ -1563,7 +1563,18 @@ class UpdateFunctionRequest:
 
     secret_environment_variables: Optional[List[Secret]] = field(default_factory=list)
     """
-    Secret environment variables of the function.
+    During an update, secret environment variables that are not specified in this field will be kept unchanged.
+
+In order to delete a specific secret environment variable, you must reference its key, but not provide any value for it.
+For example, the following payload will delete the `TO_DELETE` secret environment variable:
+
+```json
+{
+ "secret_environment_variables":[
+   {"key":"TO_DELETE"}
+ ]
+}
+```.
     """
 
     http_option: Optional[FunctionHttpOption] = FunctionHttpOption.UNKNOWN_HTTP_OPTION

scaleway/scaleway/container/v1beta1/api.py

@@ -742,7 +742,18 @@ def update_container(
         :param max_concurrency: Number of maximum concurrent executions of the container.
         :param protocol: Protocol the container uses.
         :param port: Port the container listens on.
-        :param secret_environment_variables: Secret environment variables of the container.
+        :param secret_environment_variables: During an update, secret environment variables that are not specified in this field will be kept unchanged.
+
+        In order to delete a specific secret environment variable, you must reference its key, but not provide any value for it.
+        For example, the following payload will delete the `TO_DELETE` secret environment variable:
+
+        ```json
+        {
+          "secret_environment_variables":[
+            {"key":"TO_DELETE"}
+          ]
+        }
+        ```.
         :param http_option: Possible values:
          - redirected: Responds to HTTP request with a 301 redirect to ask the clients to use HTTPS.
          - enabled: Serve both HTTP and HTTPS traffic.

scaleway/scaleway/container/v1beta1/types.py

@@ -1556,7 +1556,18 @@ class UpdateContainerRequest:
 
     secret_environment_variables: Optional[List[Secret]] = field(default_factory=list)
     """
-    Secret environment variables of the container.
+    During an update, secret environment variables that are not specified in this field will be kept unchanged.
+
+In order to delete a specific secret environment variable, you must reference its key, but not provide any value for it.
+For example, the following payload will delete the `TO_DELETE` secret environment variable:
+
+```json
+{
+  "secret_environment_variables":[
+    {"key":"TO_DELETE"}
+  ]
+}
+```.
     """
 
     http_option: Optional[ContainerHttpOption] = ContainerHttpOption.UNKNOWN_HTTP_OPTION

scaleway/scaleway/function/v1beta1/api.py

@@ -705,7 +705,18 @@ def update_function(
         :param handler: Handler to use with the function.
         :param privacy: Privacy setting of the function.
         :param description: Description of the function.
-        :param secret_environment_variables: Secret environment variables of the function.
+        :param secret_environment_variables: During an update, secret environment variables that are not specified in this field will be kept unchanged.
+
+        In order to delete a specific secret environment variable, you must reference its key, but not provide any value for it.
+        For example, the following payload will delete the `TO_DELETE` secret environment variable:
+
+        ```json
+        {
+         "secret_environment_variables":[
+           {"key":"TO_DELETE"}
+         ]
+        }
+        ```.
         :param http_option: Possible values:
          - redirected: Responds to HTTP request with a 301 redirect to ask the clients to use HTTPS.
          - enabled: Serve both HTTP and HTTPS traffic.

scaleway/scaleway/function/v1beta1/types.py

@@ -1563,7 +1563,18 @@ class UpdateFunctionRequest:
 
     secret_environment_variables: Optional[List[Secret]] = field(default_factory=list)
     """
-    Secret environment variables of the function.
+    During an update, secret environment variables that are not specified in this field will be kept unchanged.
+
+In order to delete a specific secret environment variable, you must reference its key, but not provide any value for it.
+For example, the following payload will delete the `TO_DELETE` secret environment variable:
+
+```json
+{
+ "secret_environment_variables":[
+   {"key":"TO_DELETE"}
+ ]
+}
+```.
     """
 
     http_option: Optional[FunctionHttpOption] = FunctionHttpOption.UNKNOWN_HTTP_OPTION