Skip to content

OpenAPI spec has changed upstream #43

@github-actions

Description

@github-actions

The spec at https://api.ionq.co/v0.4/api-docs has diverged from the vendored openapi.json. Fetch the new spec and regenerate the client.

Diff (sorted, pretty-printed JSON)
--- vendored
+++ upstream
@@ -1555,6 +1555,10 @@
                     {
                         "$ref": "#/components/schemas/QuantumFunctionJobCreationPayload",
                         "title": "Quantum Function"
+                    },
+                    {
+                        "$ref": "#/components/schemas/QctrlQaoaJobCreationPayload",
+                        "title": "QAOA Function"
                     }
                 ],
                 "example": {
@@ -2050,6 +2054,138 @@
                 ],
                 "type": "object"
             },
+            "QctrlQaoaJobCreationPayload": {
+                "description": "Submit a combinatorial optimization job to solve a maxcut problem using Q-CTRL's QAOA Solver. See our QAOA Job guide for more infromation.\n",
+                "properties": {
+                    "backend": {
+                        "$ref": "#/components/schemas/JobBackends"
+                    },
+                    "dry_run": {
+                        "type": "boolean"
+                    },
+                    "external_settings": {
+                        "properties": {
+                            "api_credentials": {
+                                "description": "API Key for your Q-CTRL Account",
+                                "type": "string"
+                            },
+                            "external_organization": {
+                                "description": "Optional unique slug for your target Q-CTRL organization",
+                                "type": "string"
+                            }
+                        },
+                        "required": [
+                            "api_credentials"
+                        ],
+                        "type": "object"
+                    },
+                    "input": {
+                        "$ref": "#/components/schemas/QctrlQaoaJobInput"
+                    },
+                    "metadata": {
+                        "$ref": "#/components/schemas/JobMetadata"
+                    },
+                    "name": {
+                        "type": "string"
+                    },
+                    "session_id": {
+                        "type": "string"
+                    },
+                    "settings": {
+                        "properties": {
+                            "error_mitigation": {
+                                "properties": {
+                                    "debiasing": {
+                                        "type": "boolean"
+                                    }
+                                },
+                                "type": "object"
+                            }
+                        },
+                        "type": "object"
+                    },
+                    "shots": {
+                        "default": 100,
+                        "format": "int32",
+                        "maximum": 1000000,
+                        "type": "integer"
+                    },
+                    "type": {
+                        "enum": [
+                            "qctrl.qaoa.v1"
+                        ],
+                        "type": "string"
+                    }
+                },
+                "required": [
+                    "backend",
+                    "type",
+                    "input",
+                    "external_settings"
+                ],
+                "type": "object"
+            },
+            "QctrlQaoaJobInput": {
+                "properties": {
+                    "problem": {
+                        "description": "A NetworkX adjacency_graph object",
+                        "example": {
+                            "adjacency": [
+                                [
+                                    {
+                                        "id": 1
+                                    },
+                                    {
+                                        "id": 2
+                                    }
+                                ],
+                                [
+                                    {
+                                        "id": 0
+                                    },
+                                    {
+                                        "id": 2
+                                    }
+                                ],
+                                [
+                                    {
+                                        "id": 0
+                                    },
+                                    {
+                                        "id": 1
+                                    }
+                                ]
+                            ],
+                            "directed": false,
+                            "graph": [],
+                            "multigraph": false,
+                            "nodes": [
+                                {
+                                    "id": 0
+                                },
+                                {
+                                    "id": 1
+                                },
+                                {
+                                    "id": 2
+                                }
+                            ]
+                        },
+                        "type": "object"
+                    },
+                    "problem_type": {
+                        "enum": [
+                            "maxcut"
+                        ],
+                        "type": "string"
+                    }
+                },
+                "required": [
+                    "problem_type",
+                    "problem"
+                ],
+                "type": "object"
+            },
             "QisCircuitInput": {
                 "additionalProperties": false,
                 "properties": {
@@ -2576,7 +2712,7 @@
             "name": "IonQ",
             "url": "https://ionq.com/"
         },
-        "description": "*Last updated: April 30, 2026*\nIonQ's API for accessing the IonQ Quantum Cloud platform\n\nPlease subscribe for automated updates when we perform maintenance or\nexperience an outage.\n\nIn addition, you may use the [status endpoint](#tag/status) to check the\ncurrent status of our API.\n\n## Authentication\n\n<SecurityDefinitions />\n",
+        "description": "*Last updated: May 14, 2026*\nIonQ's API for accessing the IonQ Quantum Cloud platform\n\nPlease subscribe for automated updates when we perform maintenance or\nexperience an outage.\n\nIn addition, you may use the [status endpoint](#tag/status) to check the\ncurrent status of our API.\n\n## Authentication\n\n<SecurityDefinitions />\n",
         "title": "IonQ Cloud Platform API",
         "version": "v0.4"
     },

Metadata

Metadata

Assignees

No one assigned

    Labels

    spec-driftUpstream OpenAPI spec has changed

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions