Skip to content

Consolidate InOrbit URL env vars#96

Merged
b-Tomas merged 5 commits into
nextfrom
consolidate-env-vars
May 26, 2026
Merged

Consolidate InOrbit URL env vars#96
b-Tomas merged 5 commits into
nextfrom
consolidate-env-vars

Conversation

@b-Tomas

@b-Tomas b-Tomas commented May 26, 2026

Copy link
Copy Markdown
Member

Summary

edge-sdk-python reads two distinct InOrbit endpoints, a robot configuration endpoint and a REST API, but the env vars naming them collide and duplicate. INORBIT_API_URL means the configuration endpoint in inorbit_edge/models.py but the REST API in the demo example; the REST API also goes by INORBIT_REST_API_URL in the model. The same ambiguity repeats in connector-python and edge-executor, so a shared .env cannot serve the full Connect SDK stack.

This PR picks one name per endpoint. Updates to connector-python and edge-executor) follow.

Before

Env Var File SDK param Endpoint
INORBIT_API_URL inorbit_edge/models.py endpoint Configuration
INORBIT_REST_API_URL inorbit_edge/models.py rest_api_endpoint REST API
INORBIT_URL tests/demo/example.py endpoint Configuration
INORBIT_API_URL tests/demo/example.py rest_api_endpoint REST API

After

Env Var SDK param Endpoint Default
INORBIT_CONNECTION_CONFIG_URL endpoint Configuration https://control.inorbit.ai/cloud_sdk_robot_config
INORBIT_API_URL rest_api_endpoint REST API https://api.inorbit.ai

INORBIT_API_URL is reused but its meaning in models.py flips from configuration to REST API.

Changes

  • inorbit_edge/models.py: endpoint reads INORBIT_CONNECTION_CONFIG_URL; rest_api_endpoint reads INORBIT_API_URL. Old names not recognized (no fallback).
  • inorbit_edge/robot.py: module-level default constant renamed from INORBIT_REST_API_URL to INORBIT_DEFAULT_API_URL so it no longer collides with the env var. Exported INORBIT_CLOUD_SDK_ROBOT_CONFIG_URL preserved (connector-python imports it).
  • inorbit_edge/tests/demo/example.py and README.md: updated.
  • inorbit_edge/tests/test_robot_session.py: import updated.

Migration

  • Rename INORBIT_URL to INORBIT_CONNECTION_CONFIG_URL.
  • If you set INORBIT_API_URL for the configuration endpoint (matching previous models.py behavior), rename it to INORBIT_CONNECTION_CONFIG_URL. INORBIT_API_URL is now exclusively the REST API.
  • Python importers of inorbit_edge.robot.INORBIT_REST_API_URL must switch to INORBIT_DEFAULT_API_URL.

Follow-ups

  • connector-python: mirror the env var rename; add INORBIT_API_URL to rest_api_endpoint passthrough (currently no env-var way to set the REST endpoint).
  • edge-executor: replace INORBIT_URL and INORBIT_API_BASE_URL with the new names.
  • Major version bumps across all three repositories.

INORBIT_API_URL meant the configuration endpoint in models but the REST
API in the demo example and downstream executor. Shared env vars across
the Connect SDK stack were unusable. Establish new names:

- INORBIT_CONFIG_URL: configuration endpoint (was INORBIT_API_URL in
  models, INORBIT_URL in demo)
- INORBIT_API_URL: REST API endpoint (was INORBIT_REST_API_URL in models)

Old names removed with no fallback (breaking). Module constant
INORBIT_REST_API_URL renamed to INORBIT_DEFAULT_REST_API_URL to
disambiguate from the env var. Exported INORBIT_CLOUD_SDK_ROBOT_CONFIG_URL
preserved (imported by connector-python).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@b-Tomas b-Tomas self-assigned this May 26, 2026
@b-Tomas b-Tomas requested a review from miguelgarcia May 26, 2026 01:36
@b-Tomas b-Tomas marked this pull request as ready for review May 26, 2026 01:36
@miguelgarcia

Copy link
Copy Markdown
Member

I think the name INORBIT_CONFIG_URL is confusing, I'd think it's the config API. Should we rename it to INORBIT_CONNECTION_CONFIG_URL ?

@b-Tomas

b-Tomas commented May 26, 2026

Copy link
Copy Markdown
Member Author

@miguelgarcia INORBIT_CONNECTION_CONFIG_URL sounds good

@b-Tomas

b-Tomas commented May 26, 2026

Copy link
Copy Markdown
Member Author

@miguelgarcia ready for another look

@b-Tomas b-Tomas merged commit 97f6d2c into next May 26, 2026
24 checks passed
b-Tomas added a commit that referenced this pull request May 27, 2026
* Consolidate InOrbit URL env vars

INORBIT_API_URL meant the configuration endpoint in models but the REST
API in the demo example and downstream executor. Shared env vars across
the Connect SDK stack were unusable. Establish new names:

- INORBIT_CONFIG_URL: configuration endpoint (was INORBIT_API_URL in
  models, INORBIT_URL in demo)
- INORBIT_API_URL: REST API endpoint (was INORBIT_REST_API_URL in models)

Old names removed with no fallback (breaking). Module constant
INORBIT_REST_API_URL renamed to INORBIT_DEFAULT_REST_API_URL to
disambiguate from the env var. Exported INORBIT_CLOUD_SDK_ROBOT_CONFIG_URL
preserved (imported by connector-python).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* Rename INORBIT_CONFIG_URL -> INORBIT_CONNECTION_CONFIG_URL

* Fix linter

---------

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
b-Tomas added a commit to inorbit-ai/inorbit_edge_executor that referenced this pull request May 27, 2026
Rename INORBIT_API_BASE_URL to INORBIT_API_URL in the example,
aligning with the canonical env var names established in
inorbit-ai/edge-sdk-python#96.

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
b-Tomas added a commit to inorbit-ai/inorbit-connector-python that referenced this pull request May 28, 2026
…ables (#77)

* Consolidate InOrbit environment variables

Align connector-python with edge-sdk v3 env var consolidation
(inorbit-ai/edge-sdk-python#96). The config endpoint and REST API
now have unambiguous, non-colliding env var names across the stack.

- Rename `api_url` field to `connection_config_url`
  (reads `INORBIT_CONNECTION_CONFIG_URL`)
- Add new `api_url` field for the REST API
  (reads `INORBIT_API_URL`, defaults to `https://api.inorbit.ai`)
- Remove manual `os.environ.get("INORBIT_REST_API_URL", …)` from
  connector.py — REST API URL now flows through config like every
  other setting
- Bump `inorbit-edge` dependency to `>=3.0,<4.0`
- Update env files, docs, and tests

BREAKING CHANGE: `INORBIT_API_URL` no longer sets the config
endpoint — it now sets the REST API URL. Use
`INORBIT_CONNECTION_CONFIG_URL` for the config endpoint. The Python
field `api_url` on `ConnectorRootConfig` is renamed to
`connection_config_url`.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* Remove account_id references

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
b-Tomas added a commit to inorbit-ai/inorbit-connector-python that referenced this pull request May 28, 2026
…ables (#77)

* Consolidate InOrbit environment variables

Align connector-python with edge-sdk v3 env var consolidation
(inorbit-ai/edge-sdk-python#96). The config endpoint and REST API
now have unambiguous, non-colliding env var names across the stack.

- Rename `api_url` field to `connection_config_url`
  (reads `INORBIT_CONNECTION_CONFIG_URL`)
- Add new `api_url` field for the REST API
  (reads `INORBIT_API_URL`, defaults to `https://api.inorbit.ai`)
- Remove manual `os.environ.get("INORBIT_REST_API_URL", …)` from
  connector.py — REST API URL now flows through config like every
  other setting
- Bump `inorbit-edge` dependency to `>=3.0,<4.0`
- Update env files, docs, and tests

BREAKING CHANGE: `INORBIT_API_URL` no longer sets the config
endpoint — it now sets the REST API URL. Use
`INORBIT_CONNECTION_CONFIG_URL` for the config endpoint. The Python
field `api_url` on `ConnectorRootConfig` is renamed to
`connection_config_url`.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* Remove account_id references

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants