dwavesystems / dwavesystems/dwave-cloud-client

Make SAPI endpoint config option name(s) clearer

Open
#573 0 comments 0 reactions 0 assignees View on GitHub
feature
Dominant language
Python
Stars
63
Forks
44
Avg merge
13h 45m
Merged PRs (30d)
1

Description

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

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.