Skip to content

feat: Separate network.url into api-url and gateway-url#362

Merged
raymondk merged 6 commits intomainfrom
spofford/two-urls
Feb 14, 2026
Merged

feat: Separate network.url into api-url and gateway-url#362
raymondk merged 6 commits intomainfrom
spofford/two-urls

Conversation

@adamspofford-dfinity
Copy link
Contributor

No description provided.

@adamspofford-dfinity adamspofford-dfinity marked this pull request as ready for review February 13, 2026 18:14
@adamspofford-dfinity adamspofford-dfinity requested a review from a team as a code owner February 13, 2026 18:14
Comment on lines 103 to 107
/// The URL of the gateway endpoint. Should support prefixing canister IDs as subdomains.
gateway_url: Option<String>,
/// The URL of the API endpoint. Should support the standard API routes (e.g. /api/v3).
/// If no gateway endpoint is provided, canister URLs will not be printed in deploy operations.
api_url: String,
Copy link
Contributor

@raymondk raymondk Feb 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// The URL of the gateway endpoint. Should support prefixing canister IDs as subdomains.
gateway_url: Option<String>,
/// The URL of the API endpoint. Should support the standard API routes (e.g. /api/v3).
/// If no gateway endpoint is provided, canister URLs will not be printed in deploy operations.
api_url: String,
/// The URL of the HTTP gateway. `icp-cli` assumes that it supports prefixing canister IDs as subdomains.
/// If no http gateway is provided, canister URLs will not be printed in deploy operations.
http_gateway_url: Option<String>,
/// The URL of api gateway to use. Should support the standard API routes (e.g. /api/v3).
api_gateway_url: String,

In our documentation we refer to those as "http gateway" and "api gateway", see: https://docs.internetcomputer.org/references/http-gateway-protocol-spec#api-gateway-resolution

Comment on lines 110 to 112
/// The URL this network can be reached at.
/// Assumed to be both gateway (canister-id.domain.com) and API (domain.com/api/v3).
url: String,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// The URL this network can be reached at.
/// Assumed to be both gateway (canister-id.domain.com) and API (domain.com/api/v3).
url: String,
/// The URL this network can be reached at.
/// Assumed to be the url of the http gateway (canister-id.domain.com) and the api gateway (domain.com/api/v3).
url: String,

@raymondk raymondk merged commit 6f43807 into main Feb 14, 2026
82 checks passed
@raymondk raymondk deleted the spofford/two-urls branch February 14, 2026 01:26
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