Skip to content

Commit

Permalink
Make uploading program description optional (#41)
Browse files Browse the repository at this point in the history
* optional program description

* add reno

Co-authored-by: Rathish Cholarajan <rathishc24@gmail.com>
  • Loading branch information
kt474 and rathishcholarajan authored Dec 2, 2021
1 parent ab8ab92 commit b080a71
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
5 changes: 2 additions & 3 deletions qiskit_ibm_runtime/ibm_runtime_service.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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.")

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
upgrade:
- |
When uploading a program with :meth:`qiskit_ibm_runtime.IBMRuntimeService.upload_program`,
the program description is now optional.

0 comments on commit b080a71

Please sign in to comment.