Make SAPI endpoint config option name(s) clearer - Githubissues

dwavesystems / dwave-cloud-client

A minimal implementation of the REST interface used to communicate with D-Wave Solver API (SAPI) servers.

https://docs.ocean.dwavesys.com/projects/cloud-client/en/stable/

Apache License 2.0

59 stars 40 forks source link

Make SAPI endpoint config option name(s) clearer #573

Open randomir opened 1 year ago

randomir commented 1 year ago

We currently support:

metadata_api_endpoint (file/kwarg) option and DWAVE_METADATA_API_ENDPOINT (env var)
endpoint (file/kwarg) option and DWAVE_API_ENDPOINT (env var) for specifying SolverAPI (SAPI) endpoint - legacy names back from the era when cloud-client worked only with SAPI.

And after #569:

leap_api_endpoint (file/kwarg) option and DWAVE_LEAP_API_ENDPOINT (env var).

For consistency, we should:

add solver_api_endpoint/DWAVE_SOLVER_API_ENDPOINT options, and
make endpoint/DWAVE_API_ENDPOINT aliases of these new SAPI endpoint options

Optionally:

deprecate endpoint/DWAVE_API_ENDPOINT aliases