@@ -53,6 +53,7 @@ def create(
5353 label : str ,
5454 name : str ,
5555 schema : custom_metadata_field_create_params .Schema ,
56+ description : str | Omit = omit ,
5657 # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
5758 # The extra values given here take precedence over values defined on the client or passed to this method.
5859 extra_headers : Headers | None = None ,
@@ -76,6 +77,10 @@ def create(
7677 name: API name of the custom metadata field. This should be unique across all
7778 (including deleted) custom metadata fields.
7879
80+ description: Optional description for the custom metadata field. Can be up to 500 characters.
81+ This is shown as a hint to the users while setting the field's value on an asset
82+ in the media library UI.
83+
7984 extra_headers: Send extra headers
8085
8186 extra_query: Add additional query parameters to the request
@@ -91,6 +96,7 @@ def create(
9196 "label" : label ,
9297 "name" : name ,
9398 "schema" : schema ,
99+ "description" : description ,
94100 },
95101 custom_metadata_field_create_params .CustomMetadataFieldCreateParams ,
96102 ),
@@ -104,6 +110,7 @@ def update(
104110 self ,
105111 id : str ,
106112 * ,
113+ description : str | Omit = omit ,
107114 label : str | Omit = omit ,
108115 schema : custom_metadata_field_update_params .Schema | Omit = omit ,
109116 # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -114,9 +121,15 @@ def update(
114121 timeout : float | httpx .Timeout | None | NotGiven = not_given ,
115122 ) -> CustomMetadataField :
116123 """
117- This API updates the label or schema of an existing custom metadata field.
124+ This API updates the label, description, or schema of an existing custom
125+ metadata field.
118126
119127 Args:
128+ description: Optional description for the custom metadata field. Can be up to 500 characters.
129+ Send an empty string to clear an existing description. This is shown as a hint
130+ to the users while setting the field's value on an asset in the media library
131+ UI.
132+
120133 label: Human readable name of the custom metadata field. This should be unique across
121134 all non deleted custom metadata fields. This name is displayed as form field
122135 label to the users while setting field value on an asset in the media library
@@ -141,6 +154,7 @@ def update(
141154 path_template ("/v1/customMetadataFields/{id}" , id = id ),
142155 body = maybe_transform (
143156 {
157+ "description" : description ,
144158 "label" : label ,
145159 "schema" : schema ,
146160 },
@@ -271,6 +285,7 @@ async def create(
271285 label : str ,
272286 name : str ,
273287 schema : custom_metadata_field_create_params .Schema ,
288+ description : str | Omit = omit ,
274289 # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
275290 # The extra values given here take precedence over values defined on the client or passed to this method.
276291 extra_headers : Headers | None = None ,
@@ -294,6 +309,10 @@ async def create(
294309 name: API name of the custom metadata field. This should be unique across all
295310 (including deleted) custom metadata fields.
296311
312+ description: Optional description for the custom metadata field. Can be up to 500 characters.
313+ This is shown as a hint to the users while setting the field's value on an asset
314+ in the media library UI.
315+
297316 extra_headers: Send extra headers
298317
299318 extra_query: Add additional query parameters to the request
@@ -309,6 +328,7 @@ async def create(
309328 "label" : label ,
310329 "name" : name ,
311330 "schema" : schema ,
331+ "description" : description ,
312332 },
313333 custom_metadata_field_create_params .CustomMetadataFieldCreateParams ,
314334 ),
@@ -322,6 +342,7 @@ async def update(
322342 self ,
323343 id : str ,
324344 * ,
345+ description : str | Omit = omit ,
325346 label : str | Omit = omit ,
326347 schema : custom_metadata_field_update_params .Schema | Omit = omit ,
327348 # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -332,9 +353,15 @@ async def update(
332353 timeout : float | httpx .Timeout | None | NotGiven = not_given ,
333354 ) -> CustomMetadataField :
334355 """
335- This API updates the label or schema of an existing custom metadata field.
356+ This API updates the label, description, or schema of an existing custom
357+ metadata field.
336358
337359 Args:
360+ description: Optional description for the custom metadata field. Can be up to 500 characters.
361+ Send an empty string to clear an existing description. This is shown as a hint
362+ to the users while setting the field's value on an asset in the media library
363+ UI.
364+
338365 label: Human readable name of the custom metadata field. This should be unique across
339366 all non deleted custom metadata fields. This name is displayed as form field
340367 label to the users while setting field value on an asset in the media library
@@ -359,6 +386,7 @@ async def update(
359386 path_template ("/v1/customMetadataFields/{id}" , id = id ),
360387 body = await async_maybe_transform (
361388 {
389+ "description" : description ,
362390 "label" : label ,
363391 "schema" : schema ,
364392 },
0 commit comments