Skip to content

docs: correct default API version#81

Open
Copilot wants to merge 4 commits into
mainfrom
copilot/document-supported-environment-variables
Open

docs: correct default API version#81
Copilot wants to merge 4 commits into
mainfrom
copilot/document-supported-environment-variables

Conversation

Copy link
Copy Markdown

Copilot AI commented May 22, 2026

This pull request updates the default Azure API Management (APIM) REST API version used throughout the CLI and documentation from 2024-05-01 to 2025-09-01-preview. This ensures support for newer resource types, such as MCP-typed APIs, which may be omitted or rejected by older API versions.

Default API Version Update:

  • Changed the default value for the --api-version CLI flag and the AZURE_API_VERSION environment variable to 2025-09-01-preview in the documentation (docs/reference/configuration.md). [1] [2] [3]
  • Updated comments and logic in extract-command.ts and publish-command.ts to default to 2025-09-01-preview for apiVersion, ensuring newer resource types are supported by ARM endpoints. [1] [2]Documents all supported environment variables in docs/reference/configuration.md and corrects the documented default APIM API version from 2024-05-01 to 2025-09-01-preview.

Changes

  • docs/reference/configuration.md

    • Adds the full environment variable table covering AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_CLIENT_SECRET, AZURE_TENANT_ID, AZURE_API_VERSION, and COMMIT_ID with per-variable scope and description
    • Corrects --api-version default and AZURE_API_VERSION default in both the flags table and the defaults table to 2025-09-01-preview (the actual runtime default, required for MCP-typed API support)
  • src/cli/extract-command.ts / src/cli/publish-command.ts

    • Tightens inline comments to explicitly name 2025-09-01-preview as the default, making the rationale (MCP API support) easier to find

Note: OTEL_EXPORTER_OTLP_ENDPOINT and APPLICATIONINSIGHTS_CONNECTION_STRING are intentionally excluded — they appear only in the spec; telemetry is not yet implemented.

Copilot AI linked an issue May 22, 2026 that may be closed by this pull request
Copilot AI changed the title [WIP] Add documentation for supported environment variables Document full CLI environment variable surface (auth, API version, incremental publish, telemetry) May 22, 2026
Copilot finished work on behalf of EMaher May 22, 2026 08:08
Copilot AI requested a review from EMaher May 22, 2026 08:08
Copilot AI changed the title Document full CLI environment variable surface (auth, API version, incremental publish, telemetry) Align API version docs/comments with 2025-09-01-preview and remove premature env-var docs May 22, 2026
Copilot finished work on behalf of EMaher May 22, 2026 18:00
Copilot AI changed the title Align API version docs/comments with 2025-09-01-preview and remove premature env-var docs docs: document supported environment variables and correct default API version May 22, 2026
Copilot finished work on behalf of EMaher May 22, 2026 18:08
@EMaher EMaher changed the title docs: document supported environment variables and correct default API version docs: correct default API version May 22, 2026
@EMaher EMaher marked this pull request as ready for review May 22, 2026 18:13
@EMaher EMaher requested a review from petehauge May 22, 2026 18:13
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.

Document supported environment variables

2 participants