Skip to content

Backend status returns a text instead of an error code #4463

@gnietof

Description

@gnietof

URL to the relevant guide or resource

This is an error in the REST API but I have not been able to find the REST API implementation code.

Select all that apply

  • new content request
  • typo
  • code bug
  • out-of-date content
  • broken link
  • other

Describe the fix or the content request.

All (at least most) REST API endpoints return a numeric error code. For example, 1291 in the example below:

{"errors":[{"code": 1291,"message":"Job not found. Job ID: xxd5439c3ht8fs739vgu0g","solution":"Verify the job ID is correct and that you have the correct access permissions.","more_info":"https://cloud.ibm.com/apidocs/quantum-computing#error-handling"}],"trace":"935b0fbe-54d6-4103-85d0-34d73b9ec432"}

When calling the backend status endpoint it returns a text:

{"errors":[{"code":"not_found","message":"device not found","more_info":"https://cloud.ibm.com/apidocs/quantum-computing#error-handling"}],"trace":"3165fc0a-5b19-4178-bb37-0fa626469ced"}

I think that is a bug or at least it should be replaced by a numeric number. Otherwise writing a client is complex when writing the JSON deserialiser.

For new content requests - if the request is accepted, do you want to write the content?

I can help the team by providing enough information or by referring them to a specific Subject Matter Expert to write the material

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions