diff --git a/qiskit_ibm_runtime/ibm_runtime_service.py b/qiskit_ibm_runtime/ibm_runtime_service.py index e0645fefd4..4f4c03d46c 100644 --- a/qiskit_ibm_runtime/ibm_runtime_service.py +++ b/qiskit_ibm_runtime/ibm_runtime_service.py @@ -1045,7 +1045,6 @@ def upload_program( - name - max_execution_time - - description Program metadata can be specified using the `metadata` parameter or individual parameter (for example, `name` and `description`). If the @@ -1066,7 +1065,7 @@ def upload_program( * name: Name of the program. Required. * max_execution_time: Maximum execution time in seconds. Required. - * description: Program description. Required. + * description: Program description. * is_public: Whether the runtime program should be visible to the public. The default is ``False``. * spec: Specifications for backend characteristics and input parameters @@ -1088,7 +1087,7 @@ def upload_program( """ program_metadata = self._read_metadata(metadata=metadata) - for req in ["name", "description", "max_execution_time"]: + for req in ["name", "max_execution_time"]: if req not in program_metadata or not program_metadata[req]: raise IBMInputValueError(f"{req} is a required metadata field.") diff --git a/releasenotes/notes/optional-program-description-f6e3aceca8223af7.yaml b/releasenotes/notes/optional-program-description-f6e3aceca8223af7.yaml new file mode 100644 index 0000000000..9008101577 --- /dev/null +++ b/releasenotes/notes/optional-program-description-f6e3aceca8223af7.yaml @@ -0,0 +1,5 @@ +--- +upgrade: + - | + When uploading a program with :meth:`qiskit_ibm_runtime.IBMRuntimeService.upload_program`, + the program description is now optional. \ No newline at end of file