Update Private Module Metadata

Update Private Module Metadata (UpdatePrivateModuleMetadata)

This API updates the metadata of the current private module.

Currently, only the description of private modules can be updated.
If you need to create a new version, please call CreatePrivateModuleVersion API.
TThe update is an incremental update, meaning if a parameter is not provided, the original value will be retained.
If the request does not contain any parameters that need to be updated, error code 400 will be returned. Note: Even if the original value and the target value are the same, it is considered a valid update.
After the update, the update time of the private module will also be updated.
If both module_name and module_id are provided, RFS checks whether they match. If they do not match, error code 400 is returned.

PATCH /v1/private-modules/{module_name}/metadata

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
module_name	Yes	String	Name of a private module. The name is unique within its domain (domain_id) and region. Only letters, digits, underscores (_), and hyphens (-) are allowed. The name is case-sensitive and must start with a letter.

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Client-Request-Id	Yes	String	A unique request ID is specified by a user to locate a request. UUID is recommended.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
module_description	No	String	Description of a private module. It serves as an identifier for you to recognize managed private modules. To update the description of a private module, call the UpdatePrivateModuleMetadata API.
module_id	No	String	Unique ID of a private module. It is a UUID generated by RFS when a module is created. Private module names are unique only at a specific time, so you can create a private module named HelloWorld and another private module with the same name after deleting the first one. For parallel development, team members may want to ensure that they are operating the private module they created, not the one with the same name created by other members after deleting the previous one. To avoid this mismatch, check the ID, since RFS ensures each private module has a unique ID that does not change with updates. If the module_id differs from the current module ID, error code 400 is returned.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.
encoded_authorization_message	String	The message contains information about unauthorized requests.
details	Array of Detail objects	Detailed error information. It is returned by the service when the "permission denied" error occurs.

**Table 5** Detail
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.
encoded_authorization_message	String	The message contains information about unauthorized requests.
details	Array of Detail objects	Detailed error information. It is returned by the service when the "permission denied" error occurs.

**Table 7** Detail
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.
encoded_authorization_message	String	The message contains information about unauthorized requests.
details	Array of Detail objects	Detailed error information. It is returned by the service when the "permission denied" error occurs.

**Table 9** Detail
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.

Status code: 404

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.
encoded_authorization_message	String	The message contains information about unauthorized requests.
details	Array of Detail objects	Detailed error information. It is returned by the service when the "permission denied" error occurs.

**Table 11** Detail
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.

Status code: 429

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.
encoded_authorization_message	String	The message contains information about unauthorized requests.
details	Array of Detail objects	Detailed error information. It is returned by the service when the "permission denied" error occurs.

**Table 13** Detail
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.

Status code: 500

**Table 14** Response body parameters
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.
encoded_authorization_message	String	The message contains information about unauthorized requests.
details	Array of Detail objects	Detailed error information. It is returned by the service when the "permission denied" error occurs.

**Table 15** Detail
Parameter	Type	Description
error_code	String	Response code.
error_msg	String	Response message.

None

None

Status Code	Description
204	Private module metadata is updated and no data is returned.
400	Invalid request.
401	Authentication failed.
403	The user does not have the permission to call this API.
404	The module does not exist.
429	Too frequent requests.
500	Internal server error.