Skip to content

docs: correct default API version #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Copilot wants to merge 4 commits into
base: main
Choose a base branch
from
+9 −9
Open

docs: correct default API version #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
545cec6
Initial plan
Copilot May 22, 2026
6d7d684
Document supported CLI environment variables
Copilot May 22, 2026
f01cdcf
Align docs and comments with preview API version default
Copilot May 22, 2026
a1e7387
Revert docs/commands/publish.md to main state
Copilot May 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/reference/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Available on all commands (`extract`, `publish`, `init`):
| `--cloud <name>` | Azure cloud environment | `public` |
| `--log-level <level>` | Log verbosity: `debug`, `info`, `warn`, `error` | `info` |
| `--format <format>` | Output format | `text` |
| `--api-version <version>` | APIM REST API version | `2024-05-01` |
| `--api-version <version>` | APIM REST API version | `2025-09-01-preview` |

### `apiops extract` Flags

Expand Down Expand Up @@ -86,7 +86,7 @@ Available on all commands (`extract`, `publish`, `init`):
| `AZURE_CLIENT_ID` | all | Service principal client ID for authentication |
| `AZURE_CLIENT_SECRET` | all | Service principal client secret for authentication |
| `AZURE_TENANT_ID` | all | Microsoft Entra ID (Azure AD) tenant ID |
| `AZURE_API_VERSION` | extract, publish | APIM REST API version (default: `2024-05-01`) |
| `AZURE_API_VERSION` | extract, publish | APIM REST API version (default: `2025-09-01-preview`) |
| `COMMIT_ID` | publish | Git commit SHA for incremental publish (alternative to `--commit-id`) |

### Authentication Environment Variables
Expand Down Expand Up @@ -149,7 +149,7 @@ backends:
| Azure cloud | `public` | `--cloud` |
| Log level | `info` | `--log-level` |
| Output format | `text` | `--format` |
| API version | `2024-05-01` | `--api-version` or `AZURE_API_VERSION` |
| API version | `2025-09-01-preview` | `--api-version` or `AZURE_API_VERSION` |
| Transitive deps | enabled | `--no-transitive` |
| Dry run | disabled | `--dry-run` |
| Delete unmatched | disabled | `--delete-unmatched` |
Expand Down
6 changes: 3 additions & 3 deletions src/cli/extract-command.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,9 @@ async function executeExtract(
}

// Build service context
// Default to a recent preview API version so newer resource types (e.g.
// MCP-typed APIs) are returned by ARM list endpoints. Older versions
// (e.g. 2024-05-01) silently omit MCP APIs from /apis.
// Default to 2025-09-01-preview so newer resource types (e.g. MCP-typed
// APIs) are returned by ARM list endpoints. Older versions (e.g. 2024-05-01)
// can silently omit MCP APIs from /apis.
const apiVersion = globalOpts.apiVersion ?? process.env.AZURE_API_VERSION ?? '2025-09-01-preview';
const cloudName = globalOpts.cloud ?? 'public';
const cloudConfig = getCloudConfig(cloudName);
Expand Down
6 changes: 3 additions & 3 deletions src/cli/publish-command.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,9 +89,9 @@ async function executePublish(
}

// Build service context
// Default to a recent preview API version so newer resource types (e.g.
// MCP-typed APIs) are accepted by ARM. Older versions (e.g. 2024-05-01)
// reject MCP API payloads.
// Default to 2025-09-01-preview so newer resource types (e.g. MCP-typed
// APIs) are accepted by ARM. Older versions (e.g. 2024-05-01) can reject
// MCP API payloads.
const apiVersion =
globalOpts.apiVersion ?? process.env.AZURE_API_VERSION ?? '2025-09-01-preview';
const cloudName = globalOpts.cloud ?? 'public';
Expand Down